Skip to main content
Realsee
Dashboard
Sign out
Documentation
Docs
/
Get Started

Get Started

Submit an App request, wait for review, receive credentials, and render a Five SDK tour.

This guide takes a new developer from account setup to a working Realsee integration. The current portal does not create Developer apps directly. You submit an App request, Realsee reviews the Team and use case, and credentials appear in the dashboard after provisioning.

Register and choose a Team

Sign in with Realsee Passport from the dashboard. Passport gives the portal your user identity and the Teams you can access. Choose the Team that will own the integration before submitting the request.

Teams can represent a person, a company, or another organization. App requests and provisioned Developer apps are always scoped to the active Team.

Submit App request

Open the App request form from the dashboard and provide:

  • App name.
  • Contact name and email.
  • Production use case.

The active Team shown in the dashboard is the owner. The form does not collect a second editable Team name; switch the active Team before opening the form if another Team should own the Developer app.

Use a stable app name that your Team will recognize later. If the same Team submits the same normalized app name within the review window, the dashboard shows the existing request instead of creating another one.

Review

After submission, the request is recorded in App request history. Realsee reviews the Team, intended use case, and required capabilities. A member of the Realsee team may contact the submitted email if more context is needed.

Review happens outside the portal. The dashboard keeps the request visible so the Team can see that the request has been submitted.

Get credentials

When the request is approved and provisioned, the Developer app appears in the dashboard for the same Team. The app entry shows the app key (AK), XID, and the credential actions available to that Team.

Secrets are handled inside the dashboard flow and should stay server-side. Browser integrations should only use browser-safe keys and public scene data.

Integrate

Install the Five SDK packages:

npm install @realsee/five @realsee/open-works three@0.117.1

Render a public work while your production credentials are being reviewed:

import { Five, parseWork } from '@realsee/five'
import workJSON from '@realsee/open-works/virtual/816lPVZQkQDF5XOpPo/work.json'

const container = document.querySelector<HTMLElement>('#app')
const five = new Five({ imageOptions: { size: 1024 } })

if (container) {
  five.appendTo(container)
  await five.load(parseWork(workJSON))
  five.refresh()
}

This first SDK render does not require an OpenAPI token. Production workflows that call OpenAPI or Argus endpoints should use the provisioned Developer app credentials and the capability guidance from the Realsee team.

Next steps

  • Five SDK — render and control spatial scenes.
  • OpenAPI — use provisioned credentials for server-side calls.
  • Argus — evaluate AI reconstruction workflows.
  • Team and App Management — understand request history, Team scope, and credentials.