VOD API reference

VOD API.

17 endpoints, 5 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

assets

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /vod/assets` List videos	read	`?limit` integer `?offset` integer `?state` uploading \| processing \| ready \| failed	`orbit vod assets list` `vod_assets_list`
`POST /vod/assets` Create a video, then upload the original into it	write	body: `title` string, `description` string, `tags` object, `visibility` public \| unlisted \| private	`orbit vod assets create` `vod_assets_create`
`GET /vod/assets/{id}` One video, with transcode progress while it is processing	read	`id` string	`orbit vod assets get <id>` `vod_assets_get`
`PATCH /vod/assets/{id}` Change a video's title, description, tags or visibility	write	`id` string body: `title` string, `description` string, `tags` object, `visibility` public \| unlisted \| private	`orbit vod assets update <id>` `vod_assets_update`
`DELETE /vod/assets/{id}` Delete a video and everything stored for it	write	`id` string	`orbit vod assets delete <id>` `vod_assets_delete`
`POST /vod/assets/{id}/reprocess` Encode the original again with the ladder your packs allow today	write	`id` string	`orbit vod assets reprocess <id>` `vod_assets_reprocess`
`GET /vod/assets/{id}/renditions` The qualities this video was encoded into	read	`id` string	`orbit vod assets renditions <id>` `vod_assets_renditions`
`POST /vod/assets/{id}/playback` A playback address — signed and expiring for a private video	write	`id` string body: `expires_in` integer	`orbit vod assets playback <id>` `vod_assets_playback`

upload

Endpoint	Scope	Parameters	CLI · MCP tool
`POST /vod/assets/{id}/upload` Start a resumable upload of the original	write	`id` string body: `size`* integer, `content_type` string, `filename` string	`orbit vod upload begin <id>` `vod_upload_begin`
`PUT /vod/assets/{id}/upload/{upload_id}/parts/{n}` Send one part. The body is the bytes, not JSON.	write	`id` string `upload_id` string `n` integer body: raw bytes	`orbit vod upload part <id> <upload_id> <n>` `vod_upload_part`
`POST /vod/assets/{id}/upload/{upload_id}/complete` Seal the upload and queue the transcode	write	`id` string `upload_id` string	`orbit vod upload complete <id> <upload_id>` `vod_upload_complete`

keys

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /vod/keys` Playback signing keys	read	—	`orbit vod keys list` `vod_keys_list`
`POST /vod/keys` Mint a playback signing key (the secret is shown once)	write	body: `note` string	`orbit vod keys create` `vod_keys_create`
`DELETE /vod/keys/{key_id}` Revoke a playback key	write	`key_id` string	`orbit vod keys delete <key_id>` `vod_keys_delete`

webhooks

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /vod/webhooks` VOD event endpoints	read	—	`orbit vod webhooks list` `vod_webhooks_list`
`POST /vod/webhooks` Register a VOD event endpoint (stored now; delivery is not switched on yet)	write	body: `url`* string, `events` string[], `note` string	`orbit vod webhooks create` `vod_webhooks_create`
`DELETE /vod/webhooks/{hook_id}` Remove a VOD event endpoint	write	`hook_id` integer	`orbit vod webhooks delete <hook_id>` `vod_webhooks_delete`

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Organization API reference

Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation