Developer Docs

Quickstart

Generate a demo key, list datasets, inspect response shapes, and understand the evaluation boundary quickly.

Working examples

Each guide gets a technical evaluator from zero to a successful call quickly.

Clear boundaries

Docs distinguish public demo routes from customer-specific production commitments.

Copy-paste examples

Examples, schemas, errors, and caveats are meant to be usable as written.

Docs index

Developer Docs 1

Generate a demo key

Request a short-lived demo key from the sandbox or directly from the HTTP endpoint. The key is for evaluation only and works with sample-data and readiness workflows.

The demo key is short-lived by design.
Use a work email when possible so follow-up routing is meaningful.

curl

bash

curl -X POST https://roamlabs.ai/api/v1/demo-key \
  -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","useCase":"pipeline-evaluation"}'

TypeScript

const res = await fetch('https://roamlabs.ai/api/v1/demo-key', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ email: '[email protected]', useCase: 'pipeline-evaluation' }),
});
const { apiKey, expiresAt } = await res.json();

Developer Docs 2

List sample datasets

Use the demo key as a bearer token and inspect the dataset catalog before requesting gated downloads or a live program.

Successful response shape: `{ datasets: DatasetSummary[] }`.
Each dataset includes metadata, formats, and artifact descriptors rather than full production payloads.

curl

bash

curl https://roamlabs.ai/api/v1/sample-datasets \
  -H 'Authorization: Bearer $ROAM_DEMO_KEY'

TypeScript

const datasets = await fetch('https://roamlabs.ai/api/v1/sample-datasets', {
  headers: { Authorization: `Bearer ${apiKey}` },
}).then((res) => res.json());

Developer Docs 3

Assess program readiness

Post your intended environment, outputs, and timeline to receive a structured readiness summary and recommended next steps.

curl

bash

curl -X POST https://roamlabs.ai/api/v1/program-readiness \
  -H 'Authorization: Bearer $ROAM_DEMO_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"programType":"production","environments":["Indoor","Drone/UAS"],"deliverables":["Gaussian Splats","OpenUSD/Simulation Assets"],"timeline":"near-term"}'

Response schema

json

{
  "readinessScore": 84,
  "recommendedNextStep": "Open a live scoping thread.",
  "recommendedDataset": {
    "id": "warehouse-interior",
    "name": "Warehouse Interior Capture"
  },
  "notes": ["Output family aligns with current demo surface."]
}

Developer Docs 4

Errors and limits

The sandbox proves evaluation paths, not a production API commitment. Expect short-lived keys, authorization failures for expired tokens, and narrow sample-only functionality.

401 responses usually mean the demo key is missing or expired.
Sample endpoints are intentionally narrow and evaluation-focused.
Production programs still move through a human review path and scoped delivery contract.

From evaluation to scoping

Need a live test surface?

The docs map the contract. The sandbox proves it with a real demo key, sample-data listing, and readiness response.

Raise NDA, security, privacy, and delivery constraints in the first conversation instead of after procurement restarts the process.

Open sandbox Open developer hub

Need immediate scheduling? Use the programs inbox.