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

Report a cloud anchor resolve

Client or secret key.

Records an attempt to resolve an anchor, and updates the anchor's resolve_count, successful_resolve_count, average_confidence and last_resolved_at. Viro sends it after every resolve.

With a client key the anchor must be public and in 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

Anchor id.

Body Params

Every field is optional; send {} for a bare report.

boolean

Whether the resolve succeeded. Default true.

number

Match confidence, 0 to 1.

integer

Feature matches.

integer

Inliers after RANSAC.

integer

Processing time, in milliseconds.

string
length ≤ 255

Your app's id for the user who resolved. Up to 255 characters.

string
enum

Platform that resolved.

Allowed:
string
length ≤ 120

Up to 120 characters.

string
length ≤ 2000

Why the resolve failed. Up to 2000 characters.

Responses

INVALID_BODY: the body is not a JSON object (send {} for a bare report).

INVALID_FIELD_VALUE: a text field is not a string.

FIELD_TOO_LONG: a text field is over its limit.

INVALID_PLATFORM: platform is not ios, android or web.

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.

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.

ANCHOR_NOT_FOUND: no such anchor, or one the key cannot reach. For a client key, a private anchor too.

RATE_LIMITED: more than 300 a minute from one IP address for your team; 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.

RESOLVE_TRACKING_FAILED: the report 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.

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