HomeGuidesAPI ReferenceChangelogDiscussions
Hire a ReactVision Expert 🛠️Launch Studio 🖥️Sponsor on GitHub ❤️Log In
API Reference

Get a project

Client or secret key.

Returns a project with its opening scene and every scene's placed assets, in one call.

With a client key the project must be the key's project. An id your key cannot reach (another team's, or another project's for a bound key) gets the same answer as an id that does not exist.

Counts as one request against the team's monthly API request quota, including a request that then fails a check.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Project id.

Responses

MISSING_AUTH: no x-api-key header, and no other credential.

INVALID_API_KEY_FORMAT: the key is not rv_live_, rv_client_ or rv_secret_ followed by 64 lowercase hexadecimal characters.

INVALID_API_KEY: no such key, or a key sent with the wrong prefix for its type.

API_KEY_EXPIRED: the key is past its expiry date.

AUTH_ERROR: a user token (rv_ut_) was sent as a Bearer token. This operation does not accept user tokens.

API_REQUEST_LIMIT_REACHED: the team's monthly API request quota is used up.

PROJECT_NOT_FOUND: no such project, or one the key cannot reach.

RATE_LIMITED: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.

API_KEY_LOOKUP_FAILED: the key could not be checked. Retry; this does not mean the key is invalid.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json