{ "openapi": "3.1.0", "info": { "title": "Strum VOD Customer API", "version": "1.0.0", "description": "Video-resource API for integrating with Strum VOD: assets, collections, playback, comments, webhooks, AI. Auto-generated from @strum-vod/api-contracts — the single source of truth for all request/response schemas." }, "servers": [ { "url": "https://vapi.usestrum.app", "description": "Production" } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "Organization API key (mk_...), minted from the dashboard under Settings > API Keys." } }, "schemas": { "ResponseZodObject": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "playbackId": { "type": "string" }, "sourceType": { "type": "string" }, "sourceUrl": { "type": [ "string", "null" ] }, "durationSec": { "type": [ "number", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] }, "hasCustomThumbnail": { "type": "boolean" }, "customMetadata": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "metadata": { "type": [ "object", "null" ], "additionalProperties": {} }, "collectionId": { "type": [ "string", "null" ] }, "currentStep": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "renditions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "quality": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "bitrateKbps": { "type": "number" }, "fileSizeBytes": { "type": [ "number", "null" ] }, "codec": { "type": "string" }, "hwAccel": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] } }, "required": [ "id", "quality", "width", "height", "bitrateKbps", "fileSizeBytes", "codec", "hwAccel" ] } }, "sourceKey": { "type": [ "string", "null" ] }, "job": { "type": [ "object", "null" ], "properties": { "status": { "type": "string" }, "workerId": { "type": [ "string", "null" ] }, "workerKind": { "type": [ "string", "null" ] }, "hostname": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "cpuCores": { "type": [ "number", "null" ] }, "totalMemGb": { "type": [ "number", "null" ] }, "hwAccelUsed": { "type": "boolean" }, "startedAt": { "type": [ "string", "null" ] }, "durationMs": { "type": [ "number", "null" ] }, "triggerRunId": { "type": [ "string", "null" ] }, "attempts": { "type": "number" }, "maxAttempts": { "type": "number" }, "errorMessage": { "type": [ "string", "null" ] } }, "required": [ "status", "workerId", "workerKind", "hostname", "region", "cpuCores", "totalMemGb", "hwAccelUsed", "startedAt", "durationMs", "triggerRunId", "attempts", "maxAttempts", "errorMessage" ] }, "aiJob": { "type": [ "object", "null" ], "properties": { "status": { "type": "string" }, "skipReason": { "type": [ "string", "null" ] }, "transcriptionStatus": { "type": "string" }, "subtitlesStatus": { "type": "string" }, "chaptersStatus": { "type": "string" }, "highlightsStatus": { "type": "string" }, "smartMetadataStatus": { "type": "string" }, "separationStatus": { "type": [ "string", "null" ] }, "subtitleTranslationStatus": { "type": "string" }, "translationTargetLangs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "stepErrors": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "llmConfigured": { "type": "boolean" }, "language": { "type": [ "string", "null" ] }, "transcriptionProvider": { "type": [ "string", "null" ] }, "transcriptionModel": { "type": [ "string", "null" ] }, "transcriptText": { "type": [ "string", "null" ] }, "transcriptUrl": { "type": [ "string", "null" ] }, "stemsUrl": { "type": [ "string", "null" ] }, "triggerRunId": { "type": [ "string", "null" ] } }, "required": [ "status", "skipReason", "transcriptionStatus", "subtitlesStatus", "chaptersStatus", "highlightsStatus", "language" ] }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "startTimeSec": { "type": "number" }, "endTimeSec": { "type": "number" }, "status": { "type": "string" }, "durationSec": { "type": [ "number", "null" ] }, "fileSizeBytes": { "type": [ "number", "null" ] }, "clipUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "description", "startTimeSec", "endTimeSec", "status", "durationSec", "fileSizeBytes", "clipUrl", "thumbnailUrl", "errorMessage" ] } }, "publicSettings": { "type": [ "object", "null" ], "properties": { "allowDownload": { "type": "boolean" }, "showTranscript": { "type": "boolean" }, "showChapters": { "type": "boolean" }, "showHighlights": { "type": "boolean" }, "showComments": { "type": "boolean" } }, "required": [ "allowDownload", "showTranscript", "showChapters", "showHighlights", "showComments" ] }, "audioUrl": { "type": [ "string", "null" ] }, "audioCodec": { "type": [ "string", "null" ] }, "audioBitrateKbps": { "type": [ "number", "null" ] }, "audioSampleRate": { "type": [ "number", "null" ] }, "audioChannels": { "type": [ "number", "null" ] }, "audioFileSizeBytes": { "type": [ "number", "null" ] }, "aiAudioPath": { "type": [ "string", "null" ] }, "aiTitle": { "type": [ "string", "null" ] }, "aiSummary": { "type": [ "string", "null" ] }, "aiShortDescription": { "type": [ "string", "null" ] }, "aiDescription": { "type": [ "string", "null" ] }, "aiTags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "aiCategory": { "type": [ "string", "null" ] }, "toolAudioResult": { "type": [ "object", "null" ], "properties": { "format": { "type": "string" }, "codec": { "type": "string" }, "bitrateKbps": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "path": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "format", "codec", "bitrateKbps", "sampleRate", "channels", "path", "fileSize" ] }, "audioExtractionJob": { "type": [ "object", "null" ], "properties": { "status": { "type": "string", "enum": [ "idle", "queued", "processing", "completed", "error" ] }, "currentStep": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "jobId": { "type": [ "string", "null" ] }, "lastResult": { "type": [ "object", "null" ], "properties": { "format": { "type": "string" }, "path": { "type": "string" }, "fileSizeBytes": { "type": "number" } }, "required": [ "format", "path", "fileSizeBytes" ] } }, "required": [ "status" ] }, "stems": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "sizeBytes": { "type": [ "number", "null" ] }, "contentType": { "type": "string" } }, "required": [ "name", "url", "sizeBytes" ] } } }, "required": [ "id", "orgId", "title", "description", "status", "playbackId", "sourceType", "sourceUrl", "durationSec", "errorMessage", "thumbnailUrl", "createdAt", "updatedAt", "renditions" ] } }, "required": [ "data" ] }, "ResponseZodArray": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "playbackId": { "type": "string" }, "sourceType": { "type": "string" }, "sourceUrl": { "type": [ "string", "null" ] }, "durationSec": { "type": [ "number", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] }, "hasCustomThumbnail": { "type": "boolean" }, "customMetadata": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "metadata": { "type": [ "object", "null" ], "additionalProperties": {} }, "collectionId": { "type": [ "string", "null" ] }, "currentStep": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "title", "description", "status", "playbackId", "sourceType", "sourceUrl", "durationSec", "errorMessage", "thumbnailUrl", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } }, "parameters": {} }, "paths": { "/v1/assets": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 10000 } } }, "required": [ "title" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodObject" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": false, "name": "collectionId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": [ "number", "null" ] }, "required": false, "name": "minDuration", "in": "query" }, { "schema": { "type": [ "number", "null" ] }, "required": false, "name": "maxDuration", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "createdAfter", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "createdBefore", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodArray" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/search": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "required": true, "name": "q", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": [ "integer", "null" ], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/samples": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodArray" }, { "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "id", "title", "description", "fileSizeBytes" ] } } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/demo-seed": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodObject" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/import-sample": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sampleId": { "type": "string", "minLength": 1 }, "seedFakeAi": { "type": "boolean", "default": false } }, "required": [ "sampleId" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodObject" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodObject" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "maxLength": 10000 }, "publicSettings": { "type": "object", "properties": { "allowDownload": { "type": "boolean" }, "showTranscript": { "type": "boolean" }, "showChapters": { "type": "boolean" }, "showHighlights": { "type": "boolean" }, "showComments": { "type": "boolean" } }, "required": [ "allowDownload", "showTranscript", "showChapters", "showHighlights", "showComments" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 10000 } }, "collectionId": { "type": [ "string", "null" ], "minLength": 1 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseZodObject" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "delete": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/realtime-token": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "token": { "type": [ "string", "null" ] }, "jobRunId": { "type": [ "string", "null" ] }, "aiJobRunId": { "type": [ "string", "null" ] } }, "required": [ "token", "jobRunId", "aiJobRunId" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/upload-url": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileSize": { "type": "integer", "exclusiveMinimum": 0 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/upload-token": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileSize": { "type": "integer", "minimum": 1, "maximum": 10737418240 } }, "required": [ "fileSize" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/upload-complete": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uploadId": { "type": "string", "minLength": 1 }, "eTags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } }, "required": [ "uploadId", "eTags" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/import": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceUrl": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "sourceUrl" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/process": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "language": { "type": "string", "minLength": 1, "maxLength": 16 }, "aiOptions": { "type": "object", "properties": { "transcription": { "type": "boolean", "default": true }, "subtitles": { "type": "boolean", "default": true }, "chapters": { "type": "boolean", "default": true }, "highlights": { "type": "boolean", "default": true }, "separation": { "type": "boolean", "default": true } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/cancel-job": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "cancelled": { "type": "string", "enum": [ "transcode", "ai" ] } }, "required": [ "cancelled" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/ai/retry-step": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "step": { "type": "string", "enum": [ "transcriptionStatus", "subtitlesStatus", "chaptersStatus", "highlightsStatus", "smartMetadataStatus", "subtitleTranslationStatus" ] } }, "required": [ "step" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "retried": { "type": "string" } }, "required": [ "retried" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/smart-metadata": { "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "tags", "category" ] } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/thumbnail": { "put": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "delete": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/download": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "downloadUrl", "fileSizeBytes" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/audio-config": { "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "playback": { "type": "object", "properties": { "bitrateKbps": { "type": "integer", "minimum": 32, "maximum": 320 }, "sampleRate": { "type": "integer", "minimum": 8000, "maximum": 96000 }, "channels": { "type": "integer", "minimum": 1, "maximum": 2 } } }, "ai": { "type": "object", "properties": { "bitrateKbps": { "type": "integer", "minimum": 32, "maximum": 128 }, "sampleRate": { "type": "integer", "minimum": 8000, "maximum": 48000 } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/audio": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "downloadUrl", "fileSizeBytes" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/ai-audio": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "downloadUrl", "fileSizeBytes" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/extract-audio": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "m4a", "mp3", "wav", "ogg", "flac" ], "default": "m4a" }, "bitrateKbps": { "type": "integer", "minimum": 32, "maximum": 320, "default": 128 }, "sampleRate": { "type": "integer", "minimum": 8000, "maximum": 96000, "default": 48000 }, "channels": { "type": "integer", "minimum": 1, "maximum": 2, "default": 2 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/tool-audio": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "downloadUrl", "fileSizeBytes" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/stems": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/stems/{stem}": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "stem", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/stems/mix": { "post": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stems": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } }, "required": [ "stems" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/stem-mix": { "get": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string" }, "required": false, "name": "stems", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/transcript": { "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transcript": { "type": "object", "properties": { "language": { "type": "string", "minLength": 1, "maxLength": 16 }, "duration": { "type": "number" }, "text": { "type": "string" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "start": { "type": "number" }, "end": { "type": "number" }, "text": { "type": "string" }, "words": { "type": "array", "items": { "type": "object", "properties": { "word": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } }, "required": [ "word", "start", "end" ] } } }, "required": [ "id", "start", "end", "text" ] } } }, "required": [ "language", "duration", "text", "segments" ] } }, "required": [ "transcript" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/chapters": { "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chapters": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "startTime": { "type": "number" }, "endTime": { "type": "number" } }, "required": [ "title", "startTime", "endTime" ] } } }, "required": [ "chapters" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/assets/{id}/highlights/{highlightId}": { "patch": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "highlightId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": [ "string", "null" ], "maxLength": 2000 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "delete": { "tags": [ "assets" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "highlightId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/collections": { "get": { "tags": [ "collections" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": [ "integer", "null" ], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodArray" }, { "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "videoCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "name", "color", "videoCount", "createdAt", "updatedAt" ] } } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "collections" ], "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "color": { "type": "string" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "videoCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "name", "color", "videoCount", "createdAt", "updatedAt" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/collections/{id}": { "get": { "tags": [ "collections" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "videoCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "name", "color", "videoCount", "createdAt", "updatedAt" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "collections" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "color": { "type": "string" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "videoCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "name", "color", "videoCount", "createdAt", "updatedAt" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "delete": { "tags": [ "collections" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}": { "get": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "assetId": { "type": "string" }, "playbackId": { "type": "string" }, "manifestUrl": { "type": "string" }, "thumbnailVttUrl": { "type": "string" }, "thumbnailUrl": { "type": [ "string", "null" ] }, "playerUrl": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "durationSec": { "type": "number" }, "canEdit": { "type": "boolean" }, "publicSettings": { "type": "object", "properties": { "allowDownload": { "type": "boolean" }, "showTranscript": { "type": "boolean" }, "showChapters": { "type": "boolean" }, "showHighlights": { "type": "boolean" }, "showComments": { "type": "boolean" } }, "required": [ "allowDownload", "showTranscript", "showChapters", "showHighlights", "showComments" ] }, "settings": { "type": [ "object", "null" ], "properties": { "primaryColor": { "type": "string" }, "theme": { "type": "string", "enum": [ "light", "dark" ] }, "logoUrl": { "type": [ "string", "null" ] }, "muxDataEnvKey": { "type": [ "string", "null" ] } }, "required": [ "primaryColor", "theme", "logoUrl" ] }, "muxDataEnvKey": { "type": [ "string", "null" ] }, "ai": { "type": [ "object", "null" ], "properties": { "status": { "type": "string" }, "language": { "type": [ "string", "null" ] }, "subtitlesUrl": { "type": [ "string", "null" ] }, "srtSubtitlesUrl": { "type": [ "string", "null" ] }, "transcriptUrl": { "type": [ "string", "null" ] }, "chaptersUrl": { "type": [ "string", "null" ] }, "chaptersStatus": { "type": "string" }, "highlightsStatus": { "type": "string" }, "subtitleTranslationStatus": { "type": "string" }, "subtitles": { "type": "object", "additionalProperties": { "type": "object", "properties": { "vtt": { "type": "string" }, "srt": { "type": "string" } }, "required": [ "vtt", "srt" ] } } }, "required": [ "status", "language", "subtitlesUrl", "srtSubtitlesUrl", "transcriptUrl", "chaptersUrl" ] }, "audioUrl": { "type": [ "string", "null" ] }, "audio": { "type": [ "object", "null" ], "properties": { "codec": { "type": [ "string", "null" ] }, "bitrateKbps": { "type": [ "number", "null" ] }, "sampleRate": { "type": [ "number", "null" ] }, "channels": { "type": [ "number", "null" ] }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "codec", "bitrateKbps", "sampleRate", "channels", "fileSizeBytes" ] }, "orgId": { "type": [ "string", "null" ] } }, "required": [ "assetId", "playbackId", "manifestUrl", "thumbnailVttUrl", "thumbnailUrl", "playerUrl", "canEdit" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}/audio": { "get": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "downloadUrl", "fileSizeBytes" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}/download": { "get": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "downloadUrl": { "type": "string" } }, "required": [ "downloadUrl" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}/highlights": { "get": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "highlights": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "startTimeSec": { "type": "number" }, "endTimeSec": { "type": "number" }, "durationSec": { "type": [ "number", "null" ] }, "clipUrl": { "type": [ "string", "null" ] }, "thumbnailUrl": { "type": [ "string", "null" ] }, "fileSizeBytes": { "type": [ "number", "null" ] } }, "required": [ "id", "title", "description", "startTimeSec", "endTimeSec", "durationSec", "clipUrl", "thumbnailUrl", "fileSizeBytes" ] } } }, "required": [ "highlights" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}/comments": { "get": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": [ "integer", "null" ], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "authorName": { "type": "string" }, "emailHash": { "type": "string" }, "body": { "type": "string" }, "timestampSec": { "type": [ "number", "null" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "authorName", "emailHash", "body", "timestampSec", "createdAt" ] } }, "total": { "type": "number" } }, "required": [ "comments", "total" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "playback" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "authorName": { "type": "string" }, "authorEmail": { "type": "string", "format": "email" }, "body": { "type": "string" }, "timestampSec": { "type": "number" } }, "required": [ "authorName", "authorEmail", "body" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "authorName": { "type": "string" }, "emailHash": { "type": "string" }, "body": { "type": "string" }, "timestampSec": { "type": [ "number", "null" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "authorName", "emailHash", "body", "timestampSec", "createdAt" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/comments/{commentId}/reactions": { "get": { "tags": [ "comments" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "commentId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "counts": { "type": "object", "additionalProperties": { "type": "number" } }, "userReactions": { "type": "array", "items": { "type": "string" } } }, "required": [ "counts", "userReactions" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "post": { "tags": [ "comments" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "commentId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emoji": { "type": "string" } }, "required": [ "emoji" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "counts": { "type": "object", "additionalProperties": { "type": "number" } }, "userReactions": { "type": "array", "items": { "type": "string" } } }, "required": [ "counts", "userReactions" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/comments/{commentId}/reactions/{emoji}": { "delete": { "tags": [ "comments" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "commentId", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "emoji", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "counts": { "type": "object", "additionalProperties": { "type": "number" } }, "userReactions": { "type": "array", "items": { "type": "string" } } }, "required": [ "counts", "userReactions" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/orgs/{id}/webhooks/config": { "get": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "orgId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "webhookUrl": { "type": [ "string", "null" ] } }, "required": [ "webhookUrl" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } }, "patch": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "orgId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "webhookUrl": { "type": [ "string", "null" ], "maxLength": 2048, "format": "uri" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "webhookUrl": { "type": [ "string", "null" ] } }, "required": [ "webhookUrl" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/orgs/{id}/webhooks/config/test": { "post": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "orgId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/orgs/{id}/webhooks/events": { "get": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "orgId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": [ "integer", "null" ], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "status", "in": "query" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {} } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/orgs/{id}/webhooks/events/{eventId}": { "get": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "eventId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "eventType": { "type": "string" }, "assetId": { "type": [ "string", "null" ] }, "payload": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "delivered", "failed", "skipped" ] }, "createdAt": { "type": "string" }, "processedAt": { "type": [ "string", "null" ] }, "deliveryCount": { "type": "number" }, "lastDeliveryStatus": { "type": [ "string", "null" ] }, "deliveries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "eventId": { "type": "string" }, "orgId": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string", "enum": [ "delivered", "failed" ] }, "statusCode": { "type": [ "number", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "attemptNumber": { "type": "number" }, "createdAt": { "type": "string" } }, "required": [ "id", "eventId", "orgId", "url", "status", "statusCode", "errorMessage", "attemptNumber", "createdAt" ] } } }, "required": [ "id", "orgId", "eventType", "assetId", "payload", "status", "createdAt", "processedAt", "deliveryCount", "lastDeliveryStatus", "deliveries" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/orgs/{id}/webhooks/events/{eventId}/retry": { "post": { "tags": [ "webhooks" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "eventId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "retried": { "type": "boolean" } }, "required": [ "retried" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/playback/{playbackId}/ai": { "get": { "tags": [ "ai" ], "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "playbackId", "in": "path" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "status": { "type": "string" }, "language": { "type": [ "string", "null" ] }, "subtitlesUrl": { "type": [ "string", "null" ] }, "srtSubtitlesUrl": { "type": [ "string", "null" ] }, "transcriptUrl": { "type": [ "string", "null" ] }, "chaptersUrl": { "type": [ "string", "null" ] }, "chaptersStatus": { "type": "string" }, "highlightsStatus": { "type": "string" }, "subtitleTranslationStatus": { "type": "string" }, "subtitles": { "type": "object", "additionalProperties": { "type": "object", "properties": { "vtt": { "type": "string" }, "srt": { "type": "string" } }, "required": [ "vtt", "srt" ] } } }, "required": [ "status", "language", "subtitlesUrl", "srtSubtitlesUrl", "transcriptUrl", "chaptersUrl" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/ai/analyze-transcript": { "post": { "tags": [ "ai" ], "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transcript": { "type": "string", "minLength": 1 }, "durationSec": { "type": "number", "exclusiveMinimum": 0 }, "contentType": { "type": "string", "enum": [ "podcast", "gaming", "educational", "interview", "vlog", "general" ] }, "userInstruction": { "type": "string" }, "highlightsPreset": { "type": "string", "enum": [ "fast", "standard", "deep" ] }, "runHighlights": { "type": "boolean" }, "runChapters": { "type": "boolean" }, "runSmartMetadata": { "type": "boolean" } }, "required": [ "transcript" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "highlights": { "type": "array", "items": {} }, "chapters": { "type": "array", "items": {} }, "smartMetadata": {} } } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } }, "/v1/ai/translate": { "post": { "tags": [ "ai" ], "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 }, "targetLang": { "type": "string", "minLength": 2 }, "sourceLang": { "type": "string", "minLength": 2 } }, "required": [ "text", "targetLang" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseZodObject" }, { "properties": { "data": { "type": "object", "properties": { "translatedText": { "type": "string" }, "sourceLang": { "type": "string" }, "targetLang": { "type": "string" }, "provider": { "type": "string", "enum": [ "workers-ai", "fly-translator" ] } }, "required": [ "translatedText", "sourceLang", "targetLang", "provider" ] } } } ] } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } } } } } }, "webhooks": {} }