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

Update a geospatial anchor

Secret key only.

Moves an anchor, renames it, or changes or unlinks its content. Send null to unlink scene_id, scene_asset_id or user_asset_id. Linked content 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.

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

Anchor id.

Body Params

Send only the fields to change. null unlinks scene_id, scene_asset_id and user_asset_id, and clears mesh_url and name. The project cannot change.

number
-90 to 90

-90 to 90.

number
-180 to 180

-180 to 180.

number
-500 to 10000

-500 to 10000.

string
enum

Stored only.

Allowed:
string | null

Up to 150 characters.

string | null

Up to 2000 characters.

uuid | null

Must belong to the anchor's project.

uuid | null

Must belong to the anchor's project.

uuid | null

Must belong to the anchor's project.

string | null

Must be the url that POST /assets/upload returned for this project's file.

Responses

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

INVALID_MESH_URL: mesh_url is not a mesh file of the anchor's project.

INVALID_LATITUDE: lat is outside -90 to 90.

INVALID_LONGITUDE: long is outside -180 to 180.

INVALID_ALTITUDE_MODE: altitude_mode is not street_level or rooftop_level.

INVALID_ALTITUDE: alt is not a number from -500 to 10000.

NO_UPDATES: no field this operation can change was sent.

MISSING_API_KEY: no x-api-key header.

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.

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

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

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

USER_ASSET_NOT_FOUND: no such file, or one the key cannot reach.

SCENE_NOT_FOUND: no such scene in the anchor's project.

SCENE_ASSET_NOT_FOUND: no such scene asset in the anchor's project.

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.

UPDATE_FAILED: the change could not be stored, for example a name over 150 or a description over 2000 characters, or a file of another project.

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.

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