Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nusomi.com/llms.txt

Use this file to discover all available pages before exploring further.

All Nusomi REST and streaming endpoints accept a workspace API key in the Authorization header. 
Authorization: Bearer nsk_live_...

​
Key formats

PrefixUse
nsk_live_…Production. Real captures and exports.
nsk_test_…Test mode. Sessions auto-deleted after 7 days. No charges.
nsk_local_…Self-hosted control plane. Never reaches Nusomi infrastructure.

​
Workspace + scope

Each key is bound to one workspace. The scope determines what the key can do:
ScopeReadWriteAdmin
Read sessions / events / frames / exports✓✓✓
Create / start / stop / tag sessions✓✓
Create exports✓✓
Trigger replays in dry sandbox✓✓
Trigger replays in live sandboxwith replay:live✓
Manage webhooks✓
Manage workspace members + billing✓

​
Errors

CodeMeaning
401 missing_authorizationNo Authorization header.
401 invalid_api_keyKey doesn’t match any active workspace key.
403 insufficient_scopeKey is valid but doesn’t carry the required scope.
403 workspace_disabledWorkspace is in a non-billing state (suspended, expired).
Every error response includes a request_id — quote it when emailing support.

​
Programmatic key issuance

Admin-scope keys can mint other keys via REST: 
curl https://api.nusomi.com/v1/keys \
  -X POST \
  -H "Authorization: Bearer nsk_live_<admin-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "ci-ingest",
    "scope": "write",
    "expires_at": "2027-01-01T00:00:00Z"
  }'
Response: 
{
  "id": "key_01HZ...",
  "label": "ci-ingest",
  "scope": "write",
  "key": "nsk_live_..."
}
The full key value is returned only once — store it immediately.