Attach content to a cloud anchor

post

https://platform.reactvision.xyz/functions/v1/cloud-anchors/{anchor_id}/assets

Secret key only.

Attaches content to an anchor at a position relative to it: a team asset from the library, a file uploaded with POST /assets/upload, or a stored file named by its URL, which becomes a new file record. A file must belong to the anchor'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.

Not counted against the monthly API request quota.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

anchor_id

uuid

required

Anchor id.

Body Params

Name exactly one source: team_asset_id, user_asset_id, or file_url for a file to turn into a new file record. With an id, file_url is ignored.

team_asset_id

uuid

A team asset of your team.

user_asset_id

uuid

A file of the anchor's project.

file_url

string

The file_url of a file this project uploaded. Creates a file record, whose size is read from storage and counted against the storage quota.

name

string

With file_url: the new file's name. Default: the file name from the URL. Cut to 250 characters.

description

string

length ≤ 2000

With file_url: up to 2000 characters.

asset_type

string

enum

With file_url. Default OTHER.

Allowed:

external_user_id

string

length ≤ 255

With file_url: your app's id for the user. Up to 255 characters.

external_user_metadata

object

With file_url: your data about the user, up to 4096 bytes as JSON.

position

object

rotation

object

Quaternion.

scale

number

Default 1.

is_visible

boolean

Default true.

metadata

object

Up to 4096 bytes as JSON. Default {}.

Responses

`INVALID_BODY`: the body is not valid JSON, or not a JSON object.

`INVALID_FIELD_VALUE`: a field has the wrong type, such as `metadata` that is not an object.

`FIELD_TOO_LONG`: a text field is over its limit, or a JSON object is over 4096 bytes.

`USER_ASSET_PROJECT_MISMATCH`: `user_asset_id` belongs to another project of the team.

`INVALID_FILE_URL`: `file_url` is not a storage URL of this platform.

`INVALID_ASSET_TYPE`: `asset_type` is not `IMAGE`, `VIDEO`, `3D-MODEL` or `OTHER`.

`FILE_NOT_FOUND`: no stored file at `file_url`.

`INVALID_ASSET_REFERENCE`: none of `team_asset_id`, `user_asset_id` and `file_url` was sent.

Attach content to a cloud anchor

`API_KEY_TYPE_NOT_ALLOWED`: a client key. This operation needs a secret key.

`STORAGE_LIMIT_REACHED`: a new file record would exceed the team's storage quota.

`ANCHOR_NOT_FOUND`: no such anchor, or one the key cannot reach.

`TEAM_ASSET_NOT_FOUND`: no such team asset in your team.

`USER_ASSET_NOT_FOUND`: no such file in your team.

`RATE_LIMITED`: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`ASSET_CREATE_FAILED`: the new file record could not be created.

`ATTACH_ASSET_FAILED`: the attachment could not be stored.

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

`PROJECT_LOOKUP_FAILED`: the project could not be checked. Retry.

201The attachment.

403API_KEY_TYPE_NOT_ALLOWED: a client key. This operation needs a secret key. STORAGE_LIMIT_REACHED: a new file record would exceed the team's storage quota.

404ANCHOR_NOT_FOUND: no such anchor, or one the key cannot reach. TEAM_ASSET_NOT_FOUND: no such team asset in your team. USER_ASSET_NOT_FOUND: no such file in your team.

429RATE_LIMITED: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

500ASSET_CREATE_FAILED: the new file record could not be created. ATTACH_ASSET_FAILED: the attachment could not be stored. INTERNAL_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. PROJECT_LOOKUP_FAILED: the project could not be checked. Retry.

`API_KEY_TYPE_NOT_ALLOWED`: a client key. This operation needs a secret key.

`STORAGE_LIMIT_REACHED`: a new file record would exceed the team's storage quota.

`ANCHOR_NOT_FOUND`: no such anchor, or one the key cannot reach.

`TEAM_ASSET_NOT_FOUND`: no such team asset in your team.

`USER_ASSET_NOT_FOUND`: no such file in your team.

`RATE_LIMITED`: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`ASSET_CREATE_FAILED`: the new file record could not be created.

`ATTACH_ASSET_FAILED`: the attachment could not be stored.

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

`PROJECT_LOOKUP_FAILED`: the project could not be checked. Retry.