[ Documentation ]
REST API

REST API

The rnx REST API exposes previews, builds, test runs, and cloud session metering at https://contrast.dev/api/v1. Every request uses an account-scoped rnx API key or a session Bearer token from rnx login. Every created result links to a hosted page on https://rnxsim.com.

terminal
curl "https://contrast.dev/api/v1/builds?owner=acme&repo=mobile&branch=main&platform=ios" \
-H "Authorization: Bearer $RNX_API_KEY"

API keys are available in Billing → API Keys on both Contrast and rnx. Choose only the scopes an integration needs and set an expiration for production automation. The rnx CLI can use its existing login session.

Resources

All request and response bodies are JSON unless an upload URL explicitly asks for artifact bytes. Dates are ISO 8601 strings. Stored timestamps in resource responses are Unix milliseconds.