Skip to main content
Realsee
Documentation
  1. Docs
  2. OpenAPI

OpenAPI

Use Team-owned Developer app credentials for the shared /open interfaces from your server.

Realsee OpenAPI connects your server to spatial data and workflows, including VR data, interactions, Live, and Argus. Create or select a Developer app owned by your Team, then use its AK and SK to obtain a gateway access token.

Developer apps use the shared /open interface scope. You do not select product capabilities, submit endpoint applications, or wait for separate capability approval. App availability, authenticated resource access, required inputs, and rate limits still apply to every actual request.

Start with an app

Open Apps and select the owning Team. An owner can create a trial app when the Team has capacity; each Team may have up to three Developer apps, including expired or disabled apps. As soon as creation succeeds, the App request is Completed and bound to the AK.

New apps receive the default 14-day trial through the existing business process. Trial configuration may initially be pending; it does not postpone request completion. Use Team and App Management for creation and recovery, and the Realsee Discord community to discuss production or continued-access needs. Trial extensions require confirmation from the team.

Base URL and authentication

The overseas gateway is:

https://app-gateway.realsee.ai

Exchange AK and SK server-side using POST /auth/access_token with form fields app_key and app_secret. The token response includes data.access_token and data.expire_at, a Unix timestamp in seconds. Keep the token on your server and obtain another when needed according to its returned expiry.

Authenticated /open requests send the raw token value in the Authorization header, without a Bearer prefix. The endpoint guide shows the verified exchange and request prerequisites. Authentication explains how these credentials differ from the Passport session used to sign into the portal.

Never place SK or access tokens in browser bundles, URLs, logs, analytics, or support messages. Your backend must authorize its own users and return only the data those users may see.

Choose the operation

Use the published API Reference for endpoint methods, parameters, and response schemas. API group names describe the operation; they are not separate portal approval stages.

  • VR and scene data: discover resources available to the Team and fetch the selected resource using its documented identifier.
  • Interactions and presentation: use the documented hotspot, ruler, floorplan, and related data APIs needed by your SDK experience.
  • Live: follow the Live guide for room, ticket, connection, and optional voice requirements.
  • Argus: follow the Argus guide for upload, task creation, polling, and output contracts.

Some operations change data or create tasks. Check the endpoint's documented behavior before executing it; shared interface scope does not make every operation read-only. An arbitrary metadata response is not automatically Five SDK Work data. Use a documented Work payload and parseWork for the Five SDK integration.

Interpret the actual result

Inspect both the HTTP result and the endpoint's business response fields. The gateway contracts use fields such as code, status, and business_code; their meaning and response data are defined per endpoint. Do not assume every business error uses the same numeric value as an HTTP status.

Distinguish invalid or expired credentials, a disabled app, inaccessible or missing resources, invalid input, and rate limiting. A denied resource does not mean you need to apply for a named capability. An empty resource list can be a valid result for a Team with no suitable VRs. Follow the documented error and rate-limit behavior; use your existing app and ask in the Realsee Discord community when you need help investigating a problem.

Next steps