Get a 3D model task

get

https://platform.reactvision.xyz/functions/v1/ai-models/{task_id}

Secret key only.

A few legacy keys that ReactVision has listed keep access for a transitional period. Every other legacy key, and every client key, is refused with 403 API_KEY_TYPE_NOT_ALLOWED.

Returns a model task and moves it on: a poll checks the provider and, when the model is ready, stores it and completes the task. Poll every few seconds. A task still unfinished after 60 minutes fails with error Model generation timed out.

type is read back from the stored prompt, so a model made from an uploaded image without a prompt reports text. result.file_url is absent once the model has been deleted.

Not counted against the monthly API request quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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_KEY_TYPE_NOT_ALLOWED`: a client key, or a legacy key that is not on ReactVision's transitional list.

`ACCESS_DENIED`: a task of another team, or, for a bound key, of another project or of the team library.

`TASK_NOT_FOUND`: no such task.

`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

Loading…

Response

Choose an example:

application/json

200The task.

403API_KEY_TYPE_NOT_ALLOWED: a client key, or a legacy key that is not on ReactVision's transitional list. ACCESS_DENIED: a task of another team, or, for a bound key, of another project or of the team library.

404TASK_NOT_FOUND: no such task.

429RATE_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.

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

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

`API_KEY_TYPE_NOT_ALLOWED`: a client key, or a legacy key that is not on ReactVision's transitional list.

`ACCESS_DENIED`: a task of another team, or, for a bound key, of another project or of the team library.

`TASK_NOT_FOUND`: no such task.

`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.