Skip to main content
Realsee
Documentation
  1. Docs
  2. OpenAPI
  3. Team API Quickstart

Team API Quickstart

Connect the official local starter to a Team-owned Developer app, read its VR list, and render an authorized scene.

On this page
OFFICIAL STARTERv1.2.3

Build this locally

A complete React + TypeScript project. Node 24 required.

Run the Demo first, then connect your Team. Keys stay in your local server .env, never in chat.

Paste into an AI coding tool with terminal access. The prompt asks it to run and verify the app.

Download ZIPQuickstart
View Markdown

Use the same React + TypeScript project as the public Five SDK Quickstart. First get the public scene running, then connect the local Node backend to your Team's real data. You do not need another app for each product capability.

Prepare your Developer app

Open Apps, select the owning Team, and use an existing enabled Developer app. A Team owner can create one when the Team has capacity. An expired or disabled app still counts toward the 10-app limit.

Open the app's details and copy its AK. A Team owner can use Reveal SK to obtain its secret. If you are a Team member, ask the owner to configure the local server securely; do not request the SK in an AI chat or a community message.

Expand Integration guide in the app's details. Under Read your Team's VR list, copy the value shown for REALSEE_TEAM_SOURCE. A Team source is not an AK or UserCode. App request completion and successful API integration are separate results.

Start the project

Use Copy starter prompt above, or download the project and follow its release manifest. In the extracted project run:

npm ci
npm run check
npm run build
npm run dev

Verify the Public Demo first. It must not be presented as proof that your Team credentials work.

Configure the local backend

If .env does not already exist, copy .env.example to .env next to the starter's package.json. Keep an existing .env and update only the values needed for this integration. Fill these values yourself on your computer. Do not paste SK or tokens into an AI chat, browser code, URLs, screenshots, or logs.

REALSEE_APP_KEY=YOUR_APP_AK
REALSEE_APP_SECRET=YOUR_APP_SK
REALSEE_TEAM_SOURCE=YOUR_OWNING_TEAM_SOURCE
REALSEE_GATEWAY_BASE_URL=https://app-gateway.realsee.ai

After changing the environment file, stop the running development process with Ctrl+C and run npm run dev again. Open the local URL it prints, select Your Team, then click Check API & list VRs. Switching to the Team tab does not start the API check automatically. The backend reads the environment; the browser never receives SK or access tokens.

Check the token and VR list

The starter uses the pinned @realsee/api client from its server and implements this read-only sequence:

  1. Exchange AK/SK using POST /auth/access_token, with form fields app_key and app_secret.
  2. Check the HTTP response and business code; use data.access_token and its returned data.expire_at.
  3. Call POST /open/v3/custom/search with JSON source, page, and page_size. The Authorization header contains the raw token, without a Bearer prefix.
  4. Display the returned VR list and its pagination.

An authorized empty list means no visible VR was returned. Report API connected, no VRs available. It does not require creating another app, and it does not prove a real Team scene rendered.

When VRs are available, the local app shows Team VRs and the current page. Use Next and Previous to browse the directory.

Select and render your VR

Click a VR in the returned Team VRs directory and wait for Ready in the viewer. The local backend binds that choice to the configured Team and obtains Work through GET /open/v3/vr/info?resource_code=... before returning the renderable payload to Five SDK.

The published Work endpoint returns the renderable payload in data. The starter parses it with @realsee/five@6.9.2. Resource availability and asset access still depend on your app, Team, and returned Work. A generic metadata object must not be treated as a rendered scene.

The starter loads this payload using its shared viewer. Only report Team scene ready after the selected scene has loaded. If Work or its assets fail, keep the failure visible; do not silently replace the result with Public Demo data.

Directory selections expire after five minutes and after a server restart. If a selection expires, click Refresh Team directory, then select the VR again.

Understand a failure

ResultMeaning and action
Configuration missingFill the named variables locally and restart the server. Public Demo remains available.
Token failedCheck the app, credentials, and selected gateway. HTTP 200 alone is not success.
Resource request failedCheck Team source, app availability, and the API business result.
No VRsThe read succeeded but returned no visible resources. Use Public Demo or prepare an accessible VR.
Selection expiredReload the list and select the VR again.
Work or assets failedCheck the selected VR and network. API success and scene success remain separate.

Continue building

Playground is a separate portal experience with a page-local Viewing Team. Running this local starter does not switch the Team that owns your Dashboard data or modify an App request.