{ "openapi": "3.1.0", "info": { "title": "Content Search API", "version": "1.18.0" }, "paths": { "/api/content/v1/assets": { "post": { "summary": "Create Asset", "operationId": "create_asset_api_content_v1_assets_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Assets", "operationId": "assets_api_content_v1_assets_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/imports": { "post": { "summary": "Create Import", "operationId": "create_import_api_content_v1_imports_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/capabilities": { "get": { "summary": "Content Capabilities", "description": "What your plycdn service can index.\n\nServed so a client discovers formats at runtime rather than carrying its own list. Teaching the\nproduct a new format is then a deployment, not a release of every SDK that talks to it.", "operationId": "content_capabilities_api_content_v1_capabilities_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}": { "get": { "summary": "Asset", "description": "One file: what it is, where it came from and the state of its latest revision.\n\n`asReader=true`, or any `principals`, opens it only for a reader who may see it: a restricted file not granted\nto one of those principals answers asset_not_found, as search would never show it.", "operationId": "asset_api_content_v1_assets__asset_id__get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "asReader", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Asreader" } }, { "name": "principals", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Principals" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete", "operationId": "delete_api_content_v1_assets__asset_id__delete", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/activity": { "get": { "summary": "Activity", "description": "Assets with their most recent job, newest first, to follow work as it progresses.\n\nNarrow by connector, kind, state, text or creation time; every filter combines with AND.\n`connectorId` lists the files that connector brought in. `bucketId` lists the files one of your\nbuckets or video libraries made searchable. `order=filename` lists by filename\nand returns `nextCursor` while more remain; `asReader=true`, or any `principals`, lists only\nthe files those principals may see.", "operationId": "activity_api_content_v1_activity_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "connectorId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Connectorid" } }, { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(video|audio|document)$" }, { "type": "null" } ], "title": "Kind" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "State" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } }, { "name": "createdAfter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdafter" } }, { "name": "createdBefore", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdbefore" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(created|filename)$", "default": "created", "title": "Order" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4400 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "asReader", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Asreader" } }, { "name": "principals", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Principals" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/jobs": { "get": { "summary": "Asset Jobs", "description": "Every job recorded for one asset, newest first.", "operationId": "asset_jobs_api_content_v1_assets__asset_id__jobs_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/jobs/{job_id}": { "get": { "summary": "Job", "operationId": "job_api_content_v1_jobs__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/imports/{import_id}": { "get": { "summary": "Import Status", "operationId": "import_status_api_content_v1_imports__import_id__get", "parameters": [ { "name": "import_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Import Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/transcript": { "get": { "summary": "Transcript", "operationId": "transcript_api_content_v1_assets__asset_id__transcript_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Correct", "operationId": "correct_api_content_v1_assets__asset_id__transcript_patch", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "if-match", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Correction" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/reindex": { "post": { "summary": "Reindex", "operationId": "reindex_api_content_v1_assets__asset_id__reindex_post", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/source-access": { "put": { "summary": "Renew", "operationId": "renew_api_content_v1_assets__asset_id__source_access_put", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAccess" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/jobs/{job_id}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_api_content_v1_jobs__job_id__cancel_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/settings": { "get": { "summary": "Read Settings", "description": "Effective settings for the calling organization, and where each field comes from.", "operationId": "read_settings_api_content_v1_settings_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Write Settings", "description": "Replace this organization's settings row. Omitted fields (and omitted video defaults) revert to inherited.", "operationId": "write_settings_api_content_v1_settings_put", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Change Settings", "description": "Change only the fields sent. A field sent as null is cleared, so it is inherited\nagain; `callbackSecret: null` removes the stored secret; `sourceHosts: []` inherits, as on PUT.\nThe rules are PUT's: the allowed host ceiling, a plain HTTPS callback, and the permissions\nfeature of your plan.", "operationId": "change_settings_api_content_v1_settings_patch", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Clear Settings", "description": "Drop this organization's row so it inherits from its parent again.", "operationId": "clear_settings_api_content_v1_settings_delete", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/metadata": { "put": { "summary": "Write Metadata", "description": "Replace this asset's metadata. A PUT: the document sent becomes the whole document.\n\nNothing is re-indexed: metadata narrows which searches a file is eligible for and does not\nchange what its passages mean, so a library can be re-tagged freely and at once.", "operationId": "write_metadata_api_content_v1_assets__asset_id__metadata_put", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Read Metadata", "operationId": "read_metadata_api_content_v1_assets__asset_id__metadata_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/permissions": { "put": { "summary": "Write Permissions", "description": "Replace who may see this asset.\n\nWholesale replacement, not a patch, because the caller re-syncing a source system holds the\nauthoritative list. Incremental grant and revoke would leave behind a permission the source\nremoved months ago, and nothing downstream would ever notice.", "operationId": "write_permissions_api_content_v1_assets__asset_id__permissions_put", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Read Permissions", "operationId": "read_permissions_api_content_v1_assets__asset_id__permissions_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/collections": { "post": { "summary": "Create Collection From Documents", "description": "Create a collection holding these documents - a saved selection - under the name given.\n\nIts `externalId` is made for you. Up to 1,000 documents; any that cannot be added are listed in\n`unavailable`. Needs the `collections` feature of your plan.", "operationId": "create_collection_from_documents_api_content_v1_collections_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionFromDocuments" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Collections", "operationId": "list_collections_api_content_v1_collections_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/collections/{external_id}": { "put": { "summary": "Upsert Collection", "operationId": "upsert_collection_api_content_v1_collections__external_id__put", "parameters": [ { "name": "external_id", "in": "path", "required": true, "schema": { "type": "string", "title": "External Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionUpsert" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Collection", "description": "Remove the collection. Its assets are untouched - only the grouping goes.", "operationId": "delete_collection_api_content_v1_collections__external_id__delete", "parameters": [ { "name": "external_id", "in": "path", "required": true, "schema": { "type": "string", "title": "External Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/collections/{external_id}/assets": { "put": { "summary": "Write Collection Members", "operationId": "write_collection_members_api_content_v1_collections__external_id__assets_put", "parameters": [ { "name": "external_id", "in": "path", "required": true, "schema": { "type": "string", "title": "External Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionMembers" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/search": { "post": { "summary": "Search", "operationId": "search_api_content_v1_search_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/tuning/synonyms": { "get": { "summary": "List Synonyms", "operationId": "list_synonyms_api_content_v1_tuning_synonyms_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Write Synonyms", "description": "Replace the whole dictionary. A PUT, so removing an entry is sending the list without it.", "operationId": "write_synonyms_api_content_v1_tuning_synonyms_put", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SynonymRule" }, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/tuning/boosts": { "get": { "summary": "List Boosts", "operationId": "list_boosts_api_content_v1_tuning_boosts_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/tuning/boosts/{name}": { "put": { "summary": "Write Boost", "operationId": "write_boost_api_content_v1_tuning_boosts__name__put", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoostRule" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Boost", "operationId": "delete_boost_api_content_v1_tuning_boosts__name__delete", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/tuning/pins": { "get": { "summary": "List Pins", "operationId": "list_pins_api_content_v1_tuning_pins_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Write Pins", "description": "Pin files to one exact query. An empty list removes the pin.\n\nA pin promotes a result the search already found; it does not inject one. If the file does not\nanswer the query well enough to be retrieved, it will not appear - which is the honest answer,\nand shows up in the analytics report as a query without results.", "operationId": "write_pins_api_content_v1_tuning_pins_put", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinRule" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/related": { "get": { "summary": "Related Content", "description": "Other files whose content sits near this one.\n\nBilled as one search: what you receive is an answer to a question.\n\n`principals` is accepted as a repeated query parameter and is enforced exactly as it is on\nsearch: related content never shows a file the reader could not find by searching.", "operationId": "related_content_api_content_v1_assets__asset_id__related_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "principals", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Principals" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/assets/{asset_id}/playback": { "get": { "summary": "Asset Playback", "description": "A link that plays a file of your own plycdn bucket or video library: the streaming playlist of a video or a\nrecording (`format` hls, with `nativeUrl` for players that stream it natively, and the poster), or the file\nitself (`format` file), valid until `expiresAt`. Your backend hands it to the player. A file registered from\nanywhere else answers asset_not_playable.\n\n`asReader=true`, or any `principals`, plays it only for a reader who may see it: a restricted file not granted\nto one of those principals answers asset_not_found.", "operationId": "asset_playback_api_content_v1_assets__asset_id__playback_get", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "asReader", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Asreader" } }, { "name": "principals", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Principals" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/suggest": { "get": { "summary": "Suggest", "description": "Completions for a partly typed query, drawn from searches that previously found something.\n\nNot billed: it is a keystroke, not a question.", "operationId": "suggest_api_content_v1_suggest_get", "parameters": [ { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "Prefix" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 25, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/answer": { "post": { "summary": "Answer", "description": "A written answer to the question, grounded in the passages that answer it.\n\nIt uses the same retrieval as /search: every filter, permission and relevance rule is the same.\nTwo things follow. Nothing the reader may not see can be cited, because nothing they may not\nsee is retrieved. And a question the library cannot answer produces no passages, so it produces\nno answer rather than a guess.\n\nA follow-up can send the conversation so far as `conversation` (up to six earlier turns, never\nstored). It is restated as a question that stands alone, returned as `question`, and searched\nexactly as above: the conversation never changes what may be searched. Send\n`Accept: text/event-stream` to receive the answer as it is written: `delta` events, then one\n`citations` event, then `done`. A failure after the first event ends the stream with an `error`\nevent carrying the usual code.", "operationId": "answer_api_content_v1_answer_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/plan": { "get": { "summary": "Plan", "description": "What this organization may do, and any ceilings that apply.\n\nRead-only and never gated. A caller that has just been refused with `not_included_in_plan`\nneeds somewhere to find out what they do have - and an application can use it to stop offering\na button that will only ever return 403.\n\n`enforced` is false where this deployment is not applying plans at all, in which case\neverything is available and `features` lists everything.", "operationId": "plan_api_content_v1_plan_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/connectors": { "get": { "summary": "List Connectors", "operationId": "list_connectors_api_content_v1_connectors_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Connector", "operationId": "create_connector_api_content_v1_connectors_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorUpsert" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/connectors/{connector_id}": { "get": { "summary": "Connector", "operationId": "connector_api_content_v1_connectors__connector_id__get", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Update Connector", "description": "Replace a connector's configuration.\n\nAn omitted credential keeps the stored one, so a schedule can be changed without re-sending a\nsecret the caller cannot read back. An omitted extractContentFromVideoFrames keeps the stored\nvalue; an explicit null puts the connector back on the organization's setting.", "operationId": "update_connector_api_content_v1_connectors__connector_id__put", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorUpsert" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Connector", "description": "Remove a connector. Content it registered stays indexed and searchable.\n\nRemoving the link to a source is not deleting the library: delete files themselves with\nDELETE /assets/{asset_id}.", "operationId": "delete_connector_api_content_v1_connectors__connector_id__delete", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/connectors/{connector_id}/sync": { "post": { "summary": "Sync Connector", "description": "Ask for a sync. The worker picks it up; this returns immediately.\n\nNot synchronous. A first run over a real library registers thousands of files and would exceed\nevery read timeout between here and the caller - and a request that times out mid-run leaves\nnobody able to say what was done.\n\nAsking twice while one is pending is a no-op rather than a second run.", "operationId": "sync_connector_api_content_v1_connectors__connector_id__sync_post", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/usage": { "get": { "summary": "Usage", "description": "What this organization has used, and - for a whole month at the parent - what it comes to at list.\n\n`month=YYYY-MM`, or `from`/`to` with `to` inclusive, cut in the account's time zone; defaults\nto the current month. A range shows quantities only. A sub-organization sees its own lines.\nA malformed period is refused with 400 `invalid_period`. Amounts are at your list prices.", "operationId": "usage_api_content_v1_usage_get", "parameters": [ { "name": "month", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Month" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/usage/daily": { "get": { "summary": "Usage Daily", "description": "Quantities per day in the account's time zone. Never money: allowances are monthly.", "operationId": "usage_daily_api_content_v1_usage_daily_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "metric", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Metric" } }, { "name": "breakdown", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Breakdown" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/usage/assets": { "get": { "summary": "Usage By Asset", "description": "What was done to each file in the period, and what it was billed - including deleted files.\n\nNever gated, like the rest of usage: whatever a customer is or is not paying for, they can\nalways see what their own content went through. It answers the question a period total\ncannot - \"what happened to *this* lecture\" - which is the one asked in every billing query\nand every privacy review. The period is cut in the account's time zone, `to` inclusive.\nAt the parent, every file of the account, each with its `organizationId`; a sub-organization\nsees its own files.", "operationId": "usage_by_asset_api_content_v1_usage_assets_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/statements": { "get": { "summary": "Statements", "operationId": "statements_api_content_v1_statements_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/statements/{month}": { "get": { "summary": "Statement", "operationId": "statement_api_content_v1_statements__month__get", "parameters": [ { "name": "month", "in": "path", "required": true, "schema": { "type": "string", "title": "Month" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/statements/{month}/export": { "get": { "summary": "Statement Export", "description": "`text/csv` with `Content-Disposition: attachment`: the statement as a spreadsheet, the one\nresponse that is not JSON.", "operationId": "statement_export_api_content_v1_statements__month__export_get", "parameters": [ { "name": "month", "in": "path", "required": true, "schema": { "type": "string", "title": "Month" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/usage/quotas": { "get": { "summary": "Usage Quotas", "description": "Quota, used, remaining and percent for each metric this month, account-wide.\n\nQuotas are set by us with you, never from the API; `payAsYouGo` says whether work above a quota\ncontinues (billed at list) or is refused with `quota_exceeded`.", "operationId": "usage_quotas_api_content_v1_usage_quotas_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/analytics/library": { "get": { "summary": "Content Health", "description": "What is wrong with this organization's library right now.\n\nExists so a customer can answer \"is anything broken\" without asking us. Three things are worth\nknowing and none of them is visible from a list of assets: what failed, what is stuck waiting\non access we cannot renew, and what is still working.", "operationId": "content_health_api_content_v1_analytics_library_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/analytics/searches": { "get": { "summary": "Search Analytics", "description": "What people searched for, and what they searched for and did not find.\n\nThe second list is the point. Popular queries confirm what a library is already good at;\nqueries that returned nothing name the gap between what it holds and what its readers came\nlooking for, which is not visible from anywhere else in a customer's estate.", "operationId": "search_analytics_api_content_v1_analytics_searches_get", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/regions": { "get": { "summary": "List Regions", "description": "The regions a bucket can be created in, each with its code, name, whether it can keep a\nbucket's processing in its country (strict residency) and whether it offers live streaming (`live`:\na video library there can have live inputs).", "operationId": "list_regions_api_content_v1_regions_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/bucket-names": { "get": { "summary": "Bucket Name Availability", "description": "Whether a bucket name can be used: `available`, or not with a reason (`invalid` or `taken`), and\n`hostname`, the address a bucket of that name gets (null for an invalid name). Names are unique across plycdn. The answer is advisory: a create can still lose the name to another\naccount in the meantime. Limited per account per minute (`rate_limited`, with Retry-After).", "operationId": "bucket_name_availability_api_content_v1_bucket_names_get", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 100, "title": "Name" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets": { "post": { "summary": "Create Bucket", "description": "Create a bucket in a region. Answers 202 with the bucket in `creating`; it becomes `active` (or\n`failed`, with a `failureReason` and `/retry`) shortly after. An Idempotency-Key is required; the\nsame key repeats a create safely.", "operationId": "create_bucket_api_content_v1_buckets_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BucketCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Buckets", "description": "Every bucket of the organization that is not deleted, oldest first, with its stored bytes and\nobject count.", "operationId": "list_buckets_api_content_v1_buckets_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}": { "get": { "summary": "Get Bucket", "description": "One bucket: its state (and `failureReason`), delivery settings, upload rules, hostname, stored\nbytes and object count.", "operationId": "get_bucket_api_content_v1_buckets__bucket_id__get", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Patch Bucket", "description": "Change a bucket's visibility, delivery settings or upload rules. A field left out is unchanged;\nan explicit null removes a limit. Delivery changes reach the edge shortly after.", "operationId": "patch_bucket_api_content_v1_buckets__bucket_id__patch", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BucketPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Bucket", "description": "Delete a bucket. Answers 202 with the bucket in `deleting` and its `purgeAfter`: until then it\ncan be restored, and afterwards its objects are removed for good.", "operationId": "delete_bucket_api_content_v1_buckets__bucket_id__delete", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/restore": { "post": { "summary": "Restore Bucket", "description": "Undo a delete before the bucket's `purgeAfter`; afterwards the answer is\n`restore_window_passed`. Restoring a bucket that is not being deleted changes nothing.", "operationId": "restore_bucket_api_content_v1_buckets__bucket_id__restore_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/retry": { "post": { "summary": "Retry Bucket", "description": "Try again to set up a `failed` bucket. Answers 202 with the bucket back in `creating`; a bucket\nthat has not failed is returned unchanged.", "operationId": "retry_bucket_api_content_v1_buckets__bucket_id__retry_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/search": { "get": { "summary": "Get Bucket Search", "description": "Whether this bucket's files (a video library's videos and recordings) are searchable: the switch and its\nchoices, and how many files are searchable, being made searchable, waiting and skipped, with why. A video\nlibrary's id works here too.", "operationId": "get_bucket_search_api_content_v1_buckets__bucket_id__search_get", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Remove Bucket From Search", "description": "Turn search off for this bucket (or video library) and remove its files from search now. The files themselves\nare untouched; turning search on again makes them searchable again.", "operationId": "remove_bucket_from_search_api_content_v1_buckets__bucket_id__search_delete", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/libraries": { "post": { "summary": "Create Library", "description": "Create a video library: a private bucket for video sources, created as a bucket is (202, `creating`\nuntil it is ready) and counted towards your bucket limit.", "operationId": "create_library_api_content_v1_libraries_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibraryCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Libraries", "description": "Your organization's video libraries, with their state and settings.", "operationId": "list_libraries_api_content_v1_libraries_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/libraries/{library_id}": { "get": { "summary": "Get Library", "description": "One video library, with its state and settings.", "operationId": "get_library_api_content_v1_libraries__library_id__get", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Patch Library", "description": "Change a video library's delivery, processing or largest-upload settings; fields left out are kept.", "operationId": "patch_library_api_content_v1_libraries__library_id__patch", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibraryPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Library", "description": "Delete a video library as a bucket is deleted (202): delivery stops now and its files are removed\nafter the restore window.", "operationId": "delete_library_api_content_v1_libraries__library_id__delete", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/libraries/{library_id}/live-inputs": { "post": { "summary": "Create Live Input", "description": "A live input in a video library, with its `streamKey`: shown here and when rotated, and again only by\nthe audited reveal. The answer lists every address an encoder can publish to. An Idempotency-Key is\nrequired, as on every create: a retry with the same key and body answers the same input (with its stream\nkey, audited as a reveal) instead of making a second one.", "operationId": "create_live_input_api_content_v1_libraries__library_id__live_inputs_post", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputCreated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Live Inputs", "description": "The library's live inputs, oldest first, each with its current stream when it has one.", "operationId": "list_live_inputs_api_content_v1_libraries__library_id__live_inputs_get", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}": { "get": { "summary": "Get Live Input", "description": "One live input. `view=browser` is the answer a page may show: its id, state, delivery mode and the\ncurrent stream's id, state, start times and renditions version, and nothing else.", "operationId": "get_live_input_api_content_v1_live_inputs__input_id__get", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "const": "browser", "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LiveInputView" }, { "$ref": "#/components/schemas/LiveInputBrowserView" } ], "title": "Response Get Live Input Api Content V1 Live Inputs Input Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Patch Live Input", "description": "Rename an input, change its settings (they apply from the next stream) or replace its metadata. Ads and content\nprotection on together are refused (`live_setting_conflict`, 409, `detail.settings` names them).", "operationId": "patch_live_input_api_content_v1_live_inputs__input_id__patch", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Live Input", "description": "Delete an input that is not streaming (live_input_busy otherwise); its key stops working.", "operationId": "delete_live_input_api_content_v1_live_inputs__input_id__delete", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/stream-key": { "post": { "summary": "Rotate Stream Key", "description": "A new stream key, in the answer with the input; the old one stops working at once.", "operationId": "rotate_stream_key_api_content_v1_live_inputs__input_id__stream_key_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputCreated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Reveal Stream Key", "description": "The input with its current `streamKey` again. Every reveal is recorded in the audit log with who asked.", "operationId": "reveal_stream_key_api_content_v1_live_inputs__input_id__stream_key_get", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputCreated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/publish-tokens": { "post": { "summary": "Create Publish Token", "description": "A token for one browser to go live on this input, valid for `ttlSeconds` (up to 3600, default 900).", "operationId": "create_publish_token_api_content_v1_live_inputs__input_id__publish_tokens_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PublishTokenCreate" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishToken" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/disable": { "post": { "summary": "Disable Live Input", "description": "Stop the input taking new streams; a stream in progress ends.", "operationId": "disable_live_input_api_content_v1_live_inputs__input_id__disable_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/enable": { "post": { "summary": "Enable Live Input", "description": "Let a disabled input take streams again.", "operationId": "enable_live_input_api_content_v1_live_inputs__input_id__enable_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveInputView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/end": { "post": { "summary": "End Live Stream", "description": "End the input's stream now (`ended_by_request`). `live_not_started` (409, retryable) when it has none.", "operationId": "end_live_stream_api_content_v1_live_inputs__input_id__end_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/breaks": { "post": { "summary": "Insert Ad Break", "description": "An ad break on the input's stream: `durationSeconds` long, from `at` (\"now\" by default) on the nearest\nsegment boundary. The playlists mark it (EXT-X-DATERANGE and the cue tags), and with ads enabled viewers see the ads\nof the break, or the slate where there are none. `live.ad_break` goes out when it starts. `live_not_started` (409,\nretryable) without a live stream; `live_input_busy` (409) when it overlaps a break already asked for.", "operationId": "insert_ad_break_api_content_v1_live_inputs__input_id__breaks_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveBreakCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveBreak" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/streams": { "get": { "summary": "List Live Streams", "description": "The input's streams, newest first, with `nextCursor` until the last page.", "operationId": "list_live_streams_api_content_v1_live_inputs__input_id__streams_get", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/streams/{stream_id}": { "get": { "summary": "Get Live Stream", "description": "One stream: its state, health, real-time viewers, how long it ran and its `recordingId` (the stream's\nid is its recording's video id).", "operationId": "get_live_stream_api_content_v1_streams__stream_id__get", "parameters": [ { "name": "stream_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Stream Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/streams/{stream_id}/captions": { "get": { "summary": "Get Live Stream Captions", "description": "The stream's caption languages and the mode in force (`realtime`, or `nearLive` when captions trail the\npicture by about half a minute). A player reads the captions themselves from the stream's playlists.", "operationId": "get_live_stream_captions_api_content_v1_streams__stream_id__captions_get", "parameters": [ { "name": "stream_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Stream Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamCaptions" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/streams/{stream_id}/viewers": { "get": { "summary": "Get Live Stream Viewers", "description": "Who watched the stream, minute by minute, broadcast and real-time together: `peakConcurrent`, `viewerMinutes`,\n`countries` and a `series` of points one `step` apart (60, 300, 900 or 3600 seconds; the smallest that gives about 500\npoints when left out). `from` and `to` default to the stream's own span. Viewers are counted, never identified.", "operationId": "get_live_stream_viewers_api_content_v1_streams__stream_id__viewers_get", "parameters": [ { "name": "stream_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Stream Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "step", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 86400, "minimum": 1 }, { "type": "null" } ], "title": "Step" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamViewers" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/streams/{stream_id}/health": { "get": { "summary": "Get Live Stream Health", "description": "The stream's health minute by minute: input bitrate, frame rate, keyframe interval, encoding speed, part push time,\ngaps and failovers, grouped by `step` (60, 300, 900 or 3600 seconds). `from` and `to` default to the stream's own span.\nKept 30 days.", "operationId": "get_live_stream_health_api_content_v1_streams__stream_id__health_get", "parameters": [ { "name": "stream_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Stream Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "step", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 86400, "minimum": 1 }, { "type": "null" } ], "title": "Step" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveStreamHealth" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/destinations": { "post": { "summary": "Create Destination", "description": "Push the input's streams to another platform: its rtmp(s):// address (no key in it) and the stream key it issued.\nThe key is never answered again. `destination_limit_reached` (409) past the cap per input. An Idempotency-Key is\nrequired, as on every create: a retry with the same key and body answers the same destination instead of a second one\n(`idempotency_conflict`, 409, for the same key with another body).", "operationId": "create_destination_api_content_v1_live_inputs__input_id__destinations_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Destinations", "description": "The input's destinations, oldest first, each with its push state; never a key.", "operationId": "list_destinations_api_content_v1_live_inputs__input_id__destinations_get", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/destinations/{destination_id}": { "patch": { "summary": "Patch Destination", "description": "Change a destination's name, address or key; fields left out are kept.", "operationId": "patch_destination_api_content_v1_destinations__destination_id__patch", "parameters": [ { "name": "destination_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Destination Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Destination", "description": "Delete a destination; a push to it in progress stops.", "operationId": "delete_destination_api_content_v1_destinations__destination_id__delete", "parameters": [ { "name": "destination_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Destination Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/destinations/{destination_id}/test": { "post": { "summary": "Test Destination", "description": "Check that the platform's ingest answers: the connection handshake only, nothing is published and the key is not\nused. `destination_unreachable` (502, retryable) otherwise. Limited to hourly allowances per account and per\ndestination, and to one test at a time per account (rate_limited). A test answers within a few seconds.", "operationId": "test_destination_api_content_v1_destinations__destination_id__test_post", "parameters": [ { "name": "destination_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Destination Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationTestResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/share-links": { "post": { "summary": "Create Share Link", "description": "A watch link for the input: its `url` opens the watch page, where anyone with it watches (broadcast delivery, any\nnumber of viewers). Optional `label`, `password` (4 to 128 characters), `expiresAt` (in the future) and\n`showRecording` (on by default: after the stream ends the link plays its recording). `share_link_limit_reached` (409)\npast 50 links on one input.", "operationId": "create_share_link_api_content_v1_live_inputs__input_id__share_links_post", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Share Links", "description": "The input's watch links, newest first; never a password.", "operationId": "list_share_links_api_content_v1_live_inputs__input_id__share_links_get", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/live-inputs/{input_id}/share-links/{link_id}": { "patch": { "summary": "Patch Share Link", "description": "Change a watch link: `label`, `password` (null removes it), `expiresAt` (null removes it), `showRecording`, or\n`disabled` (a disabled link opens nothing until it is enabled again). Fields left out are kept.", "operationId": "patch_share_link_api_content_v1_live_inputs__input_id__share_links__link_id__patch", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Link Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Share Link", "description": "Delete a watch link: it opens nothing from now on.", "operationId": "delete_share_link_api_content_v1_live_inputs__input_id__share_links__link_id__delete", "parameters": [ { "name": "input_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Input Id" } }, { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Link Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/watch-brand": { "get": { "summary": "Get Watch Brand", "description": "The organization's watch-page brand (its parent's, `inherited: true`, until it saves its own), with `logoUrl`.", "operationId": "get_watch_brand_api_content_v1_watch_brand_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchBrandView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Put Watch Brand", "description": "Set the watch-page brand: `accentColor` and `backgroundColor` (#rrggbb), `theme` (dark or light), `layout` (cinema,\nstandard or side_panel), `title`, `description`, `messages` (`starting`, `ended`, `password`), `siteUrl` and\n`siteLabel`, `footerLinks` (up to 3 of label and https url), `logoSize` (small, medium or large; the logo at most 32, 48\nor 72 px high). Plain text only; links are https. A field left out is\nkept; null returns it to its default.", "operationId": "put_watch_brand_api_content_v1_watch_brand_put", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchBrandPut" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchBrandView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/watch-brand/logo": { "put": { "summary": "Put Watch Brand Logo", "description": "The watch-page logo: the image itself as the body, with its Content-Type (image/png, image/jpeg or image/webp), at\nmost 512 KB. Its type is read from its bytes and must agree with the one sent (`logo_invalid`, 422; SVG is refused);\nlarger is `logo_too_large` (413).", "operationId": "put_watch_brand_logo_api_content_v1_watch_brand_logo_put", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchBrandView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Watch Brand Logo", "description": "Remove the watch-page logo: the page shows none from now on.", "operationId": "delete_watch_brand_logo_api_content_v1_watch_brand_logo_delete", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/watch-domains": { "get": { "summary": "List Watch Domains", "description": "The organization's watch domains, oldest first.", "operationId": "list_watch_domains_api_content_v1_watch_domains_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchDomainList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Watch Domain", "description": "Add a watch domain (at most 5), a subdomain such as live.acme.com: publish the two CNAME records in `records` (one\nroutes it to the watch pages, one lets its certificate issue and renew); it goes from `pending_dns` to `active` as a\ncustom domain does, and the organization's share links then also open on it (each link's `urls`).\n`watch_domain_limit_reached` (409), `domain_exists` (409), `hostname_not_allowed` (422),\n`watch_domain_apex_unsupported` (422: a bare domain such as acme.com; `detail.suggestions`).", "operationId": "create_watch_domain_api_content_v1_watch_domains_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchDomainCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchDomainView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/watch-domains/{domain_id}": { "get": { "summary": "Get Watch Domain", "description": "One watch domain, with its checks.", "operationId": "get_watch_domain_api_content_v1_watch_domains__domain_id__get", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchDomainView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Watch Domain", "description": "Delete a watch domain: share links stop opening on it at once.", "operationId": "delete_watch_domain_api_content_v1_watch_domains__domain_id__delete", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/watch-domains/{domain_id}/check": { "post": { "summary": "Check Watch Domain", "description": "Check a watch domain's DNS now (at most once a minute: `domain_rate_limited`, 429 with Retry-After). A failed or\ndetached one starts again from `pending_dns`.", "operationId": "check_watch_domain_api_content_v1_watch_domains__domain_id__check_post", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchDomainView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/libraries/{library_id}/videos": { "post": { "summary": "Create Video", "description": "A video and the upload that brings its source; encoding starts when the upload completes.", "operationId": "create_video_api_content_v1_libraries__library_id__videos_post", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Videos", "description": "A library's videos, newest first. Pass `nextCursor` back as `cursor` for the next page; it is\nnull on the last one.", "operationId": "list_videos_api_content_v1_libraries__library_id__videos_get", "parameters": [ { "name": "library_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Library Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "uploading", "queued", "encoding", "playable", "ready", "failed" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/videos/{video_id}": { "get": { "summary": "Get Video", "description": "One video: its status (`uploading`, `queued`, `encoding`, `playable`, `ready` or `failed`) and details.", "operationId": "get_video_api_content_v1_videos__video_id__get", "parameters": [ { "name": "video_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Video Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Patch Video", "description": "Change a video's title or metadata; fields left out are kept.", "operationId": "patch_video_api_content_v1_videos__video_id__patch", "parameters": [ { "name": "video_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Video Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Video", "description": "Delete a video now: its files and cached copies are removed shortly after. There is no restore.", "operationId": "delete_video_api_content_v1_videos__video_id__delete", "parameters": [ { "name": "video_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Video Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/videos/{video_id}/reencode": { "post": { "summary": "Reencode Video", "description": "Encode a ready video again with the settings that apply now. It needs the original kept\n(`original_not_kept` otherwise) and answers 202 with the video, now `queued`.", "operationId": "reencode_video_api_content_v1_videos__video_id__reencode_post", "parameters": [ { "name": "video_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Video Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/uploads": { "post": { "summary": "Start Upload", "description": "Start an upload of one file: its key, size, content type and optional SHA-256. Answers 201 with\nthe upload, the URL of every part and how long those URLs stay valid (`ticketExpiresAt`,\n`ticketTtlSeconds`). Send the parts, then `complete`.", "operationId": "start_upload_api_content_v1_buckets__bucket_id__uploads_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/uploads/{upload_id}": { "get": { "summary": "Upload Status", "description": "An upload's state and the parts received so far (`received`), for resuming an interrupted\nupload.", "operationId": "upload_status_api_content_v1_uploads__upload_id__get", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Upload Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Abort Upload", "description": "Abandon an upload and release the storage it reserved. Answers the upload: `aborted`, or\n`completed` with its `object` when the upload had already finished. Safe to repeat.", "operationId": "abort_upload_api_content_v1_uploads__upload_id__delete", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Upload Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/uploads/{upload_id}/renew": { "post": { "summary": "Renew Upload", "description": "Fresh part URLs for an open upload whose URLs expired or are about to: the same part numbers and\nsizes, with a new `ticketExpiresAt` and `ticketTtlSeconds`.", "operationId": "renew_upload_api_content_v1_uploads__upload_id__renew_post", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Upload Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/uploads/{upload_id}/complete": { "post": { "summary": "Complete Upload", "description": "Finish an upload once every part is sent. Answers the completed upload with its `object`.\nSafe to repeat; `upload_not_open` marked retryable means another completion is running, so\nask again shortly.", "operationId": "complete_upload_api_content_v1_uploads__upload_id__complete_post", "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Upload Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/objects": { "get": { "summary": "List Objects", "description": "A bucket's objects in key order, optionally under a literal key prefix. Pass `nextCursor` back as\n`cursor` for the next page; it is null on the last one.", "operationId": "list_objects_api_content_v1_buckets__bucket_id__objects_get", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "prefix", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 1024, "pattern": "^[^\\x00]*$", "default": "", "title": "Prefix" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024, "pattern": "^[^\\x00]*$" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/objects/{object_id}": { "get": { "summary": "Get Object", "description": "One object, including its checksum state and whether it is disabled.", "operationId": "get_object_api_content_v1_objects__object_id__get", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Object Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Update Object", "description": "Replace an object's metadata as a whole: at most 64 keys, each value a string, number, boolean\nor null, and at most 8 KiB as JSON.", "operationId": "update_object_api_content_v1_objects__object_id__patch", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Object Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Object", "description": "Delete an object. It stops being listed at once and its key can be uploaded again; its bytes and\nany cached copies are removed shortly after.", "operationId": "delete_object_api_content_v1_objects__object_id__delete", "parameters": [ { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Object Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/signing-profile": { "get": { "summary": "Signing Profile", "description": "What a server needs to sign delivery links for a bucket itself: the scheme, key id, key,\nhostname, default link lifetime and whether links are bound to the viewer's address. The key is a\nsecret: keep it on your server.", "operationId": "signing_profile_api_content_v1_buckets__bucket_id__signing_profile_get", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/signing-key/rotate": { "post": { "summary": "Rotate Signing Key", "description": "Replace a bucket's signing key and answer the new signing profile. The old key stops working\nat once: links signed with it are refused from then on.", "operationId": "rotate_signing_key_api_content_v1_buckets__bucket_id__signing_key_rotate_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/sign": { "post": { "summary": "Sign", "description": "A delivery link to one stored object, by `key` or `objectId`. On a private bucket it is signed and\nvalid for `ttlSeconds` (or the bucket's default); `ip` is the viewer's IPv4 address when the bucket\nbinds links to an address, and refused when it does not. On a public bucket it is the plain URL,\nwith no expiry. A disabled object, or one of another bucket, is `object_not_found`. With `liveInputId` (and\nan optional `mode`, `broadcast` or `realtime`) the links are for the input's running stream; `live_not_started`\n(409, retryable) when none is.", "operationId": "sign_api_content_v1_sign_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/usage/resources": { "get": { "summary": "Usage By Resource", "description": "Storage and video encoding usage per bucket, day, metric and region (or region group), at most 93 days at a\ntime. `provisional` figures may still change until the day settles. Pass `nextCursor` back as\n`cursor` for the next page; it is null on the last one.", "operationId": "usage_by_resource_api_content_v1_usage_resources_get", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "From" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "To" } }, { "name": "metric", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(storage_gb_days|delivery_gb|requests_millions|upload_gb|custom_domain_days|encoding_minutes|live_source_minutes|live_sd_minutes|live_hd_minutes|live_fhd_minutes|live_realtime_viewer_minutes|live_caption_minutes|gateway_egress_gb|gateway_write_requests_millions|gateway_read_requests_millions)$" }, { "type": "null" } ], "title": "Metric" } }, { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000, "minimum": 1, "default": 500, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/delivery/analytics": { "get": { "summary": "Delivery Analytics", "description": "Bandwidth (GB) and requests per UTC day and region group, `from` and `to` inclusive, at most 93\ndays, for one bucket (`bucketId`) or the whole organization (then also per bucket, largest first,\nat most 100). Every day of the range appears; a day is `provisional` while any of its figures\nmay still change.", "operationId": "delivery_analytics_api_content_v1_delivery_analytics_get", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "From" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "To" } }, { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/analytics/delivery": { "get": { "summary": "Delivery Analytics Series", "description": "Delivery over time: bytes, requests, cache hits and misses and status classes per time bucket, from\n`from` to `to` inclusive (UTC dates, at most 13 months). Hourly up to 14 days, daily up to 400 days,\nmonthly beyond. `dimension` names one of the bucket's breakdowns (left out: the bucket totals);\n`groupBy` is `value` (the dimension's values), `bucket` or `organization` (an account sees its\norganizations). The `top` largest series come back with the rest as `other`. Each point is a flat list:\n[epochSeconds, bytes, requests, cacheHits, cacheMisses, s2xx, s3xx, s4xx, s5xx]. `provisional` is true\nwhile any figure may still change; `notices` explain missing or folded data.", "operationId": "delivery_analytics_series_api_content_v1_analytics_delivery_get", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "From" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "To" } }, { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "dimension", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,31}$" }, { "type": "null" } ], "title": "Dimension" } }, { "name": "groupBy", "in": "query", "required": false, "schema": { "enum": [ "value", "bucket", "organization" ], "type": "string", "default": "value", "title": "Groupby" } }, { "name": "top", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 10, "title": "Top" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/analytics/delivery/breakdown": { "get": { "summary": "Delivery Analytics Breakdown", "description": "One UTC calendar month's totals by organization (one row per organization and bucket) or, with\n`dimension`, by that dimension's values (always with `other` and `(none)`), largest first.\n`format=csv` streams a download (at most 2 at a time per server and 1 per account: `export_busy`, 429, retry later) (organization, bucket, dimension, value, bytes, requests,\ncache_hits, cache_misses): more than 1,000,000 rows is `too_many_rows`; JSON allows 50,000.", "operationId": "delivery_analytics_breakdown_api_content_v1_analytics_delivery_breakdown_get", "parameters": [ { "name": "month", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "title": "Month" } }, { "name": "by", "in": "query", "required": false, "schema": { "enum": [ "organization", "dimension" ], "type": "string", "default": "organization", "title": "By" } }, { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "dimension", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,31}$" }, { "type": "null" } ], "title": "Dimension" } }, { "name": "format", "in": "query", "required": false, "schema": { "enum": [ "json", "csv" ], "type": "string", "default": "json", "title": "Format" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/analytics/preview": { "post": { "summary": "Preview Analytics Rule", "description": "Try one dimension rule on the bucket's recent traffic (or, with none, its file names): how many\ndistinct values it would produce, the commonest ones, and at least how many values and what list\nprice a month would bring. Changes nothing.", "operationId": "preview_analytics_rule_api_content_v1_buckets__bucket_id__analytics_preview_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsPreview" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/audit": { "get": { "summary": "Audit Log", "description": "Who changed what in storage, newest first; `from` and `to` are UTC days, both inclusive.\nPass `nextCursor` back as `cursor` for the next page; it is null on the last one.", "operationId": "audit_log_api_content_v1_audit_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "To" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 100, "pattern": "^[a-z]+(\\.[a-z_]+)+$" }, { "type": "null" } ], "title": "Action" } }, { "name": "resourceId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resourceid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/domains": { "post": { "summary": "Create Domain", "description": "Add a hostname to a bucket. Answers with the DNS records to create; checks start at once.", "operationId": "create_domain_api_content_v1_domains_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Domains", "description": "The organization's custom domains, oldest first, optionally for one bucket. Pass `nextCursor`\nback as `cursor` for the next page; it is null on the last one.", "operationId": "list_domains_api_content_v1_domains_get", "parameters": [ { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/domains/{domain_id}": { "get": { "summary": "Get Domain", "description": "One custom domain: its state, the records to create and what the last check found.", "operationId": "get_domain_api_content_v1_domains__domain_id__get", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Domain", "description": "Remove a custom domain. It stops being listed at once and stops serving shortly after.", "operationId": "delete_domain_api_content_v1_domains__domain_id__delete", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/domains/{domain_id}/check": { "post": { "summary": "Check Domain", "description": "Check a domain's DNS now (at most once a minute). A failed or detached domain starts again, with\na new TXT record value to publish.", "operationId": "check_domain_api_content_v1_domains__domain_id__check_post", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Domain Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/buckets/{bucket_id}/purges": { "post": { "summary": "Purge Cache", "description": "Remove cached copies of a bucket's files at the edge: exactly one of `urls` (1-100 https URLs on the\nbucket's default hostname or one of its active custom domains; query strings are ignored), `prefixes` (1-20 key prefixes) or `all: true`.\nAnswers 202 with the purge in `queued`; read it back for `succeeded` or `failed`. Free, and limited\nper account per hour (`rate_limited`, with Retry-After).", "operationId": "purge_cache_api_content_v1_buckets__bucket_id__purges_post", "parameters": [ { "name": "bucket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Bucket Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/purges": { "get": { "summary": "List Purges", "description": "The organization's cache purges, newest first, optionally for one bucket. Pass `nextCursor` back as\n`cursor` for the next page; it is null on the last one.", "operationId": "list_purges_api_content_v1_purges_get", "parameters": [ { "name": "bucketId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bucketid" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/purges/{purge_id}": { "get": { "summary": "Get Purge", "description": "One cache purge: its targets, state (`queued`, `running`, `succeeded`, `failed`) and, when it\nfailed, its `failureReason`.", "operationId": "get_purge_api_content_v1_purges__purge_id__get", "parameters": [ { "name": "purge_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Purge Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhooks": { "post": { "summary": "Create Webhook", "description": "An endpoint of yours for video events; the answer carries its signing secret, shown this once.\nA replay of the same Idempotency-Key answers it again while it is still the current secret; after a\nrotation it answers the endpoint without a secret, and after a delete webhook_not_found.", "operationId": "create_webhook_api_content_v1_webhooks_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "List Webhooks", "description": "Your organization's webhook endpoints, without their secrets.", "operationId": "list_webhooks_api_content_v1_webhooks_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhooks/{webhook_id}": { "get": { "summary": "Get Webhook", "description": "One webhook endpoint, without its secret.", "operationId": "get_webhook_api_content_v1_webhooks__webhook_id__get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Patch Webhook", "description": "Change a webhook endpoint's URL, events, description or whether it is active; fields left out are kept.", "operationId": "patch_webhook_api_content_v1_webhooks__webhook_id__patch", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Webhook", "description": "Delete a webhook endpoint; nothing more is delivered to it.", "operationId": "delete_webhook_api_content_v1_webhooks__webhook_id__delete", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhooks/{webhook_id}/secret/rotate": { "post": { "summary": "Rotate Webhook Secret", "description": "Replace a webhook endpoint's signing secret; the answer carries the new one, shown this once.\nLimited with pings and redeliveries (429 rate_limited, Retry-After).", "operationId": "rotate_webhook_secret_api_content_v1_webhooks__webhook_id__secret_rotate_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhooks/{webhook_id}/ping": { "post": { "summary": "Ping Webhook", "description": "Send a test event to a webhook endpoint (202); see its deliveries for the outcome. Limited with\nredeliveries and secret rotations (429 rate_limited, Retry-After).", "operationId": "ping_webhook_api_content_v1_webhooks__webhook_id__ping_post", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhooks/{webhook_id}/deliveries": { "get": { "summary": "Webhook Deliveries", "description": "An endpoint's deliveries, newest first. Pass `nextCursor` back as `cursor` for the next page; it\nis null on the last one.", "operationId": "webhook_deliveries_api_content_v1_webhooks__webhook_id__deliveries_get", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Webhook Id" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "succeeded", "failed" ], "type": "string" }, { "type": "null" } ], "title": "State" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/webhook-deliveries/{delivery_id}/redeliver": { "post": { "summary": "Redeliver Webhook", "description": "Send a finished delivery once more (202), with the same delivery id, event id and body. Limited\nwith pings and secret rotations (429 rate_limited, Retry-After).", "operationId": "redeliver_webhook_api_content_v1_webhook_deliveries__delivery_id__redeliver_post", "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Delivery Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/storage-credentials": { "get": { "summary": "List Storage Credentials", "description": "Your organization's storage credentials for S3- and Blob-compatible tools, newest first; secrets are never shown again.", "operationId": "list_storage_credentials_api_content_v1_storage_credentials_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Storage Credential", "description": "Creates a storage credential for S3- or Blob-compatible tools; the secret is returned once, in this response only.", "operationId": "create_storage_credential_api_content_v1_storage_credentials_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageCredentialCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/storage-credentials/{credential_id}/rotate": { "post": { "summary": "Rotate Storage Credential", "description": "Creates a replacement credential with the same name and scope, its secret returned once; the old one works until you revoke it.", "operationId": "rotate_storage_credential_api_content_v1_storage_credentials__credential_id__rotate_post", "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Credential Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/storage-credentials/{credential_id}": { "delete": { "summary": "Revoke Storage Credential", "description": "Revokes a storage credential: tools using it are refused within 30 seconds. Revoking twice is harmless.", "operationId": "revoke_storage_credential_api_content_v1_storage_credentials__credential_id__delete", "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Credential Id" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/content/v1/storage-account": { "get": { "summary": "Get Storage Account", "description": "Your organization's storage account: its name, home region, Blob-compatible endpoint and DNS state.", "operationId": "get_storage_account_api_content_v1_storage_account_get", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Storage Account", "description": "Creates your organization's storage account, the name Blob-compatible tools use to reach your buckets.", "operationId": "create_storage_account_api_content_v1_storage_account_post", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageAccountCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Update Storage Account", "description": "Changes the storage account's home region; its name cannot be changed.", "operationId": "update_storage_account_api_content_v1_storage_account_patch", "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageAccountUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AnalyticsPatch": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "dimensions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Rule" }, "type": "array" }, { "type": "null" } ], "title": "Dimensions" }, "ceiling": { "anyOf": [ { "type": "integer", "maximum": 10000000.0, "minimum": 100.0 }, { "type": "null" } ], "title": "Ceiling" } }, "additionalProperties": false, "type": "object", "title": "AnalyticsPatch", "description": "Delivery analytics for the bucket. `enabled` and `dimensions` always have a value (null refused);\n`ceiling` (distinct values kept per breakdown per day, 100 to 10,000,000) is cleared with null, back\nto the plan's. `dimensions`, when named, replaces the list as a whole (at most 3, checked by the\nservice with the rule's own field names)." }, "AnalyticsPreview": { "properties": { "rule": { "$ref": "#/components/schemas/Rule" } }, "additionalProperties": false, "type": "object", "required": [ "rule" ], "title": "AnalyticsPreview", "description": "Try one dimension rule against the bucket's recent traffic (or its files) before saving it." }, "AnswerRequest": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "video", "audio", "document" ] }, { "type": "null" } ], "title": "Kind" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 20 }, "offset": { "type": "integer", "maximum": 200.0, "minimum": 0.0, "title": "Offset", "default": 0 }, "filter": { "anyOf": [ { "$ref": "#/components/schemas/SearchFilter" }, { "type": "null" } ] }, "principals": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Principals" }, "group": { "anyOf": [ { "type": "string", "const": "file" }, { "type": "null" } ], "title": "Group" }, "within": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchStep" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Within" }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "title": "Cursor" }, "conversation": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ConversationTurn" }, "type": "array", "maxItems": 6 }, { "type": "null" } ], "title": "Conversation" } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "AnswerRequest", "description": "A question to answer: a search request, plus the conversation so far when it is a follow-up." }, "AssetCreate": { "properties": { "externalId": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Externalid" }, "filename": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Filename" }, "kind": { "type": "string", "enum": [ "video", "audio", "document" ], "title": "Kind" }, "sourceUrl": { "type": "string", "maxLength": 4096, "title": "Sourceurl" }, "sourceVersion": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Sourceversion" }, "sourceAccess": { "anyOf": [ { "$ref": "#/components/schemas/SourceAccess" }, { "type": "null" } ] }, "callbackKey": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Callbackkey" }, "language": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Language", "default": "multi" }, "audioTrack": { "type": "integer", "maximum": 15.0, "minimum": 0.0, "title": "Audiotrack", "default": 0 }, "extractContentFromVideoFrames": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extractcontentfromvideoframes" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": {}, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "collections": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Collections" }, "principals": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 5000 }, { "type": "null" } ], "title": "Principals" }, "contentSha256": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-fA-F]{64}$" }, { "type": "null" } ], "title": "Contentsha256" } }, "additionalProperties": false, "type": "object", "required": [ "externalId", "filename", "kind", "sourceUrl", "sourceVersion" ], "title": "AssetCreate" }, "BoostRule": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" }, "match": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" }, { "type": "null" } ], "title": "Match" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "video", "audio", "document" ] }, { "type": "null" } ], "title": "Kind" }, "factor": { "type": "number", "maximum": 10.0, "exclusiveMinimum": 0.0, "title": "Factor" } }, "additionalProperties": false, "type": "object", "required": [ "name", "factor" ], "title": "BoostRule", "description": "A preference about ordering, expressed against the metadata you already filter on." }, "BucketCreate": { "properties": { "name": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$", "title": "Name" }, "region": { "type": "string", "maxLength": 32, "minLength": 2, "title": "Region" }, "visibility": { "type": "string", "enum": [ "private", "public" ], "title": "Visibility", "default": "private" }, "strictResidency": { "type": "boolean", "title": "Strictresidency", "default": false }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/Delivery" }, { "type": "null" } ] }, "uploadRules": { "anyOf": [ { "$ref": "#/components/schemas/UploadRules" }, { "type": "null" } ] }, "cache": { "anyOf": [ { "$ref": "#/components/schemas/Cache" }, { "type": "null" } ] }, "cors": { "anyOf": [ { "$ref": "#/components/schemas/Cors" }, { "type": "null" } ] }, "search": { "anyOf": [ { "$ref": "#/components/schemas/SearchSettings" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "name", "region" ], "title": "BucketCreate" }, "BucketPatch": { "properties": { "visibility": { "anyOf": [ { "type": "string", "enum": [ "private", "public" ] }, { "type": "null" } ], "title": "Visibility" }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/Delivery" }, { "type": "null" } ] }, "uploadRules": { "anyOf": [ { "$ref": "#/components/schemas/UploadRules" }, { "type": "null" } ] }, "cache": { "anyOf": [ { "$ref": "#/components/schemas/Cache" }, { "type": "null" } ] }, "cors": { "anyOf": [ { "$ref": "#/components/schemas/Cors" }, { "type": "null" } ] }, "analytics": { "anyOf": [ { "$ref": "#/components/schemas/AnalyticsPatch" }, { "type": "null" } ] }, "search": { "anyOf": [ { "$ref": "#/components/schemas/SearchSettings" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "BucketPatch", "description": "Omitted = unchanged. Inside delivery, uploadRules, cache, cors and search (its folder and language) an\nexplicit null removes a clearable setting; the top-level fields always have a value, so null on them is refused." }, "Cache": { "properties": { "edgeTtlSeconds": { "anyOf": [ { "type": "integer", "maximum": 31536000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Edgettlseconds" }, "browserCacheControl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Browsercachecontrol" }, "rules": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CacheRuleIn" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Rules" } }, "additionalProperties": false, "type": "object", "title": "Cache", "description": "Clearable with null (back to plycdn's defaults): edgeTtlSeconds, browserCacheControl, rules (to\nnone). `rules`, when named, replaces the stored list as a whole." }, "CacheRuleIn": { "properties": { "pathPrefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pathprefix" }, "extensions": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1 }, { "type": "null" } ], "title": "Extensions" }, "edgeTtlSeconds": { "anyOf": [ { "type": "integer", "maximum": 31536000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Edgettlseconds" }, "browserCacheControl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Browsercachecontrol" } }, "additionalProperties": false, "type": "object", "title": "CacheRuleIn", "description": "Exactly one matcher (pathPrefix or extensions) and at least one value. Replaced as a whole." }, "CollectionFromDocuments": { "properties": { "name": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Name" }, "assetIds": { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1, "title": "Assetids" }, "asReader": { "type": "boolean", "title": "Asreader", "default": false }, "principals": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Principals" } }, "additionalProperties": false, "type": "object", "required": [ "name", "assetIds" ], "title": "CollectionFromDocuments", "description": "A new collection holding these documents, under a name you choose; its id is made for you.\n\nWith `asReader`, or any `principals`, only documents those principals may see are added." }, "CollectionMembers": { "properties": { "add": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 1000, "title": "Add" }, "remove": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 1000, "title": "Remove" } }, "additionalProperties": false, "type": "object", "title": "CollectionMembers", "description": "Membership changes for one collection.\n\nadd and remove are applied in that order, so sending the same asset in both removes it. That\nis stated rather than guarded against: a caller diffing two sets can produce the overlap\nhonestly, and the deterministic outcome is easier to reason about than a rejection." }, "CollectionUpsert": { "properties": { "externalId": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Externalid" }, "name": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Name" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": {}, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "externalId", "name" ], "title": "CollectionUpsert" }, "ConnectorUpsert": { "properties": { "kind": { "type": "string", "enum": [ "canvas", "s3", "azure_blob" ], "title": "Kind", "default": "canvas" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "config": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "items": {}, "type": "array" } ] }, "type": "object", "title": "Config" }, "credential": { "anyOf": [ { "type": "string", "maxLength": 4096, "minLength": 1 }, { "type": "null" } ], "title": "Credential" }, "schedule": { "type": "string", "enum": [ "manual", "nightly" ], "title": "Schedule", "default": "manual" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "defaultAclMode": { "type": "string", "enum": [ "open", "restricted" ], "title": "Defaultaclmode", "default": "restricted" }, "extractContentFromVideoFrames": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extractcontentfromvideoframes" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "ConnectorUpsert", "description": "A link to a system the customer already keeps content in." }, "ConversationTurn": { "properties": { "role": { "type": "string", "enum": [ "user", "assistant" ], "title": "Role" }, "text": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Text" } }, "additionalProperties": false, "type": "object", "required": [ "role", "text" ], "title": "ConversationTurn", "description": "One earlier turn of a conversation, sent by your application and never stored." }, "Correction": { "properties": { "segments": { "items": { "$ref": "#/components/schemas/SegmentEdit" }, "type": "array", "maxItems": 10000, "minItems": 1, "title": "Segments" } }, "additionalProperties": false, "type": "object", "required": [ "segments" ], "title": "Correction" }, "Cors": { "properties": { "allowedOrigins": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Allowedorigins" }, "allowedMethods": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 2, "minItems": 1 }, { "type": "null" } ], "title": "Allowedmethods" }, "allowedHeaders": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Allowedheaders" }, "exposeHeaders": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Exposeheaders" }, "maxAgeSeconds": { "anyOf": [ { "type": "integer", "maximum": 86400.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Maxageseconds" }, "allowCredentials": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allowcredentials" } }, "additionalProperties": false, "type": "object", "title": "Cors", "description": "Clearable with null (back to the defaults): allowedOrigins (to none: CORS off), allowedMethods\n(GET and HEAD), allowedHeaders and exposeHeaders (none), maxAgeSeconds (600). allowCredentials is a\nswitch: never null. `*` with credentials is refused within one body here, and across stored settings\nand a PATCH by buckets.check_cors." }, "Delivery": { "properties": { "allowedDomains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Alloweddomains" }, "blockNoReferrer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Blocknoreferrer" }, "countriesAllow": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 250 }, { "type": "null" } ], "title": "Countriesallow" }, "countriesBlock": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 250 }, { "type": "null" } ], "title": "Countriesblock" }, "linkTtlSeconds": { "anyOf": [ { "type": "integer", "maximum": 604800.0, "minimum": 60.0 }, { "type": "null" } ], "title": "Linkttlseconds" }, "ipBinding": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ipbinding" }, "rateLimitKbps": { "anyOf": [ { "type": "integer", "maximum": 10000000.0, "minimum": 64.0 }, { "type": "null" } ], "title": "Ratelimitkbps" } }, "additionalProperties": false, "type": "object", "title": "Delivery", "description": "Clearable with null: allowedDomains, countriesAllow, countriesBlock (to empty), linkTtlSeconds (to\nthe service default), rateLimitKbps (to none). blockNoReferrer and ipBinding are switches: never null." }, "DestinationCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "url": { "type": "string", "maxLength": 1024, "minLength": 8, "title": "Url" }, "key": { "type": "string", "maxLength": 512, "minLength": 1, "pattern": "^[\\x21-\\x7E]{1,512}$", "title": "Key" } }, "additionalProperties": false, "type": "object", "required": [ "name", "url", "key" ], "title": "DestinationCreate", "description": "Where a live input's stream is pushed: an rtmp(s):// address of another platform's ingest (without the key) and\nthe stream key that platform issued. The key is a credential: it is held sealed, never returned, never logged." }, "DestinationList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DestinationView" }, "type": "array", "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "DestinationList" }, "DestinationPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "url": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 8 }, { "type": "null" } ], "title": "Url" }, "key": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1, "pattern": "^[\\x21-\\x7E]{1,512}$" }, { "type": "null" } ], "title": "Key" } }, "additionalProperties": false, "type": "object", "title": "DestinationPatch", "description": "Omitted = unchanged. Changing the address or the key of a destination that is pushing restarts its push." }, "DestinationTestResult": { "properties": { "reachable": { "type": "boolean", "title": "Reachable" } }, "additionalProperties": false, "type": "object", "required": [ "reachable" ], "title": "DestinationTestResult", "description": "`reachable` is true when the platform's ingest answered the connection handshake. Nothing is published." }, "DestinationView": { "properties": { "id": { "type": "string", "title": "Id" }, "liveInputId": { "type": "string", "title": "Liveinputid" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" }, "state": { "type": "string", "enum": [ "idle", "connecting", "live", "failed" ], "title": "State" }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lasterror" }, "startedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "id", "liveInputId", "name", "url", "state", "createdAt", "updatedAt" ], "title": "DestinationView", "description": "A destination as an administrator reads it: never the key. `state` is idle, connecting, live or failed; `lastError`\nis a code (destination_unreachable, destination_refused, destination_rejected_stream, destination_dropped,\ndestination_address_forbidden) while it is failed or has been." }, "DomainCreate": { "properties": { "bucketId": { "type": "string", "format": "uuid", "title": "Bucketid" }, "hostname": { "type": "string", "maxLength": 1024, "minLength": 1, "title": "Hostname" } }, "additionalProperties": false, "type": "object", "required": [ "bucketId", "hostname" ], "title": "DomainCreate", "description": "A custom domain for a library. The hostname is normalised (case, a trailing dot, full-width forms, and an\ninternational name to its one lowercase ASCII form); whether it may be claimed (hostname_not_allowed) is decided\nwhen it is added, not as a validation error." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImportCreate": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/AssetCreate" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Assets" } }, "additionalProperties": false, "type": "object", "required": [ "assets" ], "title": "ImportCreate" }, "LibraryCreate": { "properties": { "name": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$", "title": "Name" }, "region": { "type": "string", "maxLength": 32, "minLength": 2, "title": "Region" }, "strictResidency": { "type": "boolean", "title": "Strictresidency", "default": false }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/Delivery" }, { "type": "null" } ] }, "processing": { "anyOf": [ { "$ref": "#/components/schemas/Processing" }, { "type": "null" } ] }, "maxObjectBytes": { "anyOf": [ { "type": "integer", "maximum": 1342177280000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Maxobjectbytes" }, "search": { "anyOf": [ { "$ref": "#/components/schemas/SearchSettings" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "name", "region" ], "title": "LibraryCreate", "description": "No visibility and no upload rules: a library is always private and takes only video. The\nlargest source is the one upload rule a customer chooses." }, "LibraryPatch": { "properties": { "delivery": { "anyOf": [ { "$ref": "#/components/schemas/Delivery" }, { "type": "null" } ] }, "processing": { "anyOf": [ { "$ref": "#/components/schemas/Processing" }, { "type": "null" } ] }, "maxObjectBytes": { "anyOf": [ { "type": "integer", "maximum": 1342177280000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Maxobjectbytes" }, "analytics": { "anyOf": [ { "$ref": "#/components/schemas/AnalyticsPatch" }, { "type": "null" } ] }, "search": { "anyOf": [ { "$ref": "#/components/schemas/SearchSettings" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "LibraryPatch", "description": "Omitted = unchanged. delivery always has a value (null refused); inside delivery an explicit null\nclears as on a bucket. processing: null makes the library use its organization's video settings\nagain; an object gives the library its own (the fields named merged over what it uses now).\nmaxObjectBytes: null removes the limit (the plan's applies), as uploadRules.maxObjectBytes does on a bucket." }, "LiveAdsSettings": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "vmapUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Vmapurl" }, "vastUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Vasturl" }, "slate": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Slate" }, "personalised": { "type": "boolean", "title": "Personalised", "default": false } }, "additionalProperties": false, "type": "object", "title": "LiveAdsSettings", "description": "Server-side ad insertion for the input's streams: the whole object is replaced when given. `vmapUrl` or `vastUrl`\nis where the ads of a break are asked for; `slate` the video shown where a break has no ad (a neutral picture without\none). Changes apply from the next break. Ads cannot be on together with content protection, or with a DVR window\n(`dvrWindowSeconds` above 0), on one input (`live_setting_conflict`, `detail.settings` names the two).\n\nWithout `personalised`, one decision is made per break for every viewer, and its tracking (impressions, quartiles)\nis reported once per break however many people watch: count viewers with the players' own ad events. With\n`personalised`, each viewer's ads are asked for separately, up to the stream's limit of personalised viewers (past\nit a viewer sees the shared ads), and tracked once per viewer. Such a request carries the break's length, its pod\nid, a timestamp, a cache buster and a pseudonym of the viewer's playback session; your own ad address also receives\nthe viewer's browser identification (User-Agent). Ad servers your answer passes the request on to receive the same,\nwithout the browser identification. No address or cookie of a viewer is ever sent." }, "LiveBreak": { "properties": { "id": { "type": "string", "title": "Id" }, "liveInputId": { "type": "string", "title": "Liveinputid" }, "streamId": { "type": "string", "title": "Streamid" }, "state": { "type": "string", "enum": [ "scheduled", "started", "ended", "missed" ], "title": "State" }, "durationSeconds": { "type": "number", "title": "Durationseconds" }, "requestedAt": { "type": "string", "title": "Requestedat" }, "startedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "endedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endedat" }, "podId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Podid" } }, "additionalProperties": false, "type": "object", "required": [ "id", "liveInputId", "streamId", "state", "durationSeconds", "requestedAt" ], "title": "LiveBreak", "description": "An ad break: `state` scheduled, started, ended or missed (the stream was not being packaged while it was due)." }, "LiveBreakCreate": { "properties": { "durationSeconds": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Durationseconds", "gt": 0, "le": 600 }, "at": { "anyOf": [ { "type": "string", "const": "now" }, { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "At" }, "podId": { "anyOf": [ { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,64}$" }, { "type": "null" } ], "title": "Podid" } }, "additionalProperties": false, "type": "object", "required": [ "durationSeconds" ], "title": "LiveBreakCreate", "description": "POST /live-inputs/{id}/breaks: an ad break on the input's stream, `durationSeconds` long, starting `at`\n(\"now\", the default, or a time within the next 24 hours) on the nearest segment boundary. `podId` is passed to the\nad server as the break's identifier." }, "LiveCaptionSettings": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "languages": { "items": { "type": "string", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$" }, "type": "array", "maxItems": 2, "title": "Languages" }, "mode": { "type": "string", "enum": [ "realtime", "nearLive" ], "title": "Mode", "default": "realtime" } }, "additionalProperties": false, "type": "object", "title": "LiveCaptionSettings", "description": "Captions for the input's streams. `languages` (ISO 639 codes, at most two) are checked against what the\nlibrary's region and residency offer; `mode` `realtime` (the default) or `nearLive`. A change replaces the whole\nobject, and is refused while a stream is running (live_input_busy)." }, "LiveHealthPoint": { "properties": { "at": { "type": "string", "title": "At" }, "inputKbps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inputkbps" }, "fps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fps" }, "keyframeSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Keyframeseconds" }, "speed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Speed" }, "partPushP95Ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partpushp95Ms" }, "gaps": { "type": "integer", "title": "Gaps" }, "failovers": { "type": "integer", "title": "Failovers" } }, "additionalProperties": false, "type": "object", "required": [ "at", "gaps", "failovers" ], "title": "LiveHealthPoint" }, "LiveHealthTotals": { "properties": { "gaps": { "type": "integer", "title": "Gaps" }, "failovers": { "type": "integer", "title": "Failovers" } }, "additionalProperties": false, "type": "object", "required": [ "gaps", "failovers" ], "title": "LiveHealthTotals" }, "LiveInputBrowserView": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "enum": [ "idle", "connected", "live", "disabled" ], "title": "State" }, "delivery": { "type": "string", "enum": [ "broadcast", "realtime" ], "title": "Delivery" }, "stream": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stream" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "delivery" ], "title": "LiveInputBrowserView", "description": "GET /live-inputs/{id}?view=browser: what a page may show." }, "LiveInputCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/LiveInputSettings" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "LiveInputCreate" }, "LiveInputCreated": { "properties": { "id": { "type": "string", "title": "Id" }, "libraryId": { "type": "string", "title": "Libraryid" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "enum": [ "idle", "connected", "live", "disabled" ], "title": "State" }, "streamKeyPrefix": { "type": "string", "title": "Streamkeyprefix" }, "ingest": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Ingest" }, "settings": { "additionalProperties": true, "type": "object", "title": "Settings" }, "stream": { "anyOf": [ { "$ref": "#/components/schemas/LiveStreamView" }, { "type": "null" } ] }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" }, "streamKey": { "type": "string", "title": "Streamkey" } }, "additionalProperties": false, "type": "object", "required": [ "id", "libraryId", "name", "state", "streamKeyPrefix", "ingest", "settings", "metadata", "createdAt", "updatedAt", "streamKey" ], "title": "LiveInputCreated", "description": "What create, rotate and reveal answer: the input and its `streamKey`." }, "LiveInputList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LiveInputView" }, "type": "array", "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "LiveInputList" }, "LiveInputPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/LiveInputSettings" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "additionalProperties": false, "type": "object", "title": "LiveInputPatch", "description": "Omitted = unchanged; `settings` names only what changes; a metadata object replaces the whole of it." }, "LiveInputSettings": { "properties": { "delivery": { "anyOf": [ { "type": "string", "enum": [ "broadcast", "realtime" ] }, { "type": "null" } ], "title": "Delivery" }, "quality": { "anyOf": [ { "type": "string", "enum": [ "source", "sd", "hd", "fhd" ] }, { "type": "null" } ], "title": "Quality" }, "passthrough": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passthrough" }, "recording": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recording" }, "reconnectWindowSeconds": { "anyOf": [ { "type": "integer", "maximum": 600.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Reconnectwindowseconds" }, "maxDurationSeconds": { "anyOf": [ { "type": "integer", "maximum": 2000000000.0, "minimum": 60.0 }, { "type": "null" } ], "title": "Maxdurationseconds" }, "latencyTarget": { "anyOf": [ { "type": "string", "enum": [ "lowest", "balanced" ] }, { "type": "null" } ], "title": "Latencytarget" }, "backupIngest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Backupingest" }, "redundantTranscoding": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Redundanttranscoding" }, "captions": { "anyOf": [ { "$ref": "#/components/schemas/LiveCaptionSettings" }, { "type": "null" } ] }, "dvrWindowSeconds": { "anyOf": [ { "type": "integer", "maximum": 7200.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Dvrwindowseconds" }, "indexRecording": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Indexrecording" }, "protection": { "anyOf": [ { "$ref": "#/components/schemas/ProtectionSettings" }, { "type": "null" } ] }, "ads": { "anyOf": [ { "$ref": "#/components/schemas/LiveAdsSettings" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "LiveInputSettings", "description": "Every setting is optional here: on a create the ones left out take their defaults, on a change they are\nkept. None of them is ever null." }, "LiveInputView": { "properties": { "id": { "type": "string", "title": "Id" }, "libraryId": { "type": "string", "title": "Libraryid" }, "name": { "type": "string", "title": "Name" }, "state": { "type": "string", "enum": [ "idle", "connected", "live", "disabled" ], "title": "State" }, "streamKeyPrefix": { "type": "string", "title": "Streamkeyprefix" }, "ingest": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Ingest" }, "settings": { "additionalProperties": true, "type": "object", "title": "Settings" }, "stream": { "anyOf": [ { "$ref": "#/components/schemas/LiveStreamView" }, { "type": "null" } ] }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "id", "libraryId", "name", "state", "streamKeyPrefix", "ingest", "settings", "metadata", "createdAt", "updatedAt" ], "title": "LiveInputView", "description": "A live input as an administrator reads it. `ingest` holds the rtmps, rtmp, srt and whip addresses." }, "LiveStreamCaptions": { "properties": { "streamId": { "type": "string", "title": "Streamid" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "realtime", "nearLive" ] }, { "type": "null" } ], "title": "Mode" }, "languages": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Languages" } }, "additionalProperties": false, "type": "object", "required": [ "streamId", "languages" ], "title": "LiveStreamCaptions", "description": "A stream's caption languages and the mode in force (`realtime`, or\n`nearLive` when the service downgraded it); no languages and no mode when the stream has no captions." }, "LiveStreamDetail": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "title": "State" }, "startedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "liveAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Liveat" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "renditionsVersion": { "type": "integer", "title": "Renditionsversion" }, "qualitiesComing": { "type": "boolean", "title": "Qualitiescoming", "default": false }, "realtimeViewers": { "type": "integer", "title": "Realtimeviewers", "default": 0 }, "health": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Health" }, "recordingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordingid" }, "captions": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Captions" }, "liveInputId": { "type": "string", "title": "Liveinputid" }, "endReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endreason" }, "delivery": { "type": "string", "title": "Delivery" }, "quality": { "type": "string", "title": "Quality" }, "rungs": { "items": {}, "type": "array", "title": "Rungs" }, "durationSeconds": { "type": "integer", "title": "Durationseconds" }, "disconnectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disconnectedat" }, "endedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endedat" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "renditionsVersion", "liveInputId", "delivery", "quality", "rungs", "durationSeconds" ], "title": "LiveStreamDetail", "description": "GET /streams/{id}, /live-inputs/{id}/end and a page of /live-inputs/{id}/streams. `state` is one of starting,\nlive, reconnecting, ending, ended, failed; `endReason` is one of live.ended's." }, "LiveStreamHealth": { "properties": { "streamId": { "type": "string", "title": "Streamid" }, "from": { "type": "string", "title": "From" }, "to": { "type": "string", "title": "To" }, "step": { "type": "integer", "title": "Step" }, "series": { "items": { "$ref": "#/components/schemas/LiveHealthPoint" }, "type": "array", "title": "Series" }, "totals": { "$ref": "#/components/schemas/LiveHealthTotals" } }, "additionalProperties": false, "type": "object", "required": [ "streamId", "from", "to", "step", "series", "totals" ], "title": "LiveStreamHealth", "description": "GET /streams/{id}/health: the stream's health minute by minute, grouped by `step` seconds. A value is null when\nnothing reported it in that step. Kept 30 days." }, "LiveStreamList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LiveStreamDetail" }, "type": "array", "title": "Items" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "LiveStreamList" }, "LiveStreamView": { "properties": { "id": { "type": "string", "title": "Id" }, "state": { "type": "string", "title": "State" }, "startedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "liveAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Liveat" }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" }, "renditionsVersion": { "type": "integer", "title": "Renditionsversion" }, "qualitiesComing": { "type": "boolean", "title": "Qualitiescoming", "default": false }, "realtimeViewers": { "type": "integer", "title": "Realtimeviewers", "default": 0 }, "health": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Health" }, "recordingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recordingid" }, "captions": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Captions" } }, "additionalProperties": false, "type": "object", "required": [ "id", "state", "renditionsVersion" ], "title": "LiveStreamView", "description": "The open stream of a live input as an administrator reads it (the browser view keeps id, state, startedAt,\nliveAt, renditionsVersion and qualitiesComing only). `qualitiesComing`: on air in its original quality while the\nother qualities are being prepared (they are added on their own, players pick them up)." }, "LiveStreamViewers": { "properties": { "streamId": { "type": "string", "title": "Streamid" }, "from": { "type": "string", "title": "From" }, "to": { "type": "string", "title": "To" }, "step": { "type": "integer", "title": "Step" }, "peakConcurrent": { "type": "integer", "title": "Peakconcurrent" }, "viewerMinutes": { "type": "number", "title": "Viewerminutes" }, "countries": { "items": { "$ref": "#/components/schemas/LiveViewerCountry" }, "type": "array", "title": "Countries" }, "series": { "items": { "$ref": "#/components/schemas/LiveViewerPoint" }, "type": "array", "title": "Series" }, "broadcastCounted": { "type": "boolean", "title": "Broadcastcounted" } }, "additionalProperties": false, "type": "object", "required": [ "streamId", "from", "to", "step", "peakConcurrent", "viewerMinutes", "countries", "series", "broadcastCounted" ], "title": "LiveStreamViewers", "description": "GET /streams/{id}/viewers. `from`, `to` and `step` (seconds) are what the series covers; `peakConcurrent` is the most\nviewers in one minute, `viewerMinutes` the watch time, `countries` the viewer-minutes by country (broadcast viewers).\n`broadcastCounted` is false when the library has delivery analytics off: broadcast viewers are counted from its delivery\nlog, so only real-time viewers appear." }, "LiveViewerCountry": { "properties": { "country": { "type": "string", "title": "Country" }, "viewerMinutes": { "type": "integer", "title": "Viewerminutes" } }, "additionalProperties": false, "type": "object", "required": [ "country", "viewerMinutes" ], "title": "LiveViewerCountry" }, "LiveViewerPoint": { "properties": { "at": { "type": "string", "title": "At" }, "viewers": { "type": "integer", "title": "Viewers" }, "broadcast": { "type": "integer", "title": "Broadcast" }, "realtime": { "type": "integer", "title": "Realtime" }, "viewerMinutes": { "type": "number", "title": "Viewerminutes" } }, "additionalProperties": false, "type": "object", "required": [ "at", "viewers", "broadcast", "realtime", "viewerMinutes" ], "title": "LiveViewerPoint" }, "MetadataUpdate": { "properties": { "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": {}, "type": "array" } ] }, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "title": "MetadataUpdate" }, "ObjectPatch": { "properties": { "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "metadata" ], "title": "ObjectPatch", "description": "An object's metadata, replaced as a whole: at most 64 keys, each value a string, number, boolean\nor null, and at most 8 KiB as JSON." }, "OrganizationSettings": { "properties": { "sourceHosts": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 200 }, { "type": "null" } ], "title": "Sourcehosts" }, "callbackUrl": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Callbackurl" }, "callbackSecret": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 32 }, { "type": "null" } ], "title": "Callbacksecret" }, "dailyBudgetUsd": { "anyOf": [ { "type": "number", "maximum": 1000000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Dailybudgetusd" }, "dailyAudioHours": { "anyOf": [ { "type": "number", "maximum": 100000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Dailyaudiohours" }, "requireAcl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requireacl" }, "searchLogDays": { "anyOf": [ { "type": "integer", "maximum": 3650.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Searchlogdays" }, "extractContentFromVideoFrames": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extractcontentfromvideoframes" }, "videoDefaults": { "anyOf": [ { "$ref": "#/components/schemas/VideoDefaults" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "OrganizationSettings", "description": "Settings an organization may set for itself or one of its sub-organizations.\n\nEvery field is optional and a null one is inherited from the parent organization, then from\nthe deployment default - so a sub-organization can override just its storage host." }, "PermissionUpdate": { "properties": { "mode": { "type": "string", "enum": [ "open", "restricted" ], "title": "Mode" }, "principals": { "items": { "type": "string" }, "type": "array", "maxItems": 5000, "title": "Principals" } }, "additionalProperties": false, "type": "object", "required": [ "mode" ], "title": "PermissionUpdate", "description": "Who may see this asset.\n\nmode 'open' discards any principals on the asset and makes it visible to every caller for the\norganization. mode 'restricted' replaces the grant list wholesale - it is a PUT, not a PATCH,\nbecause a connector re-syncing a source system holds the authoritative list and incremental\ngrant/revoke would silently retain a permission the source has already removed." }, "PinRule": { "properties": { "query": { "type": "string", "maxLength": 400, "minLength": 1, "title": "Query" }, "assetIds": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 10, "title": "Assetids" } }, "additionalProperties": false, "type": "object", "required": [ "query", "assetIds" ], "title": "PinRule", "description": "For this exact query, put these files first, in this order." }, "Processing": { "properties": { "ladder": { "anyOf": [ { "items": { "type": "integer", "enum": [ 240, 360, 480, 720, 1080, 1440, 2160 ] }, "type": "array", "maxItems": 7, "minItems": 1 }, { "type": "null" } ], "title": "Ladder" }, "keepOriginal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Keeporiginal" }, "download": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Download" }, "thumbnails": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Thumbnails" } }, "additionalProperties": false, "type": "object", "title": "Processing", "description": "How a library encodes, when it has its own settings. Omit `processing` on a create to use the\norganization's. A field left out takes the organization's value as it is when saved; an explicit\nnull is refused; a PATCH merges the fields it names." }, "ProtectionSettings": { "properties": { "provider": { "type": "string", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9-]{0,62}$", "title": "Provider" }, "options": { "patternProperties": { "^[A-Za-z][A-Za-z0-9_.-]{0,63}$": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" } ] } }, "type": "object", "maxProperties": 16, "title": "Options" } }, "additionalProperties": false, "type": "object", "required": [ "provider" ], "title": "ProtectionSettings", "description": "Content protection for the streams of an input: the name of a protection setup available to your account, and\nits options. `\"none\"` switches protection off. Applies from the next stream. Options are settings, shown to the\naccount's administrators: an option that is a credential is given as a `vault:` reference, never its value." }, "PublishToken": { "properties": { "token": { "type": "string", "title": "Token" }, "expiresAt": { "type": "string", "title": "Expiresat" }, "whipUrl": { "type": "string", "title": "Whipurl" } }, "additionalProperties": false, "type": "object", "required": [ "token", "expiresAt", "whipUrl" ], "title": "PublishToken", "description": "The answer to a publish-token request: everything a browser needs to start going live, so it derives\nnothing. `token` is `lpt1.{inputId}.{expires}.{signature}.{nonce}` (expires in whole seconds since 1970)." }, "PublishTokenCreate": { "properties": { "ttlSeconds": { "type": "integer", "maximum": 3600.0, "minimum": 1.0, "title": "Ttlseconds", "default": 900 } }, "additionalProperties": false, "type": "object", "title": "PublishTokenCreate", "description": "How long a browser may start going live with the token: up to an hour." }, "PurgeRequest": { "properties": { "urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100, "minItems": 1 }, { "type": "null" } ], "title": "Urls" }, "prefixes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1 }, { "type": "null" } ], "title": "Prefixes" }, "all": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "All" } }, "additionalProperties": false, "type": "object", "title": "PurgeRequest" }, "Rule": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "enum": [ "pathSegment", "queryParam", "tag", "pattern" ], "title": "Type" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Param" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag" }, "pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pattern" } }, "additionalProperties": false, "type": "object", "required": [ "name", "type" ], "title": "Rule" }, "SearchFilter": { "properties": { "collections": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Collections" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": {}, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "externalIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Externalids" }, "assetIds": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 10000 }, { "type": "null" } ], "title": "Assetids" }, "createdAfter": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdafter" }, "createdBefore": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Createdbefore" }, "speaker": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Speaker" }, "language": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Language" } }, "additionalProperties": false, "type": "object", "title": "SearchFilter", "description": "Narrowing, applied before anything is ranked.\n\nEvery field is optional and they combine with AND, which is the reading a caller expects from\na form full of dropdowns. Anything richer - OR across different fields, negation, nesting -\nis deliberately absent: it would need a parser, and a parser is where filter grammars start\naccepting things the index cannot serve and the query planner starts choosing sequential scans\non a partition holding millions of rows." }, "SearchRequest": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "video", "audio", "document" ] }, { "type": "null" } ], "title": "Kind" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 20 }, "offset": { "type": "integer", "maximum": 200.0, "minimum": 0.0, "title": "Offset", "default": 0 }, "filter": { "anyOf": [ { "$ref": "#/components/schemas/SearchFilter" }, { "type": "null" } ] }, "principals": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 1000 }, { "type": "null" } ], "title": "Principals" }, "group": { "anyOf": [ { "type": "string", "const": "file" }, { "type": "null" } ], "title": "Group" }, "within": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchStep" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Within" }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "title": "Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "SearchRequest" }, "SearchSettings": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "folder": { "anyOf": [ { "type": "string", "maxLength": 1023, "minLength": 1 }, { "type": "null" } ], "title": "Folder" }, "access": { "anyOf": [ { "type": "string", "enum": [ "open", "restricted" ] }, { "type": "null" } ], "title": "Access" }, "slides": { "anyOf": [ { "type": "string", "enum": [ "inherit", "on", "off" ] }, { "type": "null" } ], "title": "Slides" }, "language": { "anyOf": [ { "type": "string", "maxLength": 16, "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8}){0,2}$" }, { "type": "null" } ], "title": "Language" }, "includePastRecordings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Includepastrecordings" } }, "additionalProperties": false, "type": "object", "title": "SearchSettings", "description": "Whether the files of a bucket (the videos and recordings of a video library) are searchable, and how. A change\nmerges the fields it names. `folder` (only files under it; null: the whole bucket) and `language` (null: detected\npassage by passage) are cleared with null; `enabled`, `access` and `slides` always have a value. `access` is who\ncan find newly added files: everyone in the organization (`open`) or only those granted them (`restricted`).\n`slides` reads text shown on screen in videos: as the organization's setting says, always, or never.\n`includePastRecordings` (video libraries only): when search is turned on, recordings finished before then are\nmade searchable too." }, "SearchStep": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "filter": { "anyOf": [ { "$ref": "#/components/schemas/SearchFilter" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "SearchStep", "description": "One earlier search to narrow within: its words, and optionally a filter that narrows only this step." }, "SegmentEdit": { "properties": { "id": { "type": "string", "title": "Id" }, "text": { "type": "string", "maxLength": 20000, "title": "Text" } }, "additionalProperties": false, "type": "object", "required": [ "id", "text" ], "title": "SegmentEdit" }, "ShareLinkCreate": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Label" }, "password": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 4 }, { "type": "null" } ], "title": "Password" }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" }, "showRecording": { "type": "boolean", "title": "Showrecording", "default": true }, "title": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Description" }, "messages": { "anyOf": [ { "$ref": "#/components/schemas/WatchMessages" }, { "type": "null" } ] }, "layout": { "anyOf": [ { "type": "string", "enum": [ "cinema", "standard", "side_panel" ] }, { "type": "null" } ], "title": "Layout" } }, "additionalProperties": false, "type": "object", "title": "ShareLinkCreate", "description": "A watch link of a live input: an optional `label` (for the streamer), `password` (4 to 128 characters, asked of\nevery viewer), `expiresAt` (in the future) and `showRecording` (after the stream ends, the link plays its recording;\non by default)." }, "ShareLinkList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ShareLinkView" }, "type": "array", "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "ShareLinkList" }, "ShareLinkPatch": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Label" }, "password": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 4 }, { "type": "null" } ], "title": "Password" }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" }, "showRecording": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Showrecording" }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled" }, "title": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Description" }, "messages": { "anyOf": [ { "$ref": "#/components/schemas/WatchMessages" }, { "type": "null" } ] }, "layout": { "anyOf": [ { "type": "string", "enum": [ "cinema", "standard", "side_panel" ] }, { "type": "null" } ], "title": "Layout" } }, "additionalProperties": false, "type": "object", "title": "ShareLinkPatch", "description": "Omitted = unchanged. `password` and `expiresAt` null remove them; `disabled` stops (or restores) the link." }, "ShareLinkView": { "properties": { "id": { "type": "string", "title": "Id" }, "liveInputId": { "type": "string", "title": "Liveinputid" }, "url": { "type": "string", "title": "Url" }, "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "hasPassword": { "type": "boolean", "title": "Haspassword" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "showRecording": { "type": "boolean", "title": "Showrecording" }, "disabled": { "type": "boolean", "title": "Disabled" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "messages": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Messages" }, "layout": { "anyOf": [ { "type": "string", "enum": [ "cinema", "standard", "side_panel" ] }, { "type": "null" } ], "title": "Layout" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "id", "liveInputId", "url", "urls", "hasPassword", "showRecording", "disabled", "createdAt", "updatedAt" ], "title": "ShareLinkView", "description": "A watch link as its streamer reads it: the `url` to share, whether it has a password (never the password), its\nexpiry, whether it shows the recording, and whether it is disabled." }, "SignRequest": { "properties": { "bucketId": { "type": "string", "format": "uuid", "title": "Bucketid" }, "key": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "title": "Key" }, "objectId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Objectid" }, "ttlSeconds": { "anyOf": [ { "type": "integer", "maximum": 604800.0, "minimum": 60.0 }, { "type": "null" } ], "title": "Ttlseconds" }, "ip": { "anyOf": [ { "type": "string", "format": "ipvanyaddress" }, { "type": "null" } ], "title": "Ip" }, "hostname": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "title": "Hostname" }, "videoId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Videoid" }, "tags": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Tags" }, "liveInputId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Liveinputid" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "broadcast", "realtime" ] }, { "type": "null" } ], "title": "Mode" } }, "additionalProperties": false, "type": "object", "required": [ "bucketId" ], "title": "SignRequest", "description": "One stored object, by key or by id, or one video of a library by videoId (exactly one). `ip` is the viewer's IPv4 address the link is\nbound to: required on a bucket whose delivery binds links (an IPv4-mapped IPv6 address counts as\nits IPv4 form; any other IPv6 address is refused), and refused on any other bucket." }, "SourceAccess": { "properties": { "url": { "type": "string", "maxLength": 8192, "title": "Url" }, "sasToken": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Sastoken" } }, "additionalProperties": false, "type": "object", "required": [ "url" ], "title": "SourceAccess" }, "StorageAccountCreate": { "properties": { "name": { "type": "string", "pattern": "^[a-z0-9]{3,24}$", "title": "Name" }, "homeRegion": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Homeregion" } }, "additionalProperties": false, "type": "object", "required": [ "name", "homeRegion" ], "title": "StorageAccountCreate" }, "StorageAccountUpdate": { "properties": { "homeRegion": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Homeregion" } }, "additionalProperties": false, "type": "object", "required": [ "homeRegion" ], "title": "StorageAccountUpdate" }, "StorageCredentialCreate": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" }, "kind": { "type": "string", "enum": [ "s3", "azure" ], "title": "Kind" }, "permissions": { "items": { "type": "string", "enum": [ "read", "write", "delete", "manage" ] }, "type": "array", "maxItems": 4, "minItems": 1, "title": "Permissions" }, "bucketIds": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Bucketids" }, "expiresAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiresat" } }, "additionalProperties": false, "type": "object", "required": [ "name", "kind", "permissions" ], "title": "StorageCredentialCreate" }, "SynonymRule": { "properties": { "term": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Term" }, "expansions": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Expansions" } }, "additionalProperties": false, "type": "object", "required": [ "term", "expansions" ], "title": "SynonymRule", "description": "One term and what it should also match.\n\nOne-directional on purpose. \"viva\" expanding to \"oral examination\" does not imply that someone\nsearching for \"oral examination\" wants every mention of a viva - the relationship customers\nactually have in mind is usually \"our word for the standard term\", and inferring the reverse\nputs words into their content that they never asked for." }, "UploadCreate": { "properties": { "key": { "type": "string", "maxLength": 1024, "minLength": 1, "title": "Key" }, "size": { "type": "integer", "maximum": 10995116277760.0, "minimum": 0.0, "title": "Size" }, "contentType": { "type": "string", "maxLength": 255, "minLength": 3, "pattern": "^[a-z0-9.+-]+/[a-z0-9.+-]+(;[\\x20-\\x7e]*)?$", "title": "Contenttype" }, "sha256": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "Sha256" } }, "additionalProperties": false, "type": "object", "required": [ "key", "size", "contentType" ], "title": "UploadCreate" }, "UploadRules": { "properties": { "maxObjectBytes": { "anyOf": [ { "type": "integer", "maximum": 1342177280000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Maxobjectbytes" }, "allowedTypes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Allowedtypes" }, "allowOverwrite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allowoverwrite" } }, "additionalProperties": false, "type": "object", "title": "UploadRules", "description": "Clearable with null: maxObjectBytes (to the plan's limit), allowedTypes (to any). allowOverwrite is a\nswitch: never null." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VideoCreate": { "properties": { "title": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Title" }, "size": { "type": "integer", "maximum": 1342177280000.0, "minimum": 1.0, "title": "Size" }, "contentType": { "type": "string", "pattern": "^video/[a-z0-9.+-]+$", "title": "Contenttype" }, "sha256": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "Sha256" }, "fileName": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "^[^/\\\\\\x00-\\x1f]+$" }, { "type": "null" } ], "title": "Filename" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "title", "size", "contentType" ], "title": "VideoCreate", "description": "A video and the upload that brings its source (POST /libraries/{id}/videos)." }, "VideoDefaults": { "properties": { "ladder": { "anyOf": [ { "items": { "type": "integer", "enum": [ 240, 360, 480, 720, 1080, 1440, 2160 ] }, "type": "array", "maxItems": 7, "minItems": 1 }, { "type": "null" } ], "title": "Ladder" }, "keepOriginal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Keeporiginal" }, "download": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Download" }, "thumbnails": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Thumbnails" } }, "additionalProperties": false, "type": "object", "title": "VideoDefaults", "description": "Video encoding defaults of an organization. Every field is optional and a null one is not set\nhere: a sub-organization then uses its parent's, then the platform's. The fields are the library's\nown processing fields." }, "VideoPatch": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "additionalProperties": false, "type": "object", "title": "VideoPatch", "description": "Omitted = unchanged. `title` always has a value (null refused); `\"metadata\": null` empties the\nmetadata; a metadata object replaces the whole of it." }, "WatchBrandPut": { "properties": { "accentColor": { "anyOf": [ { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, { "type": "null" } ], "title": "Accentcolor" }, "backgroundColor": { "anyOf": [ { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, { "type": "null" } ], "title": "Backgroundcolor" }, "theme": { "anyOf": [ { "type": "string", "enum": [ "dark", "light" ] }, { "type": "null" } ], "title": "Theme" }, "layout": { "anyOf": [ { "type": "string", "enum": [ "cinema", "standard", "side_panel" ] }, { "type": "null" } ], "title": "Layout" }, "title": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Description" }, "messages": { "anyOf": [ { "$ref": "#/components/schemas/WatchMessages" }, { "type": "null" } ] }, "siteUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Siteurl" }, "siteLabel": { "anyOf": [ { "type": "string", "maxLength": 40, "minLength": 1 }, { "type": "null" } ], "title": "Sitelabel" }, "footerLinks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WatchFooterLink" }, "type": "array", "maxItems": 3 }, { "type": "null" } ], "title": "Footerlinks" }, "logoSize": { "anyOf": [ { "type": "string", "enum": [ "small", "medium", "large" ] }, { "type": "null" } ], "title": "Logosize" } }, "additionalProperties": false, "type": "object", "title": "WatchBrandPut", "description": "The organization's watch-page brand. A field left out is kept; null returns it to the default." }, "WatchBrandView": { "properties": { "accentColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accentcolor" }, "backgroundColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backgroundcolor" }, "theme": { "type": "string", "enum": [ "dark", "light" ], "title": "Theme" }, "layout": { "type": "string", "enum": [ "cinema", "standard", "side_panel" ], "title": "Layout" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "messages": { "additionalProperties": true, "type": "object", "title": "Messages" }, "siteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Siteurl" }, "siteLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sitelabel" }, "footerLinks": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Footerlinks" }, "logoSize": { "anyOf": [ { "type": "string", "enum": [ "small", "medium", "large" ] }, { "type": "null" } ], "title": "Logosize" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logourl" }, "inherited": { "type": "boolean", "title": "Inherited" } }, "additionalProperties": false, "type": "object", "required": [ "theme", "layout", "messages", "footerLinks", "inherited" ], "title": "WatchBrandView", "description": "The brand as read: its fields, `logoUrl` (null without a logo) and `inherited` (read from the parent account)." }, "WatchDomainCreate": { "properties": { "hostname": { "type": "string", "maxLength": 1024, "minLength": 1, "title": "Hostname" } }, "additionalProperties": false, "type": "object", "required": [ "hostname" ], "title": "WatchDomainCreate", "description": "A watch domain: a hostname of the customer's (normalised as a custom domain's is)." }, "WatchDomainList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WatchDomainView" }, "type": "array", "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "WatchDomainList" }, "WatchDomainRecord": { "properties": { "type": { "type": "string", "enum": [ "CNAME", "TXT" ], "title": "Type" }, "name": { "type": "string", "title": "Name" }, "value": { "type": "string", "title": "Value" }, "purpose": { "type": "string", "title": "Purpose" }, "status": { "type": "string", "enum": [ "found", "missing", "elsewhere", "unknown" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "type", "name", "value", "purpose", "status" ], "title": "WatchDomainRecord", "description": "A DNS record the customer publishes: what it is for (`purpose`) and what the last check saw (`status`: found,\nmissing, elsewhere or unknown)." }, "WatchDomainView": { "properties": { "id": { "type": "string", "title": "Id" }, "hostname": { "type": "string", "title": "Hostname" }, "unicodeHostname": { "type": "string", "title": "Unicodehostname" }, "kind": { "type": "string", "enum": [ "subdomain", "apex" ], "title": "Kind" }, "state": { "type": "string", "enum": [ "pending_dns", "verifying", "issuing_certificate", "active", "failed", "detached" ], "title": "State" }, "failureReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failurereason" }, "cnameTarget": { "type": "string", "title": "Cnametarget" }, "records": { "items": { "$ref": "#/components/schemas/WatchDomainRecord" }, "type": "array", "title": "Records" }, "verification": { "additionalProperties": true, "type": "object", "title": "Verification" }, "lastCheckedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastcheckedat" }, "nextCheckAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcheckat" }, "activeAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activeat" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "id", "hostname", "unicodeHostname", "kind", "state", "cnameTarget", "records", "verification", "createdAt", "updatedAt" ], "title": "WatchDomainView", "description": "A watch domain: its kind (a subdomain; `apex` only for one added before apexes were refused), its state (as a\ncustom domain's), the DNS records to publish (`records`, also in `verification` with the checks), and when it was\nand will next be checked." }, "WatchFooterLink": { "properties": { "label": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Label" }, "url": { "type": "string", "maxLength": 2048, "minLength": 9, "title": "Url" } }, "additionalProperties": false, "type": "object", "required": [ "label", "url" ], "title": "WatchFooterLink" }, "WatchMessages": { "properties": { "starting": { "anyOf": [ { "type": "string", "maxLength": 300, "minLength": 1 }, { "type": "null" } ], "title": "Starting" }, "ended": { "anyOf": [ { "type": "string", "maxLength": 300, "minLength": 1 }, { "type": "null" } ], "title": "Ended" }, "password": { "anyOf": [ { "type": "string", "maxLength": 300, "minLength": 1 }, { "type": "null" } ], "title": "Password" } }, "additionalProperties": false, "type": "object", "title": "WatchMessages", "description": "What the watch page says before the stream, after it, and when it asks for a password (300 characters each)." }, "WebhookCreate": { "properties": { "url": { "type": "string", "maxLength": 2048, "pattern": "^https://[^\\s/?#]+(/[^\\s]*)?$", "title": "Url" }, "events": { "items": { "type": "string", "enum": [ "video.playable", "video.ready", "video.failed", "live.connected", "live.started", "live.disconnected", "live.ended", "live.failover", "live.destination_failed", "live.ad_break" ] }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Events" }, "description": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Description" } }, "additionalProperties": false, "type": "object", "required": [ "url", "events" ], "title": "WebhookCreate" }, "WebhookPatch": { "properties": { "url": { "anyOf": [ { "type": "string", "maxLength": 2048, "pattern": "^https://[^\\s/?#]+(/[^\\s]*)?$" }, { "type": "null" } ], "title": "Url" }, "events": { "anyOf": [ { "items": { "type": "string", "enum": [ "video.playable", "video.ready", "video.failed", "live.connected", "live.started", "live.disconnected", "live.ended", "live.failover", "live.destination_failed", "live.ad_break" ] }, "type": "array", "maxItems": 20, "minItems": 1 }, { "type": "null" } ], "title": "Events" }, "description": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Description" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, "additionalProperties": false, "type": "object", "title": "WebhookPatch", "description": "Omitted = unchanged; \"description\": null removes the description. url, events and active always\nhave a value, so null on them is refused." } }, "securitySchemes": { "PlycdnApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Use Authorization: ApiKey YOUR_EXISTING_KEY. Keep the key in your backend." } } }, "security": [ { "PlycdnApiKey": [] } ] }