Orbit Frame REST API & Camera-to-Cloud

Automate media ingestion from field devices, sync review comments with external NLEs, and receive real-time webhook notifications when cuts are approved.

Authentication

All API calls must include your workspace API token in the HTTP Authorization header:

Authorization: Bearer orb_live_xxxxxxxxxxxxxxxxxxxxxxxx

API keys can be generated by workspace owners under Workspace Settings → API Keys.

Core REST Endpoints

POST/api/v1/c2c/{token}/upload

Camera-to-Cloud

Direct ingest endpoint for on-camera transmitters, hardware encoders, and field switchers.

Payload (multipart/form-data):

file: [binary payload]
name: "A001_C004_0710_PR.mov"
metadata: { "camera": "FX6", "scene": "14B", "take": 2, "fps": 23.976 }

POST/api/v1/comments

Review API

Create a timestamped comment with optional vector drawing annotations.

Request Body (JSON):

{
  "assetId": "clh2819...",
  "timecode": 14.583,
  "frameNumber": 350,
  "content": "Deepen contrast on the rim light.",
  "annotation": {
    "shapes": [
      { "type": "arrow", "points": [100, 150, 200, 250], "stroke": "#22D3EE" }
    ]
  }
}

Outgoing Webhook Events

Configure webhooks in Workspace Settings to receive HMAC-signed real-time events:

asset.uploaded

Dispatched when upload completes

asset.ready

Dispatched when HLS transcode completes

comment.created

Dispatched on new review note

approval.status_changed

Dispatched on client sign-off