{ "components": { "parameters": { "Cursor": { "description": "Opaque pagination cursor.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, "IdempotencyKey": { "description": "Required only when an operation declares idempotency support.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } }, "IfMatch": { "description": "Expected revision when an operation declares concurrency support.", "in": "header", "name": "If-Match", "required": false, "schema": { "type": "string" } }, "ProjectReference": { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } }, "responses": { "BadRequest": { "content": { "application/json": { "example": { "error": { "code": "validation_failed", "message": "The request could not be processed.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The request could not be processed." }, "Conflict": { "content": { "application/json": { "example": { "error": { "code": "revision_conflict", "current_revision": "revision-2", "message": "The resource changed after the supplied revision.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The request conflicts with current state, revision, idempotency, or canonical replacement." }, "Forbidden": { "content": { "application/json": { "example": { "error": { "code": "forbidden", "message": "The token, role, entitlement, or object policy denies this action.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The token, role, entitlement, or object policy denies this action." }, "NotFound": { "content": { "application/json": { "example": { "error": { "code": "not_found", "message": "The resource was not found or is not visible.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The resource was not found or is not visible." }, "RateLimited": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "message": "The request exceeded a rate limit.", "retryable": true } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The request exceeded a rate limit." }, "TemporaryFailure": { "content": { "application/json": { "example": { "error": { "code": "temporary_failure", "message": "The service is temporarily unavailable.", "retryable": true } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "The service is temporarily unavailable." }, "Unauthorized": { "content": { "application/json": { "example": { "error": { "code": "unauthenticated", "message": "Authentication is required.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "Authentication is required." }, "ValidationFailed": { "content": { "application/json": { "example": { "error": { "code": "validation_failed", "message": "One or more request fields are invalid.", "retryable": false } }, "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } }, "description": "One or more request fields are invalid." } }, "schemas": { "AddChannelCompetitorRequest": { "additionalProperties": false, "properties": { "identifier": { "maxLength": 255, "type": "string" } }, "required": [ "identifier" ], "type": "object" }, "AddChannelCompetitorResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channel_id": { "type": "integer" }, "competitor": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "handle": { "type": "string" }, "title": { "type": "string" } }, "required": [ "channel_id", "handle", "title" ], "type": "object" } }, "required": [ "channel_id", "competitor" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "AddThumbnailBoardImagesRequest": { "additionalProperties": false, "properties": { "label": { "maxLength": 80, "type": [ "string", "null" ] }, "source": { "enum": [ "my_recent", "my_top_viewed", "my_top_outlier", "urls" ], "type": "string" }, "urls": { "items": { "format": "uri", "type": "string" }, "maxItems": 12, "type": "array" }, "usage": { "enum": [ "creator_face", "style", "product", "background", "screenshot", null ], "type": [ "string", "null" ] } }, "required": [ "source" ], "type": "object" }, "AddThumbnailBoardImagesResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ThumbnailBoardItem" }, "type": "array" } }, "required": [ "board_id", "items" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "AssignThumbnailBoardImageRequest": { "additionalProperties": false, "properties": { "item_id": { "type": "integer" }, "script_id": { "type": "integer" } }, "required": [ "item_id", "script_id" ], "type": "object" }, "AssignThumbnailBoardImageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attachment_id": { "type": "integer" }, "script_id": { "type": "integer" }, "thumbnail_url": { "format": "uri", "type": "string" }, "warning": { "description": "Present only when the item carried text or shape layers that could not be flattened onto it, so the bare image was assigned.", "type": "string" } }, "required": [ "script_id", "attachment_id", "thumbnail_url" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "BoundedListMeta": { "additionalProperties": false, "properties": { "truncated": { "type": "boolean" } }, "required": [ "truncated" ], "type": "object" }, "CancelScriptAgentRunResponse": { "additionalProperties": true, "properties": { "cancelled": { "type": "boolean" }, "message": { "type": "string" }, "refunded": { "type": "boolean" }, "run_id": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "cancelled", "run_id", "status", "refunded", "message" ], "type": "object" }, "ChangeIdeaTopicRequest": { "additionalProperties": false, "properties": { "topic": { "maxLength": 5000, "minLength": 3, "type": "string" } }, "required": [ "topic" ], "type": "object" }, "ChangeIdeaTopicResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "idea_id": { "type": "integer" } }, "required": [ "idea_id" ], "type": "object" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message", "data" ], "type": "object" }, "CommitVoiceProfileRequest": { "additionalProperties": false, "properties": { "profile": { "$ref": "#/components/schemas/VoiceProfileV2" }, "receipt": { "maxLength": 160, "minLength": 20, "type": "string" } }, "required": [ "receipt", "profile" ], "type": "object" }, "CreateApiTokenRequest": { "additionalProperties": false, "properties": { "abilities": { "items": { "enum": [ "intel:read", "intel:write", "scripts:read", "scripts:write", "thumbnails:read", "thumbnails:write", "channels:read", "webhooks:read", "webhooks:write" ], "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "name", "abilities" ], "type": "object" }, "CreateApiTokenResponse": { "additionalProperties": true, "properties": { "token": { "additionalProperties": true, "properties": { "abilities": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "integer" }, "name": { "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "name", "abilities", "token" ], "type": "object" } }, "required": [ "token" ], "type": "object" }, "CreateChannelIdeaRequest": { "additionalProperties": false, "properties": { "angle": { "maxLength": 1000, "type": "string" }, "notes": { "maxLength": 2000, "type": "string" }, "suggested_length": { "maximum": 20000, "minimum": 200, "type": "integer" }, "suggested_template_id": { "minimum": 1, "type": "integer" }, "thumbnail_concept": { "maxLength": 1000, "type": "string" }, "title": { "maxLength": 255, "type": "string" }, "topic": { "maxLength": 5000, "type": "string" } }, "required": [ "title" ], "type": "object" }, "CreateChannelIdeaResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "angle": { "type": [ "string", "null" ] }, "channel_id": { "type": "integer" }, "id": { "type": "integer" }, "notes": { "type": [ "string", "null" ] }, "outlier_score": { "type": [ "number", "null" ] }, "script_id": { "type": [ "integer", "null" ] }, "source_type": { "type": "string" }, "status": { "type": "string" }, "suggested_length": { "type": [ "integer", "null" ] }, "suggested_template_id": { "type": [ "integer", "null" ] }, "thumbnail_concept": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "topic": { "type": [ "string", "null" ] } }, "required": [ "id", "channel_id", "title", "topic", "angle", "suggested_length", "suggested_template_id", "status", "script_id", "source_type", "thumbnail_concept", "outlier_score", "notes" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "CreateChannelScriptRequest": { "additionalProperties": false, "properties": { "angle": { "maxLength": 1000, "type": [ "string", "null" ] }, "language": { "maxLength": 50, "type": [ "string", "null" ] }, "length": { "description": "Target script length in words. Minimum is 200 for standard templates; 50 for shorts_* templates (30-60 second content).", "maximum": 20000, "minimum": 50, "type": "integer" }, "prompt": { "maxLength": 8000, "type": [ "string", "null" ] }, "research_texts": { "items": { "maxLength": 5000, "type": "string" }, "maxItems": 10, "type": [ "array", "null" ] }, "research_urls": { "items": { "maxLength": 500, "type": "string" }, "maxItems": 10, "type": [ "array", "null" ] }, "template_id": { "minimum": 1, "type": [ "integer", "null" ] }, "title": { "maxLength": 255, "type": "string" }, "topic": { "maxLength": 5000, "minLength": 10, "type": "string" }, "voice": { "maxLength": 100, "type": [ "string", "null" ] }, "voice_id": { "minimum": 1, "type": [ "integer", "null" ] } }, "required": [ "title", "topic", "length" ], "type": "object" }, "CreateChannelScriptResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "canvas_url": { "format": "uri", "type": "string" }, "script_id": { "type": "integer" }, "script_number": { "type": "integer" }, "status": { "type": "string" }, "thread_id": { "type": "integer" } }, "required": [ "script_id", "script_number", "thread_id", "status", "canvas_url" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "CreateIdeaProjectRequest": { "additionalProperties": false, "properties": { "channel_id": { "type": "integer" }, "source": { "const": "idea", "type": "string" }, "stage": { "$ref": "#/components/schemas/ProjectIdeaStageInput" }, "title": { "type": "string" } }, "required": [ "channel_id", "source", "title", "stage" ], "type": "object" }, "CreateIntelBookmarkRequest": { "additionalProperties": false, "properties": { "external_id": { "type": "string" }, "notes": { "maxLength": 1000, "type": "string" }, "tags": { "items": { "maxLength": 50, "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "type": { "enum": [ "channel", "video" ], "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "type", "external_id", "title", "url" ], "type": "object" }, "CreateIntelBookmarkResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "external_id": { "type": "string" }, "id": { "type": "integer" }, "notes": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "type", "external_id", "title", "url", "notes", "tags" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "CreateProjectCommentRequest": { "additionalProperties": false, "properties": { "body": { "maxLength": 20000, "minLength": 1, "type": "string" }, "mentioned_user_ids": { "items": { "minimum": 1, "type": "integer" }, "maxItems": 50, "type": "array", "uniqueItems": true } }, "required": [ "body" ], "type": "object" }, "CreateProjectRequest": { "discriminator": { "mapping": { "idea": "#/components/schemas/CreateIdeaProjectRequest", "script": "#/components/schemas/CreateScriptProjectRequest" }, "propertyName": "source" }, "oneOf": [ { "$ref": "#/components/schemas/CreateIdeaProjectRequest" }, { "$ref": "#/components/schemas/CreateScriptProjectRequest" } ] }, "CreateScriptProjectRequest": { "additionalProperties": false, "properties": { "channel_id": { "type": "integer" }, "source": { "const": "script", "type": "string" }, "stage": { "$ref": "#/components/schemas/ProjectScriptStageInput" }, "title": { "type": "string" } }, "required": [ "channel_id", "source", "title", "stage" ], "type": "object" }, "CreateTemplateRequest": { "additionalProperties": false, "properties": { "description": { "maxLength": 500, "type": [ "string", "null" ] }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "prompt": { "maxLength": 20000, "minLength": 100, "type": "string" } }, "required": [ "name", "prompt" ], "type": "object" }, "CreateThumbnailBoardGenerationRequest": { "additionalProperties": false, "properties": { "allow_text": { "default": false, "type": "boolean" }, "prompt": { "maxLength": 2000, "minLength": 3, "type": "string" }, "reference_item_ids": { "items": { "type": "integer" }, "maxItems": 6, "type": "array" }, "variations": { "default": 2, "maximum": 8, "minimum": 1, "type": "integer" } }, "required": [ "prompt" ], "type": "object" }, "CreateThumbnailBoardGenerationResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": "integer" }, "credits_remaining": { "type": "integer" }, "credits_spent": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ThumbnailBoardItem" }, "type": "array" }, "note": { "type": "string" } }, "required": [ "board_id", "credits_spent", "credits_remaining", "items", "note" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "CreateThumbnailGenerationRequest": { "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "prompt" ] }, { "required": [ "idea_id" ] }, { "required": [ "clone_strategy" ] }, { "required": [ "improvement_mode" ] } ] }, { "anyOf": [ { "properties": { "improvement_mode": { "enum": [ false, null ] } }, "required": [ "improvement_mode" ] }, { "not": { "required": [ "improvement_mode" ] } }, { "properties": { "improvement_mode": { "const": true } }, "required": [ "improvement_mode", "idea_id", "feedback", "reference_variation_url" ] } ] }, { "anyOf": [ { "not": { "required": [ "clone_strategy" ] } }, { "properties": { "clone_strategy": { "enum": [ "direct_reference", "style_analysis" ] } }, "required": [ "clone_strategy", "reference_image_url" ] } ] } ], "properties": { "callback_secret": { "maxLength": 255, "type": [ "string", "null" ] }, "callback_url": { "description": "Must use HTTPS and resolve to a public, non-reserved host; redirects and DNS resolution are revalidated server-side.", "format": "uri", "maxLength": 2048, "type": [ "string", "null" ] }, "clone_strategy": { "enum": [ "direct_reference", "style_analysis", null ], "type": [ "string", "null" ] }, "feedback": { "maxLength": 5000, "type": [ "string", "null" ] }, "idea_id": { "minimum": 1, "type": [ "integer", "null" ] }, "improvement_mode": { "type": [ "boolean", "null" ] }, "num_variations": { "default": 3, "maximum": 8, "minimum": 1, "type": "integer" }, "prompt": { "maxLength": 2000, "type": [ "string", "null" ] }, "reference_image_url": { "description": "Must use HTTPS.", "format": "uri", "type": [ "string", "null" ] }, "reference_variation_url": { "description": "Must use HTTPS.", "format": "uri", "type": [ "string", "null" ] }, "topic": { "maxLength": 1000, "type": [ "string", "null" ] } }, "type": "object" }, "CreateThumbnailGenerationResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "run_id": { "type": "string" }, "run_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" } }, "required": [ "run_id", "run_ids", "status" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "CreateWebhookRequest": { "additionalProperties": false, "properties": { "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "minItems": 1, "type": "array" }, "headers": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Associative header map. Keys use letters, numbers, or hyphens; reserved transport/authentication headers are rejected case-insensitively.", "maxProperties": 20, "propertyNames": { "pattern": "^[A-Za-z0-9-]+$" }, "type": "object" }, "name": { "maxLength": 255, "type": "string" }, "timeout": { "maximum": 120, "minimum": 5, "type": "integer" }, "url": { "description": "Must use HTTPS and resolve to a public, non-reserved host; redirects and DNS resolution are revalidated server-side.", "format": "uri", "maxLength": 500, "pattern": "^https://", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "CreateWebhookResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "active": { "type": "boolean" }, "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "type": [ "array", "null" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "secret": { "type": "string" }, "timeout": { "type": "integer" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "url", "events", "secret", "active", "timeout" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "DeleteApiTokenResponse": { "additionalProperties": true, "properties": { "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "DeleteChannelCompetitorResponse": { "additionalProperties": true, "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "type": "object" }, "DeleteIntelBookmarkResponse": { "additionalProperties": true, "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "type": "object" }, "DeleteWebhookResponse": { "additionalProperties": true, "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "type": "object" }, "EditThumbnailBoardImageRequest": { "additionalProperties": false, "properties": { "instruction": { "description": "One plain-language change, e.g. \"remove the text\" or \"make the sky stormy\".", "maxLength": 2000, "minLength": 3, "type": "string" }, "item_id": { "description": "A ready image item on this board to edit.", "type": "integer" }, "region": { "additionalProperties": false, "description": "Optional rectangle, as fractions of the image (0-1), confining the edit. Pixels outside it are guaranteed identical to the original.", "properties": { "height": { "maximum": 1, "minimum": 0, "type": "number" }, "width": { "maximum": 1, "minimum": 0, "type": "number" }, "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y", "width", "height" ], "type": "object" } }, "required": [ "item_id", "instruction" ], "type": "object" }, "EditThumbnailBoardImageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": "integer" }, "credits_remaining": { "type": "integer" }, "credits_spent": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ThumbnailBoardItem" }, "type": "array" }, "note": { "type": "string" } }, "required": [ "board_id", "credits_spent", "credits_remaining", "items", "note" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ErrorEnvelope": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "available_credits": { "minimum": 0, "type": [ "integer", "null" ] }, "code": { "enum": [ "validation_failed", "unauthenticated", "authentication_required", "team_binding_required", "team_access_revoked", "token_scope_denied", "role_denied", "entitlement_required", "forbidden", "not_found", "object_not_found", "object_replaced", "unsupported_action", "invalid_transition", "revision_conflict", "idempotency_conflict", "video_provisioning_required", "video_configuration_not_ready", "video_capability_unavailable", "video_edit_rejected", "video_insufficient_balance", "rate_limited", "temporary_failure" ], "type": "string" }, "current_revision": { "type": [ "string", "null" ] }, "field_errors": { "additionalProperties": { "items": { "maxLength": 500, "type": "string" }, "maxItems": 10, "type": "array" }, "maxProperties": 20, "type": [ "object", "null" ] }, "message": { "type": [ "string", "null" ] }, "replaced_by": { "type": [ "string", "null" ] }, "required_credits": { "minimum": 0, "type": [ "integer", "null" ] }, "retry_after": { "minimum": 0, "type": [ "integer", "null" ] }, "retryable": { "type": "boolean" } }, "required": [ "code", "message", "retryable" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "ExportScriptResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "content": { "type": "string" }, "format": { "type": "string" }, "include_headings": { "type": "boolean" }, "script_id": { "type": "integer" }, "title": { "type": "string" } }, "required": [ "script_id", "title", "format", "content", "include_headings" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ExportThumbnailBoardImageRequest": { "additionalProperties": false, "properties": { "item_id": { "type": "integer" } }, "required": [ "item_id" ], "type": "object" }, "ExportThumbnailBoardImageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": "integer" }, "item": { "$ref": "#/components/schemas/ThumbnailBoardItem" }, "overlays_flattened": { "type": "integer" }, "url": { "format": "uri", "type": "string" } }, "required": [ "board_id", "url", "item", "overlays_flattened" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GenerateChannelIdeasRequest": { "additionalProperties": false, "properties": { "count": { "maximum": 20, "minimum": 1, "type": "integer" } }, "type": "object" }, "GenerateChannelIdeasResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channel_id": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "channel_id", "count" ], "type": "object" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message", "data" ], "type": "object" }, "GenerateIdeasFromChannelRequest": { "additionalProperties": false, "anyOf": [ { "required": [ "channel_handle" ] }, { "required": [ "channel_id" ] } ], "properties": { "channel_handle": { "maxLength": 200, "type": "string" }, "channel_id": { "maxLength": 50, "type": "string" }, "count": { "maximum": 20, "minimum": 1, "type": "integer" } }, "type": "object" }, "GenerateIdeasFromChannelResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channel_id": { "type": "integer" }, "count": { "type": "integer" }, "source_channel_title": { "type": "string" } }, "required": [ "channel_id", "source_channel_title", "count" ], "type": "object" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message", "data" ], "type": "object" }, "GenerateIdeasFromVideoRequest": { "additionalProperties": false, "anyOf": [ { "required": [ "video_url" ] }, { "required": [ "video_id" ] } ], "properties": { "count": { "maximum": 20, "minimum": 1, "type": "integer" }, "video_id": { "maxLength": 20, "type": "string" }, "video_url": { "maxLength": 500, "type": "string" } }, "type": "object" }, "GenerateIdeasFromVideoResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channel_id": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "channel_id", "count" ], "type": "object" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message", "data" ], "type": "object" }, "GenerateScriptOutlineResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "run_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "run_id", "status" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GenerateScriptResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "run_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "run_id", "status" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetChannelResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "details": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "country": { "type": "string" }, "custom_url": { "type": "string" }, "default_language": { "type": "string" }, "description": { "type": "string" }, "subscriber_count": { "type": "integer" }, "thumbnails": { "additionalProperties": true, "properties": { "default": { "additionalProperties": true, "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "default" ], "type": "object" }, "title": { "type": "string" }, "video_count": { "type": "integer" }, "view_count": { "type": "integer" } }, "required": [ "title", "custom_url", "channel_id", "subscriber_count", "video_count", "view_count", "description", "default_language", "country", "thumbnails" ], "type": "object" }, "id": { "type": "integer" }, "scripts_active_count": { "type": "integer" }, "scripts_count": { "type": "integer" }, "scripts_idea_count": { "type": "integer" }, "settings": { "additionalProperties": true, "properties": { "audience": { "type": "string" }, "language": { "type": "string" } }, "required": [ "language", "audience" ], "type": "object" }, "voice": { "additionalProperties": true, "properties": { "id": { "type": "integer" }, "instructions": { "type": "string" }, "name": { "type": "string" }, "voice": { "type": "string" } }, "required": [ "id", "name", "instructions", "voice" ], "type": "object" }, "yt_handle": { "type": [ "string", "null" ] } }, "required": [ "id", "yt_handle", "details", "settings", "voice", "scripts_count", "scripts_idea_count", "scripts_active_count" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetIdeaResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "channel_id": { "type": "integer" }, "id": { "type": "integer" }, "notes": { "type": [ "string", "null" ] }, "outlier_score": { "type": [ "string", "null" ] }, "script_id": { "type": [ "string", "null" ] }, "source_type": { "type": "string" }, "status": { "type": "string" }, "suggested_length": { "type": "integer" }, "suggested_template_id": { "type": "integer" }, "thumbnail_concept": { "type": "string" }, "title": { "type": "string" }, "topic": { "type": "string" } }, "required": [ "id", "channel_id", "title", "topic", "angle", "suggested_length", "suggested_template_id", "status", "script_id", "source_type", "thumbnail_concept", "outlier_score", "notes" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetOperationResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ], "type": "object" }, "GetScriptAgentRunResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "auth_path": { "type": "string" }, "current_step": { "type": [ "string", "null" ] }, "current_step_label": { "type": [ "string", "null" ] }, "elapsed_seconds": { "type": "integer" }, "executor": { "type": "string" }, "run_id": { "type": "integer" }, "script_url": { "description": "Populated when status is completed.", "type": "string" }, "status": { "type": "string" }, "usage": { "additionalProperties": false, "description": "Provider-reported token metrics, present on completed runs when data is available.", "properties": { "completion_tokens": { "type": [ "integer", "null" ] }, "prompt_tokens": { "type": [ "integer", "null" ] }, "reasoning_tokens": { "type": [ "integer", "null" ] }, "total_tokens": { "type": "integer" } }, "type": "object" } }, "required": [ "run_id", "status", "current_step", "current_step_label", "elapsed_seconds", "executor", "auth_path" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetScriptContentResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "content_version": { "type": "integer" }, "outline": { "type": "string" }, "outline_version": { "type": "integer" }, "script": { "type": "string" }, "script_id": { "type": "integer" } }, "required": [ "script_id", "outline", "script", "outline_version", "content_version" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetScriptResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "canvas_url": { "format": "uri", "type": "string" }, "channel_id": { "type": "integer" }, "format": { "type": "string" }, "has_outline": { "type": "boolean" }, "has_script": { "type": "boolean" }, "hook": { "type": "string" }, "id": { "type": "integer" }, "language": { "type": "string" }, "length": { "type": "integer" }, "notes": { "type": "string" }, "production_status": { "type": "string" }, "script_number": { "type": "integer" }, "status": { "type": "string" }, "template_id": { "type": "integer" }, "thread_id": { "type": "integer" }, "thumbnail": { "type": "string" }, "title": { "type": "string" }, "topic": { "type": "string" }, "voice": { "type": "string" } }, "required": [ "id", "channel_id", "script_number", "title", "topic", "angle", "length", "format", "language", "voice", "template_id", "status", "production_status", "thread_id", "canvas_url", "has_outline", "has_script", "notes", "hook", "thumbnail" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetTeamCreditsResponse": { "additionalProperties": true, "properties": { "credits": { "additionalProperties": true, "properties": { "credits_expire_at": { "format": "date-time", "type": "string" }, "credits_remaining": { "type": "integer" }, "credits_used_this_period": { "type": "integer" }, "current_credits": { "type": "integer" }, "next_credit_refresh": { "format": "date-time", "type": "string" }, "plan_credits": { "type": "integer" } }, "required": [ "current_credits", "plan_credits", "credits_used_this_period", "credits_remaining", "credits_expire_at", "next_credit_refresh" ], "type": "object" } }, "required": [ "credits" ], "type": "object" }, "GetTeamResponse": { "additionalProperties": true, "properties": { "team": { "additionalProperties": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "owner": { "additionalProperties": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "subscription": { "additionalProperties": true, "properties": { "is_paused": { "type": "boolean" }, "plan": { "type": "string" }, "status": { "type": "string" }, "trial_ends_at": { "type": [ "string", "null" ] } }, "required": [ "plan", "status", "trial_ends_at", "is_paused" ], "type": "object" }, "user_role": { "type": "string" } }, "required": [ "id", "name", "user_role", "owner", "subscription" ], "type": "object" } }, "required": [ "team" ], "type": "object" }, "GetThumbnailBoardResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": [ "integer", "null" ] }, "channel_id": { "type": "integer" }, "credits_remaining": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ThumbnailBoardItem" }, "type": "array" }, "studio_url": { "format": "uri", "type": "string" } }, "required": [ "channel_id", "board_id", "studio_url", "credits_remaining", "items" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetThumbnailGenerationResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "created_at": { "format": "date-time", "type": "string" }, "idea_id": { "type": [ "string", "null" ] }, "output_urls": { "items": { "format": "uri", "type": "string" }, "type": "array" }, "run_id": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "run_id", "status", "idea_id", "output_urls", "created_at", "updated_at" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetThumbnailUsageResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "addon_pool": { "additionalProperties": true, "properties": { "limit": { "type": "integer" }, "next_reset": { "type": "string" }, "remaining": { "type": "integer" }, "reserved": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "used", "reserved", "remaining", "next_reset" ], "type": "object" }, "eligible": { "type": "boolean" }, "free_pool": { "additionalProperties": true, "properties": { "limit": { "type": "integer" }, "next_reset": { "type": "string" }, "remaining": { "type": "integer" }, "reserved": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "used", "reserved", "remaining", "next_reset" ], "type": "object" }, "pack_pool": { "additionalProperties": true, "properties": { "limit": { "type": "integer" }, "next_reset": { "type": [ "string", "null" ] }, "remaining": { "type": "integer" }, "reserved": { "type": "integer" }, "used": { "type": "integer" } }, "required": [ "limit", "used", "reserved", "remaining", "next_reset" ], "type": "object" }, "total_remaining": { "type": "integer" } }, "required": [ "eligible", "free_pool", "addon_pool", "pack_pool", "total_remaining" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "GetWebhookResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "active": { "type": "boolean" }, "deliveries": { "items": { "additionalProperties": true, "properties": { "event_type": { "type": "string" }, "id": { "type": "integer" }, "response_code": { "type": [ "integer", "null" ] }, "status": { "type": "string" } }, "required": [ "id", "event_type", "status", "response_code" ], "type": "object" }, "type": "array" }, "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "type": [ "array", "null" ] }, "headers": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "success_rate": { "type": "number" }, "timeout": { "type": "integer" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "url", "events", "active", "headers", "timeout", "success_rate", "deliveries" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "HumanizeScriptResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "run_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "run_id", "status" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ListApiTokensResponse": { "additionalProperties": true, "properties": { "tokens": { "items": { "additionalProperties": true, "properties": { "abilities": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "integer" }, "last_used_at": { "format": "date-time", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "abilities", "last_used_at" ], "type": "object" }, "type": "array" } }, "required": [ "tokens" ], "type": "object" }, "ListChannelCompetitorsResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ListChannelIdeasResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "channel_id": { "type": "integer" }, "id": { "type": "integer" }, "notes": { "type": [ "string", "null" ] }, "outlier_score": { "type": [ "string", "null" ] }, "script_id": { "type": [ "string", "null" ] }, "source_type": { "type": "string" }, "status": { "type": "string" }, "suggested_length": { "type": "integer" }, "suggested_template_id": { "type": "integer" }, "thumbnail_concept": { "type": "string" }, "title": { "type": "string" }, "topic": { "type": "string" } }, "required": [ "id", "channel_id", "title", "topic", "angle", "suggested_length", "suggested_template_id", "status", "script_id", "source_type", "thumbnail_concept", "outlier_score", "notes" ], "type": "object" }, "type": "array" }, "pagination": { "additionalProperties": true, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data", "pagination" ], "type": "object" }, "ListChannelScriptsResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "canvas_url": { "format": "uri", "type": "string" }, "channel_id": { "type": "integer" }, "format": { "type": "string" }, "has_outline": { "type": "boolean" }, "has_script": { "type": "boolean" }, "id": { "type": "integer" }, "language": { "type": "string" }, "length": { "type": "integer" }, "production_status": { "type": "string" }, "script_number": { "type": "integer" }, "status": { "type": "string" }, "template_id": { "type": "integer" }, "thread_id": { "type": "integer" }, "title": { "type": "string" }, "topic": { "type": "string" }, "voice": { "type": "string" } }, "required": [ "id", "channel_id", "script_number", "title", "topic", "angle", "length", "status", "format", "language", "voice", "template_id", "production_status", "thread_id", "canvas_url", "has_outline", "has_script" ], "type": "object" }, "type": "array" }, "pagination": { "additionalProperties": true, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data", "pagination" ], "type": "object" }, "ListChannelTemplatesResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "default_template_id": { "type": "integer" }, "templates": { "items": { "additionalProperties": true, "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer" }, "is_active": { "type": "boolean" }, "is_system": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "id", "name", "category", "description", "is_active", "is_system" ], "type": "object" }, "type": "array" } }, "required": [ "default_template_id", "templates" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ListChannelVoicesResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/VoiceProfileDescriptor" }, "maxItems": 100, "type": "array" }, "meta": { "additionalProperties": false, "properties": { "default_voice_id": { "format": "uuid", "type": [ "string", "null" ] }, "truncated": { "type": "boolean" } }, "required": [ "default_voice_id", "truncated" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ListChannelsResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "properties": { "details": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "country": { "type": "string" }, "custom_url": { "type": "string" }, "default_language": { "type": "string" }, "description": { "type": "string" }, "subscriber_count": { "type": "integer" }, "thumbnails": { "additionalProperties": true, "properties": { "default": { "additionalProperties": true, "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "default" ], "type": "object" }, "title": { "type": "string" }, "video_count": { "type": "integer" }, "view_count": { "type": "integer" } }, "required": [ "title", "custom_url", "channel_id", "subscriber_count", "video_count", "view_count", "description", "country", "default_language", "thumbnails" ], "type": "object" }, "id": { "type": "integer" }, "scripts_count": { "type": "integer" }, "yt_handle": { "type": "string" } }, "required": [ "id", "yt_handle", "details", "scripts_count" ], "type": "object" }, "type": "array" }, "pagination": { "additionalProperties": true, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data", "pagination" ], "type": "object" }, "ListIntelBookmarksResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "pagination": { "additionalProperties": true, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data", "pagination" ], "type": "object" }, "ListThumbnailGenerationsResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "properties": { "created_at": { "format": "date-time", "type": "string" }, "idea_id": { "type": "integer" }, "output_urls": { "items": { "format": "uri", "type": "string" }, "type": "array" }, "run_id": { "type": "string" }, "source_type": { "type": "string" }, "status": { "type": "string" } }, "required": [ "run_id", "status", "source_type", "idea_id", "output_urls", "created_at" ], "type": "object" }, "type": "array" }, "meta": { "additionalProperties": true, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "current_page", "last_page", "per_page", "total" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data", "meta" ], "type": "object" }, "ListWebhooksResponse": { "additionalProperties": true, "properties": { "data": { "items": { "additionalProperties": true, "properties": { "active": { "type": "boolean" }, "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "type": [ "array", "null" ] }, "id": { "type": "integer" }, "last_delivery": { "additionalProperties": true, "properties": { "attempts": { "type": "integer" }, "delivered_at": { "format": "date-time", "type": [ "string", "null" ] }, "event_type": { "type": "string" }, "id": { "type": "integer" }, "next_retry_at": { "format": "date-time", "type": [ "string", "null" ] }, "response_code": { "type": [ "integer", "null" ] }, "scheduled_at": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "type": "string" } }, "required": [ "id", "event_type", "status", "response_code", "attempts", "delivered_at", "next_retry_at", "scheduled_at" ], "type": [ "object", "null" ] }, "name": { "type": "string" }, "success_rate": { "type": "number" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "url", "events", "active", "success_rate", "last_delivery" ], "type": "object" }, "type": "array" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "LookupIntelChannelRequest": { "additionalProperties": false, "properties": { "identifiers": { "items": { "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" } }, "required": [ "identifiers" ], "type": "object" }, "LookupIntelChannelResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channels": { "items": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "handle": { "type": "string" }, "published_at": { "format": "date-time", "type": "string" }, "subscriber_count": { "type": "integer" }, "thumbnails": { "additionalProperties": true, "properties": { "default": { "additionalProperties": true, "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "default" ], "type": "object" }, "title": { "type": "string" }, "video_count": { "type": "integer" }, "view_count": { "type": "integer" } }, "required": [ "channel_id", "handle", "title", "description", "thumbnails", "subscriber_count", "video_count", "view_count", "published_at", "country" ], "type": "object" }, "type": "array" }, "errors": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "required": [ "channels", "errors" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "LookupIntelVideoRequest": { "additionalProperties": false, "properties": { "identifiers": { "items": { "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" } }, "required": [ "identifiers" ], "type": "object" }, "LookupIntelVideoResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "errors": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "videos": { "items": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "channel": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "handle": { "type": "string" }, "title": { "type": "string" } }, "required": [ "channel_id", "handle", "title" ], "type": "object" }, "comment_count": { "type": "integer" }, "description": { "type": "string" }, "duration": { "type": "string" }, "format": { "type": "string" }, "goals": { "type": "string" }, "like_count": { "type": "integer" }, "outlier_score": { "type": "number" }, "published_at": { "format": "date-time", "type": "string" }, "thumbnail_url": { "format": "uri", "type": "string" }, "title": { "type": "string" }, "topic": { "type": "string" }, "video_id": { "type": "string" }, "view_count": { "type": "integer" } }, "required": [ "video_id", "channel", "title", "description", "published_at", "thumbnail_url", "duration", "view_count", "like_count", "comment_count", "outlier_score", "format", "topic", "angle", "goals" ], "type": "object" }, "type": "array" } }, "required": [ "videos", "errors" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "MoveProjectRequest": { "additionalProperties": false, "properties": { "stage": { "description": "Idea references accept only new, considering, or needs_script. Script references accept only scripting, recording, thumbnail, video_gen, video_ready, or upload. Recording is rejected when disabled for the channel.", "enum": [ "new", "considering", "needs_script", "scripting", "recording", "thumbnail", "video_gen", "video_ready", "upload" ], "type": "string" } }, "required": [ "stage" ], "type": "object", "x-project-source-stage-enums": { "idea": [ "new", "considering", "needs_script" ], "script": [ "scripting", "recording", "thumbnail", "video_gen", "video_ready", "upload" ] } }, "Operation": { "additionalProperties": false, "properties": { "domain_resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "id": { "format": "uuid", "type": "string" }, "progress": { "maximum": 100, "minimum": 0, "type": "integer" }, "result": { "type": [ "object", "array", "string", "number", "boolean", "null" ] }, "retry": { "additionalProperties": false, "properties": { "action": { "type": [ "string", "null" ] }, "after": { "format": "date-time", "type": [ "string", "null" ] }, "supported": { "type": "boolean" } }, "required": [ "supported", "action", "after" ], "type": "object" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "cancelled" ], "type": "string" }, "timestamps": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "started_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "created_at", "started_at", "finished_at", "expires_at" ], "type": "object" }, "type": { "type": "string" }, "warnings": { "items": { "type": "object" }, "type": "array" } }, "required": [ "id", "type", "status", "progress", "result", "warnings", "error", "retry", "timestamps", "domain_resource" ], "type": "object" }, "PollScriptGenerationResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "content_type": { "type": "string" }, "outline": { "type": "string" }, "run_id": { "type": "string" }, "script": { "type": "string" }, "status": { "type": "string" } }, "required": [ "run_id", "status", "content_type", "outline", "script" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "Project": { "additionalProperties": false, "properties": { "allowed_actions": { "$ref": "#/components/schemas/ProjectAllowedActions" }, "angle": { "type": [ "string", "null" ] }, "archived": { "type": "boolean" }, "assignment": { "$ref": "#/components/schemas/ProjectAssignment" }, "canonical_url": { "format": "uri", "type": "string" }, "channel": { "$ref": "#/components/schemas/ProjectChannel" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "pattern": "^project:v1:(idea|script):[1-9][0-9]*$", "type": "string" }, "linked_idea": { "oneOf": [ { "$ref": "#/components/schemas/ProjectLinkedIdea" }, { "type": "null" } ] }, "revision": { "type": "string" }, "source": { "enum": [ "idea", "script" ], "type": "string" }, "stage": { "$ref": "#/components/schemas/ProjectStage" }, "tags": { "items": { "$ref": "#/components/schemas/ProjectTag" }, "maxItems": 100, "type": "array" }, "tags_truncated": { "type": "boolean" }, "title": { "type": [ "string", "null" ] }, "topic": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "source", "title", "revision" ], "type": "object" }, "ProjectActivity": { "additionalProperties": false, "properties": { "actor_id": { "type": [ "integer", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "description": { "maxLength": 280, "type": "string" }, "event": { "maxLength": 100, "type": "string" }, "id": { "type": "integer" } }, "required": [ "id", "event", "description", "actor_id", "created_at" ], "type": "object" }, "ProjectActivityListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectActivity" }, "maxItems": 100, "type": "array" }, "meta": { "$ref": "#/components/schemas/BoundedListMeta" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectActor": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "name": { "maxLength": 100, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ProjectAllowedActions": { "additionalProperties": false, "properties": { "archive": { "type": "boolean" }, "assign": { "type": "boolean" }, "manage_production": { "type": "boolean" }, "move": { "type": "boolean" }, "promote": { "type": "boolean" }, "restore": { "type": "boolean" }, "set_due_date": { "type": "boolean" }, "update": { "type": "boolean" }, "view": { "type": "boolean" } }, "required": [ "view", "update", "move", "promote", "archive", "restore", "assign", "set_due_date", "manage_production" ], "type": "object" }, "ProjectAssignment": { "additionalProperties": false, "properties": { "due_at": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "user_id": { "type": [ "integer", "null" ] } }, "required": [ "user_id", "name", "due_at" ], "type": "object" }, "ProjectAttachment": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "integer" }, "is_image": { "type": "boolean" }, "label": { "maxLength": 100, "type": [ "string", "null" ] }, "mime_type": { "maxLength": 100, "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "size_bytes": { "minimum": 0, "type": "integer" }, "uploaded_by": { "oneOf": [ { "$ref": "#/components/schemas/ProjectActor" }, { "type": "null" } ] } }, "required": [ "id", "name", "label", "mime_type", "size_bytes", "is_image", "uploaded_by", "created_at" ], "type": "object" }, "ProjectAttachmentListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectAttachment" }, "maxItems": 100, "type": "array" }, "meta": { "$ref": "#/components/schemas/BoundedListMeta" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectChannel": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "type": "object" }, "ProjectComment": { "additionalProperties": false, "properties": { "author": { "oneOf": [ { "$ref": "#/components/schemas/ProjectActor" }, { "type": "null" } ] }, "body": { "maxLength": 20000, "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "edited_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "integer" }, "mentioned_user_ids": { "items": { "type": "integer" }, "maxItems": 50, "type": "array" } }, "required": [ "id", "body", "author", "mentioned_user_ids", "edited_at", "created_at" ], "type": "object" }, "ProjectCommentListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectComment" }, "maxItems": 100, "type": "array" }, "meta": { "$ref": "#/components/schemas/BoundedListMeta" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectCommentResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProjectComment" }, "meta": { "additionalProperties": false, "properties": { "no_op": { "type": "boolean" } }, "required": [ "no_op" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectIdeaStageInput": { "enum": [ "new", "considering", "needs_script" ], "type": "string" }, "ProjectLinkedIdea": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "stage": { "enum": [ "new", "considering", "needs_script", "scripting", "recording", "thumbnail", "video_gen", "video_ready", "upload" ], "type": "string" } }, "required": [ "id", "stage" ], "type": "object" }, "ProjectListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/Project" }, "type": "array" }, "meta": { "additionalProperties": false, "properties": { "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "next_cursor" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectNotification": { "additionalProperties": false, "properties": { "actor": { "oneOf": [ { "$ref": "#/components/schemas/ProjectActor" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "message": { "maxLength": 280, "type": "string" }, "project_id": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "read_at": { "format": "date-time", "type": [ "string", "null" ] }, "target_available": { "type": "boolean" }, "type": { "enum": [ "kanban_assigned_script_comment", "kanban_comment_mention", "kanban_script_status_changed" ], "type": "string" } }, "required": [ "id", "type", "project_id", "target_available", "message", "actor", "read_at", "created_at" ], "type": "object" }, "ProjectNotificationListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectNotification" }, "maxItems": 100, "type": "array" }, "meta": { "additionalProperties": false, "properties": { "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "next_cursor" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectNotificationResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProjectNotification" } }, "required": [ "data" ], "type": "object" }, "ProjectProduction": { "additionalProperties": false, "properties": { "checklist": { "items": { "$ref": "#/components/schemas/ProjectUploadChecklistItem" }, "maxItems": 100, "type": "array" }, "checklist_total": { "minimum": 0, "type": "integer" }, "checklist_truncated": { "type": "boolean" }, "project_id": { "$ref": "#/components/schemas/ProjectReference" }, "stage": { "$ref": "#/components/schemas/ProjectScriptStageInput" }, "thumbnail": { "$ref": "#/components/schemas/ProjectThumbnailProduction" }, "upload": { "$ref": "#/components/schemas/ProjectUploadProduction" } }, "required": [ "project_id", "stage", "thumbnail", "upload", "checklist", "checklist_total", "checklist_truncated" ], "type": "object" }, "ProjectProductionResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProjectProduction" }, "meta": { "additionalProperties": false, "properties": { "idempotent_replay": { "type": "boolean" }, "revision": { "type": "string" } }, "required": [ "revision", "idempotent_replay" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectReference": { "pattern": "^project:v1:(idea|script):[1-9][0-9]*$", "type": "string" }, "ProjectResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Project" }, "meta": { "additionalProperties": true, "properties": { "idempotent_replay": { "type": "boolean" }, "no_op": { "type": "boolean" } }, "required": [ "idempotent_replay" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "ProjectScriptStageInput": { "description": "The recording destination is rejected when the Project channel has recording disabled.", "enum": [ "scripting", "recording", "thumbnail", "video_gen", "video_ready", "upload" ], "type": "string" }, "ProjectStage": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "key": { "type": "string" }, "occupied_disabled_stage": { "type": "boolean" }, "source": { "enum": [ "idea", "script" ], "type": "string" } }, "required": [ "key", "source", "enabled", "occupied_disabled_stage" ], "type": "object" }, "ProjectStageInput": { "oneOf": [ { "$ref": "#/components/schemas/ProjectIdeaStageInput" }, { "$ref": "#/components/schemas/ProjectScriptStageInput" } ] }, "ProjectTag": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ProjectThumbnailProduction": { "additionalProperties": false, "properties": { "review_notes": { "maxLength": 5000, "type": [ "string", "null" ] }, "review_status": { "type": [ "string", "null" ] }, "reviewed_at": { "format": "date-time", "type": [ "string", "null" ] }, "text": { "maxLength": 200, "type": [ "string", "null" ] }, "winner_selected": { "type": "boolean" } }, "required": [ "text", "winner_selected", "review_status", "review_notes", "reviewed_at" ], "type": "object" }, "ProjectUploadChecklistItem": { "additionalProperties": false, "properties": { "checked": { "type": "boolean" }, "checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "checked_by": { "type": [ "integer", "null" ] }, "id": { "type": "integer" }, "label": { "maxLength": 120, "type": "string" }, "required": { "type": "boolean" } }, "required": [ "id", "label", "required", "checked", "checked_at", "checked_by" ], "type": "object" }, "ProjectUploadProduction": { "additionalProperties": false, "properties": { "all_required_checked": { "type": "boolean" }, "description": { "maxLength": 5000, "type": [ "string", "null" ] }, "made_for_kids": { "type": "boolean" }, "publish_at": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "enum": [ "drafting", "scheduled", "published", null ], "type": [ "string", "null" ] }, "tags": { "items": { "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" }, "visibility": { "enum": [ "public", "unlisted", "private" ], "type": "string" } }, "required": [ "description", "tags", "visibility", "made_for_kids", "status", "publish_at", "all_required_checked" ], "type": "object" }, "PromoteProjectRequest": { "additionalProperties": false, "properties": { "stage": { "description": "The recording destination is rejected when the Project channel has recording disabled.", "enum": [ "scripting", "recording", "thumbnail", "video_gen", "video_ready", "upload" ], "type": "string" } }, "type": "object" }, "ReadAllProjectNotificationsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "marked_read": { "minimum": 0, "type": "integer" } }, "required": [ "marked_read" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SearchIntelChannelsRequest": { "additionalProperties": false, "properties": { "limit": { "maximum": 50, "minimum": 1, "type": "integer" }, "query": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "query" ], "type": "object" }, "SearchIntelChannelsResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "channels": { "items": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "handle": { "type": "string" }, "published_at": { "format": "date-time", "type": "string" }, "subscriber_count": { "type": "integer" }, "thumbnails": { "additionalProperties": true, "properties": { "default": { "additionalProperties": true, "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "default" ], "type": "object" }, "title": { "type": "string" }, "video_count": { "type": "integer" }, "view_count": { "type": "integer" } }, "required": [ "channel_id", "handle", "title", "description", "thumbnails", "published_at", "subscriber_count", "video_count", "view_count", "country" ], "type": "object" }, "type": "array" }, "message": { "type": "string" }, "query": { "type": "string" }, "total_results": { "type": "integer" } }, "required": [ "channels", "query", "total_results", "message" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "SearchIntelVideosRequest": { "additionalProperties": false, "properties": { "limit": { "maximum": 50, "minimum": 1, "type": "integer" }, "query": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "query" ], "type": "object" }, "SearchIntelVideosResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "message": { "type": "string" }, "query": { "type": "string" }, "total_results": { "type": "integer" }, "videos": { "items": { "additionalProperties": true, "properties": { "angle": { "type": "string" }, "channel": { "additionalProperties": true, "properties": { "channel_id": { "type": "string" }, "handle": { "type": "string" }, "title": { "type": "string" } }, "required": [ "channel_id", "handle", "title" ], "type": "object" }, "comment_count": { "type": "integer" }, "description": { "type": "string" }, "duration": { "type": "string" }, "format": { "type": "string" }, "goals": { "type": "string" }, "like_count": { "type": "integer" }, "outlier_score": { "type": "number" }, "published_at": { "format": "date-time", "type": "string" }, "thumbnail_url": { "format": "uri", "type": "string" }, "title": { "type": "string" }, "topic": { "type": "string" }, "video_id": { "type": "string" }, "view_count": { "type": "integer" } }, "required": [ "video_id", "channel", "title", "description", "published_at", "thumbnail_url", "view_count", "like_count", "comment_count", "duration", "format", "topic", "angle", "goals", "outlier_score" ], "type": "object" }, "type": "array" } }, "required": [ "videos", "query", "total_results", "message" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "SetThumbnailBoardTextRequest": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "background": { "pattern": "^#[0-9a-fA-F]{6}$", "type": [ "string", "null" ] }, "content": { "maxLength": 200, "type": "string" }, "fill": { "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" }, "font": { "enum": [ "impact", "anton", "bebas", "archivo", "montserrat", "oswald", "bangers", "luckiest", "poppins", "system" ], "type": "string" }, "item_id": { "description": "Update this existing text overlay instead of creating one.", "type": "integer" }, "over_item_id": { "description": "Place the new overlay over this image item.", "type": "integer" }, "size": { "maximum": 240, "minimum": 16, "type": "integer" }, "stroke": { "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" }, "stroke_width": { "maximum": 40, "minimum": 0, "type": "integer" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "type": "object" }, "SetThumbnailBoardTextResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "board_id": { "type": "integer" }, "item": { "$ref": "#/components/schemas/ThumbnailBoardItem" } }, "required": [ "board_id", "item" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "StartScriptAgentRunRequest": { "additionalProperties": false, "properties": { "model": { "enum": [ "kimi_k26", "minimax_m27", "glm_51", "claude_haiku_45", "claude_sonnet_46", "claude_opus_48", "claude_fable_5", "gpt55", "gpt54", "gpt54_mini" ], "type": "string" }, "research": { "enum": [ "auto", "on", "off", "deep_research" ], "type": "string" }, "visual_cues": { "enum": [ "off", "on" ], "type": "string" } }, "type": "object" }, "StartScriptAgentRunResponse": { "additionalProperties": true, "properties": { "cancel_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "model": { "type": "string" }, "poll_url": { "format": "uri", "type": "string" }, "research": { "type": "string" }, "resolved_model": { "type": "string" }, "run_id": { "type": "integer" }, "status": { "type": "string" }, "visual_cues": { "type": "string" } }, "required": [ "run_id", "status", "research", "visual_cues", "model", "resolved_model", "poll_url", "cancel_url", "message" ], "type": "object" }, "TemplateDescriptor": { "additionalProperties": false, "properties": { "archived": { "type": "boolean" }, "category": { "maxLength": 255, "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "description": { "maxLength": 500, "type": [ "string", "null" ] }, "id": { "oneOf": [ { "minimum": 1, "type": "integer" }, { "pattern": "^system:[a-z0-9_]+$", "type": "string" } ] }, "is_default": { "type": "boolean" }, "key": { "type": [ "string", "null" ] }, "kind": { "enum": [ "system", "custom" ], "type": "string" }, "mutable": { "type": "boolean" }, "name": { "maxLength": 255, "type": "string" }, "prompt": { "maxLength": 20000, "type": "string" }, "revision": { "type": "string" }, "slug": { "maxLength": 255, "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "kind", "key", "name", "slug", "category", "description", "prompt", "is_default", "archived", "mutable", "revision", "created_at", "updated_at" ], "type": "object" }, "TemplateListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/TemplateDescriptor" }, "maxItems": 250, "type": "array" }, "meta": { "additionalProperties": false, "properties": { "custom_count": { "maximum": 200, "minimum": 0, "type": "integer" }, "custom_truncated": { "type": "boolean" }, "default_template_id": { "type": [ "integer", "null" ] }, "system_count": { "minimum": 0, "type": "integer" } }, "required": [ "default_template_id", "system_count", "custom_count", "custom_truncated" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "TemplateResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TemplateDescriptor" }, "meta": { "additionalProperties": false, "properties": { "idempotent_replay": { "type": "boolean" } }, "required": [ "idempotent_replay" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "TestWebhookResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "error": { "type": [ "string", "null" ] }, "response_body": { "type": [ "string", "null" ] }, "status_code": { "type": [ "integer", "null" ] }, "success": { "type": "boolean" } }, "required": [ "success", "status_code", "response_body", "error" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ThumbnailBoardItem": { "additionalProperties": false, "properties": { "assigned_script_id": { "description": "Set when this image is the current thumbnail of a script (project).", "type": [ "integer", "null" ] }, "assigned_script_title": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ] }, "error": { "description": "For failed items: the user-facing reason the generation failed. Absent on other items.", "type": [ "string", "null" ] }, "frame_id": { "type": [ "integer", "null" ] }, "height": { "type": "integer" }, "id": { "type": "integer" }, "label": { "type": [ "string", "null" ] }, "prompt": { "type": [ "string", "null" ] }, "shape": { "description": "Set on shape items: the drawing primitive.", "enum": [ "rectangle", "ellipse", "arrow", "arrow_curve", null ], "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "status": { "enum": [ "ready", "generating", "failed" ], "type": "string" }, "style_format": { "description": "Set on generated images: the channel's proven thumbnail format this variation was built on.", "type": [ "string", "null" ] }, "type": { "enum": [ "image", "text", "shape", "frame" ], "type": "string" }, "url": { "format": "uri", "type": [ "string", "null" ] }, "usage": { "type": [ "string", "null" ] }, "width": { "type": "integer" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "id", "type", "status", "x", "y", "width", "height" ], "type": "object" }, "UpdateProjectProductionRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "checklist": { "items": { "additionalProperties": false, "properties": { "checked": { "type": "boolean" }, "id": { "minimum": 1, "type": "integer" } }, "required": [ "id", "checked" ], "type": "object" }, "maxItems": 100, "type": "array" }, "description": { "maxLength": 5000, "type": [ "string", "null" ] }, "made_for_kids": { "type": "boolean" }, "mark_scheduled": { "type": "boolean" }, "publish_at": { "format": "date-time", "type": [ "string", "null" ] }, "request_thumbnail_review": { "type": "boolean" }, "tags": { "items": { "maxLength": 100, "minLength": 1, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true }, "thumbnail_text": { "maxLength": 200, "type": [ "string", "null" ] }, "visibility": { "enum": [ "public", "unlisted", "private" ], "type": "string" } }, "type": "object" }, "UpdateProjectRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "angle": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "topic": { "type": [ "string", "null" ] } }, "type": "object" }, "UpdateTemplateRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "description": { "maxLength": 500, "type": [ "string", "null" ] }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "prompt": { "maxLength": 20000, "minLength": 100, "type": "string" } }, "type": "object" }, "UpdateWebhookRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "active": { "type": "boolean" }, "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "minItems": 1, "type": "array" }, "headers": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Associative header map. Keys use letters, numbers, or hyphens; reserved transport/authentication headers are rejected case-insensitively.", "maxProperties": 20, "propertyNames": { "pattern": "^[A-Za-z0-9-]+$" }, "type": "object" }, "name": { "maxLength": 255, "type": "string" }, "timeout": { "maximum": 120, "minimum": 5, "type": "integer" }, "url": { "description": "Must use HTTPS and resolve to a public, non-reserved host; redirects and DNS resolution are revalidated server-side.", "format": "uri", "maxLength": 500, "pattern": "^https://", "type": "string" } }, "type": "object" }, "UpdateWebhookResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "active": { "type": "boolean" }, "events": { "items": { "enum": [ "idea.created", "script.outline.generated", "script.generated", "script.export.requested", "thumbnail.generated", "webhook.test" ], "type": "string" }, "type": [ "array", "null" ] }, "id": { "type": "integer" }, "name": { "type": "string" }, "timeout": { "type": "integer" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "url", "events", "active", "timeout" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" }, "ValidateVoiceProfileRequest": { "additionalProperties": false, "properties": { "intent": { "enum": [ "create", "update" ], "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "profile": { "$ref": "#/components/schemas/VoiceProfileV2" }, "voice_id": { "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "intent", "name", "profile" ], "type": "object" }, "ValidateVoiceProfileResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "checksum": { "pattern": "^[a-f0-9]{64}$", "type": "string" }, "diff": { "items": { "type": "string" }, "type": "array" }, "expected_revision": { "type": [ "string", "null" ] }, "expires_at": { "format": "date-time", "type": "string" }, "normalized": { "$ref": "#/components/schemas/VoiceProfileV2" }, "receipt": { "type": "string" }, "schema_version": { "const": 2 }, "voice_id": { "format": "uuid", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "receipt", "expires_at", "voice_id", "schema_version", "checksum", "expected_revision", "normalized", "diff", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoAddOverlayRequest": { "properties": { "beat_sequence": { "type": "integer" }, "client_request_id": { "format": "uuid", "type": "string" }, "end_time": { "type": "number" }, "inputs": { "type": "object" }, "playhead_time": { "type": "number" }, "span_scope": { "type": "string" }, "start_time": { "type": "number" }, "template": { "type": "string" } }, "required": [ "template", "inputs" ], "type": "object" }, "VideoAddOverlayResponse": { "properties": { "data": { "properties": { "end_time": { "type": "number" }, "id": { "type": "string" }, "overlay_id": { "type": "string" }, "revision_item_id": { "type": "string" }, "start_time": { "type": "number" }, "status": { "type": "string" }, "template": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "idempotent_replay": { "type": "boolean" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VideoApplyRevisionResponse": { "properties": { "operation": { "properties": { "domain_resource": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "id": { "type": "string" }, "progress": { "type": "integer" }, "result": { "type": [ "object", "null" ] }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "status" ], "type": "object" } }, "required": [ "operation" ], "type": "object" }, "VideoAsset": { "additionalProperties": false, "properties": { "allowed_actions": { "items": { "enum": [ "retry_training", "inspect_upload", "retry_processing" ], "type": "string" }, "type": "array", "uniqueItems": true }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "custom_voice", "custom_avatar", "reference_media" ], "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "state": { "enum": [ "processing", "ready", "failed", "deleting" ], "type": "string" } }, "required": [ "id", "kind", "name", "state", "allowed_actions" ], "type": "object" }, "VideoAssetListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/VideoAsset" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/VideoAssetPagination" } }, "required": [ "data", "pagination" ], "type": "object" }, "VideoAssetPagination": { "additionalProperties": false, "properties": { "current_page": { "minimum": 1, "type": "integer" }, "last_page": { "minimum": 1, "type": "integer" }, "per_page": { "maximum": 100, "minimum": 1, "type": "integer" }, "total": { "minimum": 0, "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ], "type": "object" }, "VideoAssetResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/VideoAsset" } }, "required": [ "data" ], "type": "object" }, "VideoCancelVideoRequest": { "properties": { "reason": { "type": "string" } }, "type": "object" }, "VideoCancelVideoResponse": { "properties": { "data": { "$ref": "#/components/schemas/VideoProject" }, "meta": { "properties": { "idempotent_replay": { "type": "boolean" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VideoCapabilityCatalogResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/VideoCapabilityDescriptor" }, "type": "array" }, "version": { "pattern": "^\\d+\\.\\d+\\.\\d+$", "type": "string" } }, "required": [ "version", "data" ], "type": "object" }, "VideoCapabilityDescriptor": { "additionalProperties": false, "properties": { "behavior": { "maxLength": 2000, "type": "string" }, "compatibility": { "additionalProperties": false, "properties": { "dimension": { "type": "string" }, "field": { "type": "string" }, "modes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "modes" ], "type": "object" }, "defaults": { "additionalProperties": false, "anyOf": [ { "required": [ "is_default" ] }, { "required": [ "source" ] } ], "properties": { "is_default": { "type": "boolean" }, "source": { "type": "string" } }, "type": "object" }, "deprecation": { "additionalProperties": false, "properties": { "replacement_id": { "type": [ "string", "null" ] }, "state": { "enum": [ "active", "deprecated", "retired" ], "type": "string" }, "sunset_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "state", "replacement_id", "sunset_at" ], "type": "object" }, "entitlements": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "id": { "pattern": "^[a-z][a-z0-9_]*$", "type": "string" }, "kind": { "enum": [ "editorial_style", "visual_mix_source", "visual_mix_preset", "theme", "pacing", "treatment", "voice", "avatar" ], "type": "string" }, "name": { "maxLength": 120, "type": "string" }, "ranges": { "additionalProperties": false, "properties": { "allowed_values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "allowed_values" ], "type": "object" } }, "required": [ "id", "kind", "name", "behavior", "compatibility", "ranges", "defaults", "entitlements", "deprecation" ], "type": "object" }, "VideoChannel": { "additionalProperties": false, "properties": { "configuration": { "$ref": "#/components/schemas/VideoChannelConfiguration" }, "configuration_revision": { "minimum": 1, "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "display_name": { "maxLength": 255, "minLength": 1, "type": "string" }, "handle": { "maxLength": 255, "minLength": 1, "type": "string" }, "id": { "maxLength": 255, "minLength": 1, "type": "string" }, "mode": { "maxLength": 255, "minLength": 1, "type": [ "string", "null" ] }, "origin": { "additionalProperties": false, "properties": { "kind": { "enum": [ "linked", "standalone" ], "type": "string" }, "main_channel_id": { "type": [ "string", "null" ] } }, "required": [ "kind", "main_channel_id" ], "type": "object" }, "readiness": { "additionalProperties": false, "properties": { "missing_requirements": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "ready", "incomplete" ], "type": "string" } }, "required": [ "status", "missing_requirements" ], "type": "object" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "display_name", "handle", "origin", "mode", "configuration", "readiness", "configuration_revision", "created_at", "updated_at" ], "type": "object" }, "VideoChannelCatalogIdentitySelection": { "additionalProperties": false, "properties": { "identity_status": { "enum": [ "none", "unresolved" ], "type": "string" }, "resource_id": { "type": "null" }, "selection": { "enum": [ "none", "catalog" ], "type": "string" } }, "required": [ "selection", "resource_id", "identity_status" ], "type": "object" }, "VideoChannelConfiguration": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "captions": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "style": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "enabled", "style" ], "type": "object" }, "music": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "sfx_family": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "enabled", "sfx_family" ], "type": "object" }, "pacing": { "additionalProperties": false, "properties": { "pace_profile": { "maxLength": 255, "type": [ "string", "null" ] }, "slideshow_max_seconds": { "minimum": 1, "type": [ "integer", "null" ] }, "structure_hint": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "pace_profile", "structure_hint", "slideshow_max_seconds" ], "type": "object" }, "post_processing": { "additionalProperties": false, "properties": { "profile": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "profile" ], "type": "object" }, "presenter": { "additionalProperties": false, "properties": { "avatar": { "$ref": "#/components/schemas/VideoChannelIdentitySelection" }, "layout": { "additionalProperties": false, "properties": { "position": { "maxLength": 255, "type": [ "string", "null" ] }, "style": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "style", "position" ], "type": "object" }, "look": { "$ref": "#/components/schemas/VideoChannelCatalogIdentitySelection" }, "type": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "avatar", "look", "type", "layout" ], "type": "object" }, "reference_media": { "additionalProperties": false, "properties": { "attachment_count": { "minimum": 0, "type": "integer" }, "identity_status": { "enum": [ "none", "unresolved" ], "type": "string" }, "resource_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 0, "type": "array" } }, "required": [ "attachment_count", "identity_status", "resource_ids" ], "type": "object" }, "style": { "additionalProperties": false, "properties": { "configured": { "type": "boolean" } }, "required": [ "configured" ], "type": "object" }, "theme": { "additionalProperties": false, "properties": { "id": { "maxLength": 255, "type": [ "string", "null" ] }, "overrides": { "additionalProperties": false, "properties": { "archival_treatment": { "maxLength": 255, "type": [ "string", "null" ] }, "brand_accent_color": { "maxLength": 255, "type": [ "string", "null" ] }, "brand_highlight_color": { "maxLength": 255, "type": [ "string", "null" ] }, "data_count_treatment": { "maxLength": 255, "type": [ "string", "null" ] }, "evidence_label_style": { "maxLength": 255, "type": [ "string", "null" ] }, "section_reset_treatment": { "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "brand_accent_color", "brand_highlight_color", "evidence_label_style", "section_reset_treatment", "data_count_treatment", "archival_treatment" ], "type": "object" } }, "required": [ "id", "overrides" ], "type": "object" }, "voice": { "additionalProperties": false, "properties": { "delivery_mode": { "maxLength": 255, "type": [ "string", "null" ] }, "identity_status": { "enum": [ "none", "unresolved", "resolved", "pending_migration" ], "type": "string" }, "resource_id": { "format": "uuid", "type": [ "string", "null" ] }, "selection": { "enum": [ "none", "catalog", "custom_asset" ], "type": "string" }, "speaking_rate": { "exclusiveMinimum": 0, "type": "number" } }, "required": [ "selection", "resource_id", "identity_status", "speaking_rate", "delivery_mode" ], "type": "object" } }, "required": [ "voice", "presenter", "theme", "pacing", "captions", "music", "post_processing", "reference_media", "style", "active" ], "type": "object" }, "VideoChannelIdentitySelection": { "additionalProperties": false, "properties": { "identity_status": { "enum": [ "none", "unresolved", "resolved", "pending_migration" ], "type": "string" }, "resource_id": { "format": "uuid", "type": [ "string", "null" ] }, "selection": { "enum": [ "none", "catalog", "custom_asset" ], "type": "string" } }, "required": [ "selection", "resource_id", "identity_status" ], "type": "object" }, "VideoChannelListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/VideoChannel" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "VideoChannelResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/VideoChannel" } }, "required": [ "data" ], "type": "object" }, "VideoEditSlideTextRequest": { "properties": { "block_key": { "type": "string" }, "field_edits": { "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "block_key", "field_edits" ], "type": "object" }, "VideoEditableContentResponse": { "properties": { "data": { "properties": { "edit_availability": { "description": "Whether the current revision window permits applying the staged pass or starting a new one.", "properties": { "can_apply": { "type": "boolean" }, "can_start_new_pass": { "type": "boolean" }, "edit_window_ends_at": { "format": "date-time", "type": [ "string", "null" ] }, "explanation": { "type": "string" } }, "type": "object" }, "visual_blocks": { "items": { "properties": { "available_actions": { "items": { "type": "string" }, "type": "array" }, "replace_with_media_paid": { "description": "Present only when `available_actions` includes `replace_with_media`. True means this replacement can spend one video credit.", "type": "boolean" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoGenerationRequest": { "properties": { "avatar_engine": { "enum": [ "avatar_iii", "avatar_iv", "avatar_v" ], "type": "string" }, "caption_style": { "type": "string" }, "captions_enabled": { "type": "boolean" }, "channel": { "type": "string" }, "channel_id": { "type": "integer" }, "channel_public_id": { "format": "uuid", "type": "string" }, "client_reference_id": { "type": "string" }, "editing_style": { "type": "string" }, "editorial_rhythm_pace_profile": { "type": "string" }, "library_asset_public_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "music_enabled": { "type": "boolean" }, "name": { "type": "string" }, "narration_enabled": { "type": "boolean" }, "script": { "type": "string" }, "slideshow_max_seconds": { "type": "integer" }, "source_materials": { "items": { "type": "object" }, "type": "array" }, "talking_head_source": { "type": "string" }, "visual_mix": { "type": "string" }, "voice_delivery_mode": { "type": "string" }, "voice_id": { "type": "string" }, "voice_provider": { "type": "string" }, "voice_speaking_rate": { "type": "number" } }, "required": [ "name", "script" ], "type": "object" }, "VideoOverlayTemplatesResponse": { "properties": { "data": { "items": { "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "VideoProject": { "properties": { "channel_id": { "type": [ "string", "null" ] }, "created_at": { "format": "date-time", "type": "string" }, "current_artifact": { "properties": { "published_at": { "format": "date-time", "type": [ "string", "null" ] }, "revision": { "type": "string" } }, "type": [ "object", "null" ] }, "id": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title", "status", "created_at" ], "type": "object" }, "VideoProjectDownloadResponse": { "properties": { "data": { "properties": { "download_url": { "format": "uri", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" } }, "required": [ "download_url", "expires_at" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoProjectListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/VideoProject" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/VideoAssetPagination" } }, "required": [ "data", "pagination" ], "type": "object" }, "VideoProjectResponse": { "properties": { "data": { "$ref": "#/components/schemas/VideoProject" } }, "required": [ "data" ], "type": "object" }, "VideoQualityReportFinding": { "properties": { "category": { "enum": [ "audio", "visual", "timing", "captions", "other" ], "type": "string" }, "end_time": { "type": [ "number", "null" ] }, "id": { "type": "string" }, "message": { "type": "string" }, "severity": { "enum": [ "info", "warning", "error" ], "type": "string" }, "start_time": { "type": [ "number", "null" ] } }, "required": [ "id", "category", "severity", "message" ], "type": "object" }, "VideoQualityReportResponse": { "properties": { "data": { "properties": { "artifact": { "properties": { "duration_seconds": { "type": "number" }, "revision": { "type": "string" } }, "type": [ "object", "null" ] }, "audio_status": { "type": [ "string", "null" ] }, "findings": { "items": { "$ref": "#/components/schemas/VideoQualityReportFinding" }, "type": "array" }, "measured_at": { "type": [ "string", "null" ] }, "overall_status": { "type": [ "string", "null" ] }, "status": { "enum": [ "ready", "pending", "unavailable" ], "type": "string" }, "summary": { "properties": { "count": { "type": "integer" }, "severe_count": { "type": "integer" } }, "type": "object" }, "visual_status": { "type": [ "string", "null" ] } }, "required": [ "status", "findings", "summary" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoQuoteVideoResponse": { "properties": { "data": { "properties": { "dry_run": { "const": true, "type": "boolean" }, "estimated_seconds": { "minimum": 0, "type": "integer" }, "required_credits": { "minimum": 0, "type": "integer" } }, "required": [ "dry_run", "estimated_seconds", "required_credits" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoRegenerateVisualRequest": { "properties": { "block_key": { "type": "string" }, "prompt": { "type": "string" } }, "required": [ "block_key", "prompt" ], "type": "object" }, "VideoRemoveMusicRequest": { "properties": { "remove": { "type": "boolean" } }, "required": [ "remove" ], "type": "object" }, "VideoReplaceWithMediaRequest": { "properties": { "block_key": { "type": "string" }, "media_asset_id": { "format": "uuid", "type": "string" } }, "required": [ "block_key", "media_asset_id" ], "type": "object" }, "VideoReplaceWithMediaResponse": { "properties": { "data": { "properties": { "action": { "type": "string" }, "cropped": { "type": "boolean" }, "id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "idempotent_replay": { "type": "boolean" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VideoRevisionDeleteResponse": { "properties": { "data": { "properties": { "deleted": { "type": "boolean" } }, "type": "object" }, "meta": { "properties": { "idempotent_replay": { "type": "boolean" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VideoRevisionEditResponse": { "properties": { "data": { "properties": { "action": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "idempotent_replay": { "type": "boolean" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VideoRevisionManifestResponse": { "properties": { "data": { "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoRevisionPassResponse": { "properties": { "data": { "properties": { "applied_at": { "type": [ "string", "null" ] }, "artifact": { "properties": { "published_at": { "type": [ "string", "null" ] }, "revision": { "type": "string" } }, "type": [ "object", "null" ] }, "download": { "properties": { "available": { "type": "boolean" }, "endpoint": { "type": "string" } }, "type": "object" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": [ "object", "null" ] }, "id": { "type": "string" }, "number": { "type": "integer" }, "quality_review": { "properties": { "status": { "enum": [ "pending", "ready", "unavailable" ], "type": "string" } }, "type": "object" }, "status": { "enum": [ "draft", "applying", "complete", "failed" ], "type": "string" } }, "required": [ "id", "number", "status", "download", "quality_review" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VideoShowPresenterRequest": { "properties": { "block_key": { "type": "string" }, "note": { "type": "string" } }, "required": [ "block_key" ], "type": "object" }, "VideoUpdateCaptionsRequest": { "properties": { "enabled": { "type": "boolean" }, "style": { "type": "string" } }, "required": [ "enabled", "style" ], "type": "object" }, "VideoUpdateOverlayRequest": { "properties": { "inputs": { "type": "object" } }, "required": [ "inputs" ], "type": "object" }, "VoiceProfileDescriptor": { "additionalProperties": false, "properties": { "checksum": { "type": [ "string", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "framework_version": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "profile": [], "revision": { "type": "string" }, "schema_version": { "type": [ "integer", "null" ] }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] }, "writable": { "type": "boolean" } }, "required": [ "id", "name", "framework_version", "schema_version", "checksum", "revision", "writable", "profile", "created_at", "updated_at" ], "type": "object" }, "VoiceProfileResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/VoiceProfileDescriptor" }, "meta": { "additionalProperties": false, "properties": { "idempotent_replay": { "type": "boolean" } }, "required": [ "idempotent_replay" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "VoiceProfileV2": { "$id": "https://subscribr.ai/schemas/voice-profile-v2.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "writing_style_analysis": { "additionalProperties": false, "properties": { "adherence_checklist": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 8, "minItems": 1, "type": "array" }, "delivery_recipe": { "additionalProperties": false, "properties": { "cadence": { "maxLength": 2000, "minLength": 1, "type": "string" }, "energy": { "maxLength": 2000, "minLength": 1, "type": "string" }, "pacing_and_emphasis": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" } }, "required": [ "cadence", "energy", "pacing_and_emphasis" ], "type": "object" }, "diction_and_syntax": { "additionalProperties": false, "properties": { "avoid": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" }, "preferred_constructions": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" }, "sentence_shape": { "maxLength": 2000, "minLength": 1, "type": "string" }, "vocabulary_level": { "enum": [ "simple", "conversational", "sophisticated" ], "maxLength": 32, "minLength": 1, "type": "string" }, "word_complexity": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "vocabulary_level", "word_complexity", "sentence_shape", "preferred_constructions", "avoid" ], "type": "object" }, "do_dont": { "additionalProperties": false, "properties": { "do": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "dont": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "never_does": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" } }, "required": [ "do", "dont", "never_does" ], "type": "object" }, "example_paragraph": { "maxLength": 5000, "minLength": 20, "type": "string" }, "formatting_directives": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "jargon_policy": { "additionalProperties": false, "properties": { "allow": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" }, "explain_with": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" } }, "required": [ "allow", "explain_with" ], "type": "object" }, "lexical_glossary": { "items": { "additionalProperties": false, "properties": { "definition": { "maxLength": 2000, "minLength": 1, "type": "string" }, "term": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "term", "definition" ], "type": "object" }, "maxItems": 50, "minItems": 0, "type": "array" }, "locale_and_dialect": { "maxLength": 2000, "minLength": 1, "type": "string" }, "phrase_kit": { "additionalProperties": false, "properties": { "avoid": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" }, "replacements": { "items": { "additionalProperties": false, "properties": { "avoid": { "maxLength": 500, "minLength": 1, "type": "string" }, "use": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "avoid", "use" ], "type": "object" }, "maxItems": 3, "minItems": 0, "type": "array" }, "uses": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" } }, "required": [ "uses", "avoid", "replacements" ], "type": "object" }, "rewriter_directives": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "rhetorical_toolkit": { "additionalProperties": false, "properties": { "analogy_and_evidence": { "maxLength": 2000, "minLength": 1, "type": "string" }, "cta_patterns": { "items": { "additionalProperties": false, "properties": { "location": { "enum": [ "opening", "middle", "closing" ], "maxLength": 16, "minLength": 1, "type": "string" }, "pattern": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "location", "pattern" ], "type": "object" }, "maxItems": 3, "minItems": 0, "type": "array" }, "explanation_patterns": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "hook_patterns": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "humor_and_empathy": { "maxLength": 2000, "minLength": 1, "type": "string" }, "storytelling_patterns": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "transitions": { "items": { "maxLength": 2000, "minLength": 1, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" } }, "required": [ "hook_patterns", "transitions", "explanation_patterns", "storytelling_patterns", "cta_patterns", "analogy_and_evidence", "humor_and_empathy" ], "type": "object" }, "speaker_archetype": { "additionalProperties": false, "properties": { "axes": { "additionalProperties": false, "properties": { "age_vibe": { "maxLength": 500, "minLength": 1, "type": "string" }, "authority_posture": { "maxLength": 500, "minLength": 1, "type": "string" }, "profession_archetype": { "maxLength": 500, "minLength": 1, "type": "string" }, "temperament": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "age_vibe", "profession_archetype", "temperament", "authority_posture" ], "type": "object" }, "description": { "maxLength": 2000, "minLength": 1, "type": "string" }, "label": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "label", "description", "axes" ], "type": "object" }, "spoken_patterns": { "additionalProperties": false, "properties": { "common_phrases": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" }, "starter_words": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" }, "transition_phrases": { "items": { "maxLength": 500, "minLength": 1, "type": "string" }, "maxItems": 3, "minItems": 0, "type": "array" } }, "required": [ "common_phrases", "starter_words", "transition_phrases" ], "type": "object" }, "stance_and_relationship": { "additionalProperties": false, "properties": { "audience_model": { "maxLength": 2000, "minLength": 1, "type": "string" }, "certainty_level": { "maxLength": 2000, "minLength": 1, "type": "string" }, "intimacy_distance": { "maxLength": 500, "minLength": 1, "type": "string" }, "narrative_person": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "narrative_person", "intimacy_distance", "certainty_level", "audience_model" ], "type": "object" }, "style_examples": { "items": { "maxLength": 10000, "minLength": 20, "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "thinking_style": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "speaker_archetype", "stance_and_relationship", "delivery_recipe", "rhetorical_toolkit", "diction_and_syntax", "phrase_kit", "jargon_policy", "formatting_directives", "do_dont", "locale_and_dialect", "thinking_style", "spoken_patterns", "rewriter_directives", "adherence_checklist", "lexical_glossary", "example_paragraph", "style_examples" ], "type": "object" } }, "required": [ "writing_style_analysis" ], "title": "Subscribr Voice Profile v2", "type": "object", "x-subscribr-schema-registry": "voice-profile-v2" }, "WriteIdeaResponse": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "properties": { "canvas_url": { "format": "uri", "type": "string" }, "script_id": { "type": "integer" }, "script_number": { "type": "integer" }, "thread_id": { "type": "integer" } }, "required": [ "script_id", "script_number", "thread_id", "canvas_url" ], "type": "object" }, "success": { "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" } }, "securitySchemes": { "personalAccessToken": { "bearerFormat": "Subscribr PAT", "description": "Team-bound personal access token. Operation abilities are declared by x-required-abilities.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Canonical customer automation API. Subscribr Video public operations use the /api/v1/video namespace as each implemented capability slice becomes available. Studio is the private video execution service.", "title": "Subscribr Customer API", "version": "1.0.0" }, "openapi": "3.1.2", "paths": { "/api/v1/channels": { "get": { "operationId": "listChannels", "parameters": [ { "description": "Search by channel title or handle.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "1-100, default 20.", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Page number (default 1).", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "details": { "channel_id": "UCBJycsmduvYEL83R_U4JriQ", "country": "US", "custom_url": "mkbhd", "default_language": "en", "description": "Channel description", "subscriber_count": 19000000, "thumbnails": { "default": { "url": "https://i.ytimg.com/..." } }, "title": "Marques Brownlee", "video_count": 1650, "view_count": 4200000000 }, "id": 123, "scripts_count": 42, "yt_handle": "mkbhd" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 }, "success": true }, "schema": { "$ref": "#/components/schemas/ListChannelsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Channels", "tags": [ "channels" ], "x-cli-command": "list-channels", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "channels:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "channels" } }, "/api/v1/channels/{channel}": { "get": { "operationId": "getChannel", "responses": { "200": { "content": { "application/json": { "example": { "data": { "details": { "channel_id": "UCBJycsmduvYEL83R_U4JriQ", "country": "US", "custom_url": "mkbhd", "default_language": "en", "description": "Channel description", "subscriber_count": 19000000, "thumbnails": { "default": { "url": "https://i.ytimg.com/..." } }, "title": "Marques Brownlee", "video_count": 1650, "view_count": 4200000000 }, "id": 123, "scripts_active_count": 38, "scripts_count": 42, "scripts_idea_count": 4, "settings": { "audience": "Tech enthusiasts", "language": "English" }, "voice": { "id": 77, "instructions": "Voice instructions", "name": "Default Voice", "voice": "neutral" }, "yt_handle": "mkbhd" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetChannelResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Channel", "tags": [ "channels" ], "x-cli-command": "get-channel", "x-required-abilities": [ "channels:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "channels" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/channels/{channel}/competitors": { "get": { "operationId": "listChannelCompetitors", "responses": { "200": { "content": { "application/json": { "example": { "data": [], "success": true }, "schema": { "$ref": "#/components/schemas/ListChannelCompetitorsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Channel Competitors", "tags": [ "channels" ], "x-cli-command": "list-channel-competitors", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "channels:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "channels" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "addChannelCompetitor", "requestBody": { "content": { "application/json": { "example": { "identifier": "https://www.youtube.com/@competitor" }, "schema": { "$ref": "#/components/schemas/AddChannelCompetitorRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "channel_id": 1, "competitor": { "channel_id": "UC123", "handle": "competitor", "title": "Competitor" } }, "success": true }, "schema": { "$ref": "#/components/schemas/AddChannelCompetitorResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Add Channel Competitor", "tags": [ "channels" ], "x-cli-command": "add-channel-competitor", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "channels", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/competitors/{competitor}": { "delete": { "operationId": "deleteChannelCompetitor", "responses": { "200": { "content": { "application/json": { "example": { "message": "Competitor removed.", "success": true }, "schema": { "$ref": "#/components/schemas/DeleteChannelCompetitorResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Delete Channel Competitor", "tags": [ "channels" ], "x-cli-command": "delete-channel-competitor", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "channels", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "example": 1, "in": "path", "name": "competitor", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/channels/{channel}/ideas": { "get": { "operationId": "listChannelIdeas", "parameters": [ { "description": "Filter by status: new, considering, needs_script, rejected (deprecated banger is accepted as considering). Use scripted to return ideas with a non-null script_id (not a stored status value).", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "new", "considering", "banger", "needs_script", "scripted", "rejected" ], "type": "string" } }, { "description": "Filter by source (user_added, ai_generated, from_video, from_channel, outlier, chat_saved)", "in": "query", "name": "source_type", "required": false, "schema": { "type": "string" } }, { "description": "Search in title, topic, or angle", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "1-100, default 20", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Page number (default 1)", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "angle": "Reveal the hidden implication...", "channel_id": 123, "id": 456, "notes": null, "outlier_score": null, "script_id": null, "source_type": "user_added", "status": "new", "suggested_length": 1200, "suggested_template_id": 22, "thumbnail_concept": "Split-screen before/after with bold headline", "title": "Why Apple's AI Changes Everything", "topic": "Analysis of Apple Intelligence" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 }, "success": true }, "schema": { "$ref": "#/components/schemas/ListChannelIdeasResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Channel Ideas", "tags": [ "ideas" ], "x-cli-command": "list-channel-ideas", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/IdeaApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "createChannelIdea", "requestBody": { "content": { "application/json": { "example": { "angle": "Reveal the hidden implication that most reviews miss.", "notes": "Focus on practical consequences.", "suggested_length": 1200, "suggested_template_id": 22, "thumbnail_concept": "Split-screen before/after with bold headline", "title": "Why Apple's AI Changes Everything", "topic": "Analysis of Apple Intelligence" }, "schema": { "$ref": "#/components/schemas/CreateChannelIdeaRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "angle": "Reveal the hidden implication that most reviews miss.", "channel_id": 123, "id": 456, "notes": null, "outlier_score": null, "script_id": null, "source_type": "user_added", "status": "new", "suggested_length": 1200, "suggested_template_id": 22, "thumbnail_concept": "Split-screen before/after with bold headline", "title": "Why Apple's AI Changes Everything", "topic": "Analysis of Apple Intelligence" }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateChannelIdeaResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Channel Idea", "tags": [ "ideas" ], "x-cli-command": "create-channel-idea", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/WebhookApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/ideas/generate": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "generateChannelIdeas", "requestBody": { "content": { "application/json": { "example": { "count": 10 }, "schema": { "$ref": "#/components/schemas/GenerateChannelIdeasRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "channel_id": 123, "count": 10 }, "message": "Idea generation started.", "success": true }, "schema": { "$ref": "#/components/schemas/GenerateChannelIdeasResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Generate Channel Ideas", "tags": [ "ideas" ], "x-cli-command": "generate-channel-ideas", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/IdeaApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/ideas/generate-from-channel": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "generateIdeasFromChannel", "requestBody": { "content": { "application/json": { "example": { "channel_handle": "@mkbhd", "count": 10 }, "schema": { "$ref": "#/components/schemas/GenerateIdeasFromChannelRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "channel_id": 123, "count": 10, "source_channel_title": "Marques Brownlee" }, "message": "Idea generation from channel started.", "success": true }, "schema": { "$ref": "#/components/schemas/GenerateIdeasFromChannelResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Generate Ideas From Channel", "tags": [ "ideas" ], "x-cli-command": "generate-ideas-from-channel", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/IdeaApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/ideas/generate-from-video": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "generateIdeasFromVideo", "requestBody": { "content": { "application/json": { "example": { "count": 10, "video_url": "https://youtube.com/watch?v=dQw4w9WgXcQ" }, "schema": { "$ref": "#/components/schemas/GenerateIdeasFromVideoRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "channel_id": 123, "count": 10 }, "message": "Idea generation from video started.", "success": true }, "schema": { "$ref": "#/components/schemas/GenerateIdeasFromVideoResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Generate Ideas From Video", "tags": [ "ideas" ], "x-cli-command": "generate-ideas-from-video", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/scripts": { "get": { "operationId": "listChannelScripts", "parameters": [ { "description": "Filter by status (active, idea)", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "Filter by format (Tutorial, Documentary, News, Interview, Compilation)", "in": "query", "name": "format", "required": false, "schema": { "type": "string" } }, { "description": "Search in title/topic", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Results per page. Min 1, max 100. Default 20.", "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Page number. Min 1. Default 1.", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "angle": "Explain the hidden implication most reviews miss", "canvas_url": "https://subscribr.ai/chat/my-channel-thread/canvas/789", "channel_id": 123, "format": "Tutorial", "has_outline": true, "has_script": false, "id": 789, "language": "English", "length": 1200, "production_status": "scripting", "script_number": 12, "status": "active", "template_id": 22, "thread_id": 456, "title": "Why Apple's AI Changes Everything", "topic": "Break down the key changes...", "voice": "neutral" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 }, "success": true }, "schema": { "$ref": "#/components/schemas/ListChannelScriptsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Channel Scripts", "tags": [ "scripts" ], "x-cli-command": "list-channel-scripts", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "createChannelScript", "requestBody": { "content": { "application/json": { "example": { "angle": "Explain the hidden implication most reviews miss", "language": "English", "length": 1200, "prompt": "Custom starting prompt", "research_texts": [ "Key bullet points" ], "research_urls": [ "https://example.com/source-1" ], "template_id": 22, "title": "Why Apple's AI Changes Everything", "topic": "Break down the key changes in Apple Intelligence and what they mean.", "voice": "neutral", "voice_id": 55 }, "schema": { "$ref": "#/components/schemas/CreateChannelScriptRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "canvas_url": "https://subscribr.ai/chat/my-channel-thread/canvas/789", "script_id": 789, "script_number": 12, "status": "active", "thread_id": 456 }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateChannelScriptResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Channel Script", "tags": [ "scripts" ], "x-cli-command": "create-channel-script", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ScriptCreditChargeApiTest.php", "tests/Feature/Api/CreateScriptNullableFieldsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/templates": { "get": { "operationId": "listChannelTemplates", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "custom_count": 0, "custom_truncated": false, "default_template_id": null, "system_count": 20 } }, "schema": { "$ref": "#/components/schemas/TemplateListResponse" } } }, "description": "Stable side-effect-free template list." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List built-in and custom Channel templates", "tags": [ "templates" ], "x-cli-command": "list-channel-templates", "x-pagination": { "stable_order": true, "style": "bounded-list" }, "x-required-abilities": [ "templates:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "createTemplate", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "example": { "description": "A concise teaching format.", "name": "My explainer", "prompt": "Write a clear, structured explainer with a compelling opening, concrete examples, and a concise conclusion for the target audience." }, "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "archived": false, "category": "custom", "created_at": "2026-07-22T12:00:00Z", "description": "A concise teaching format.", "id": 22, "is_default": false, "key": null, "kind": "custom", "mutable": true, "name": "My explainer", "prompt": "Write a clear structured explainer with a compelling opening and concrete examples for the intended audience.", "revision": "template-r1-example", "slug": "my-explainer", "updated_at": "2026-07-22T12:00:00Z" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/TemplateResponse" } } }, "description": "Created custom template.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create a custom Channel template", "tags": [ "templates" ], "x-cli-command": "create-template", "x-required-abilities": [ "templates:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates", "x-write-safety": { "concurrency": "unsupported", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/templates/{template}": { "get": { "operationId": "getTemplate", "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": false, "category": "custom", "created_at": "2026-07-22T12:00:00Z", "description": null, "id": 22, "is_default": false, "key": null, "kind": "custom", "mutable": true, "name": "My explainer", "prompt": "Write a clear structured explainer with a compelling opening and concrete examples for the intended audience.", "revision": "template-r1-example", "slug": "my-explainer", "updated_at": "2026-07-22T12:00:00Z" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/TemplateResponse" } } }, "description": "Custom template.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a custom Channel template", "tags": [ "templates" ], "x-cli-command": "get-template", "x-required-abilities": [ "templates:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates" }, "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "in": "path", "name": "template", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "patch": { "operationId": "updateTemplate", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "name": "My revised explainer" }, "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": false, "category": "custom", "created_at": "2026-07-22T12:00:00Z", "description": null, "id": 22, "is_default": false, "key": null, "kind": "custom", "mutable": true, "name": "My revised explainer", "prompt": "Write a clear structured explainer with a compelling opening and concrete examples for the intended audience.", "revision": "template-r1-updated", "slug": "my-revised-explainer", "updated_at": "2026-07-22T12:05:00Z" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/TemplateResponse" } } }, "description": "Updated custom template.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update a custom Channel template", "tags": [ "templates" ], "x-cli-command": "update-template", "x-required-abilities": [ "templates:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/templates/{template}/archive": { "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "in": "path", "name": "template", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "archiveTemplate", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": true, "category": "custom", "created_at": "2026-07-22T12:00:00Z", "description": null, "id": 22, "is_default": false, "key": null, "kind": "custom", "mutable": true, "name": "My explainer", "prompt": "Write a clear structured explainer with a compelling opening and concrete examples for the intended audience.", "revision": "template-r1-archived", "slug": "my-explainer", "updated_at": "2026-07-22T12:05:00Z" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/TemplateResponse" } } }, "description": "Archived custom template.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Archive a custom Channel template", "tags": [ "templates" ], "x-cli-command": "archive-template", "x-required-abilities": [ "templates:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/templates/{template}/restore": { "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "in": "path", "name": "template", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "restoreTemplate", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": false, "category": "custom", "created_at": "2026-07-22T12:00:00Z", "description": null, "id": 22, "is_default": false, "key": null, "kind": "custom", "mutable": true, "name": "My explainer", "prompt": "Write a clear structured explainer with a compelling opening and concrete examples for the intended audience.", "revision": "template-r1-restored", "slug": "my-explainer", "updated_at": "2026-07-22T12:10:00Z" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/TemplateResponse" } } }, "description": "Restored custom template.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Restore an archived custom Channel template", "tags": [ "templates" ], "x-cli-command": "restore-template", "x-required-abilities": [ "templates:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/TemplateApiTest.php" ], "behavior": [ "tests/Feature/Api/TemplateApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "templates", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/thumbnails/board": { "get": { "description": "Read the Channel's Thumbnail Studio board: every image tile and text overlay with position, status, and URL. Items with status \"generating\" are still rendering; poll this endpoint until they turn \"ready\".", "operationId": "getThumbnailBoard", "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "channel_id": 1, "credits_remaining": 42, "items": [ { "frame_id": 310, "height": 180, "id": 311, "label": "How I fixed my retention", "source": "youtube_video", "status": "ready", "type": "image", "url": "https://subscribr.ai/storage/thumbnails/boards/311.png", "width": 320, "x": 48, "y": 128 } ], "studio_url": "https://subscribr.ai/channels/1/thumbnails" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetThumbnailBoardResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Thumbnail Board", "tags": [ "thumbnails" ], "x-cli-command": "get-thumbnail-board", "x-required-abilities": [ "thumbnails:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/channels/{channel}/thumbnails/board/assign-to-script": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Make a ready board image the thumbnail of a project (script) on this Channel — the same exclusive winner semantics as selecting a thumbnail on the Kanban board.", "operationId": "assignThumbnailBoardImageToScript", "requestBody": { "content": { "application/json": { "example": { "item_id": 314, "script_id": 88 }, "schema": { "$ref": "#/components/schemas/AssignThumbnailBoardImageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "attachment_id": 402, "script_id": 88, "thumbnail_url": "https://subscribr.ai/storage/kanban-attachments/402.png" }, "success": true }, "schema": { "$ref": "#/components/schemas/AssignThumbnailBoardImageResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Assign Thumbnail Board Image To Script", "tags": [ "thumbnails" ], "x-cli-command": "assign-thumbnail-board-image-to-script", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/thumbnails/board/edits": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Spend 1 thumbnail credit to edit one ready board image with a plain-language instruction. Non-destructive: the result arrives as a new item beside the original, which is never altered. Pass an optional region to confine the change to a rectangle, in which case pixels outside it are guaranteed identical to the original. Rendering is asynchronous; poll getThumbnailBoard until the returned item turns \"ready\".", "operationId": "editThumbnailBoardImage", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "instruction": "Remove the text", "item_id": 312, "region": { "height": 0.35, "width": 0.6, "x": 0.05, "y": 0.55 } }, "schema": { "$ref": "#/components/schemas/EditThumbnailBoardImageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "credits_remaining": 39, "credits_spent": 1, "items": [ { "height": 180, "id": 318, "prompt": "Remove the text", "source": "generation", "status": "generating", "type": "image", "width": 320, "x": 392, "y": 360 } ], "note": "The edit renders asynchronously as a new item beside the original, which is left unchanged. Poll GET /thumbnails/board until it turns \"ready\"." }, "success": true }, "schema": { "$ref": "#/components/schemas/EditThumbnailBoardImageResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Edit Thumbnail Board Image", "tags": [ "thumbnails" ], "x-cli-command": "edit-thumbnail-board-image", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/thumbnails/board/export": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Flatten one ready image with its overlapping text overlays into a final 1280x720 PNG. Returns the stored URL and adds the export back onto the board as a new item.", "operationId": "exportThumbnailBoardImage", "requestBody": { "content": { "application/json": { "example": { "item_id": 311 }, "schema": { "$ref": "#/components/schemas/ExportThumbnailBoardImageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "item": { "height": 180, "id": 314, "source": "export", "status": "ready", "type": "image", "url": "https://subscribr.ai/storage/thumbnails/boards/export-314.png", "width": 320, "x": 408, "y": 128 }, "overlays_flattened": 1, "url": "https://subscribr.ai/storage/thumbnails/boards/export-314.png" }, "success": true }, "schema": { "$ref": "#/components/schemas/ExportThumbnailBoardImageResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Export Thumbnail Board Image", "tags": [ "thumbnails" ], "x-cli-command": "export-thumbnail-board-image", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/thumbnails/board/generations": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Spend 1 thumbnail credit per variation to render new thumbnails from a prompt plus selected reference item ids. Rendering is asynchronous; poll getThumbnailBoard until the returned items turn \"ready\".", "operationId": "createThumbnailBoardGeneration", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "allow_text": false, "prompt": "Shocked face pointing at a giant chart", "reference_item_ids": [ 311 ], "variations": 2 }, "schema": { "$ref": "#/components/schemas/CreateThumbnailBoardGenerationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "credits_remaining": 40, "credits_spent": 2, "items": [ { "height": 180, "id": 312, "prompt": "Shocked face pointing at a giant chart", "source": "generation", "status": "generating", "type": "image", "width": 320, "x": 48, "y": 360 } ], "note": "Rendering is asynchronous (typically 10-60 seconds per image). Poll GET /thumbnails/board until these items turn \"ready\"." }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateThumbnailBoardGenerationResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Thumbnail Board Generation", "tags": [ "thumbnails" ], "x-cli-command": "create-thumbnail-board-generation", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/thumbnails/board/images": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Import reference images onto the board as a labeled frame. Sources my_recent, my_top_viewed, and my_top_outlier pull the Channel's own YouTube thumbnails; source urls adds external image URLs, optionally tagged with a usage such as creator_face or style.", "operationId": "addThumbnailBoardImages", "requestBody": { "content": { "application/json": { "example": { "label": "Competitor picks", "source": "urls", "urls": [ "https://example.com/reference.png" ], "usage": "style" }, "schema": { "$ref": "#/components/schemas/AddThumbnailBoardImagesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "items": [ { "frame_id": 310, "height": 180, "id": 311, "label": "How I fixed my retention", "source": "youtube_video", "status": "ready", "type": "image", "url": "https://subscribr.ai/storage/thumbnails/boards/311.png", "width": 320, "x": 48, "y": 128 } ] }, "success": true }, "schema": { "$ref": "#/components/schemas/AddThumbnailBoardImagesResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Add Thumbnail Board Images", "tags": [ "thumbnails" ], "x-cli-command": "add-thumbnail-board-images", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/thumbnails/board/text": { "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "description": "Add or update an editable headline overlay. Text stays out of the generated image on purpose; place a new overlay with over_item_id to cover an image, or pass item_id to update an existing overlay.", "operationId": "setThumbnailBoardText", "requestBody": { "content": { "application/json": { "example": { "content": "I WAS WRONG", "over_item_id": 311, "size": 64 }, "schema": { "$ref": "#/components/schemas/SetThumbnailBoardTextRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "board_id": 12, "item": { "content": "I WAS WRONG", "height": 60, "id": 313, "source": "agent", "status": "ready", "type": "text", "width": 292, "x": 62, "y": 140 } }, "success": true }, "schema": { "$ref": "#/components/schemas/SetThumbnailBoardTextResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Set Thumbnail Board Text", "tags": [ "thumbnails" ], "x-cli-command": "set-thumbnail-board-text", "x-required-abilities": [ "thumbnails:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailBoardApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/thumbnails/generations": { "get": { "operationId": "listThumbnailGenerations", "parameters": [ { "description": "Filter by ThumbnailUsageEvent source_type: api_generate (idea-based and brainstorm API runs), idea_improve, thumbnail_clone", "in": "query", "name": "source_type", "required": false, "schema": { "type": "string" } }, { "description": "Page number (default 1).", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "created_at": "2026-02-27T10:30:00Z", "idea_id": 42, "output_urls": [ "https://subscribr.ai/storage/thumbnails/9b1deb4d_v1.png" ], "run_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "source_type": "api_generate", "status": "completed" } ], "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 42 }, "success": true }, "schema": { "$ref": "#/components/schemas/ListThumbnailGenerationsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Thumbnail Generations", "tags": [ "thumbnails" ], "x-cli-command": "list-thumbnail-generations", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "scripts:read", "thumbnails:read" ], "x-required-ability-mode": "any", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "createThumbnailGeneration", "requestBody": { "content": { "application/json": { "example": { "callback_secret": "whsec_thumbnail_partner_secret", "callback_url": "https://partner.example.com/subscribr/thumbnail-callback", "idea_id": 42, "num_variations": 3 }, "schema": { "$ref": "#/components/schemas/CreateThumbnailGenerationRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "run_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "run_ids": [ "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ], "status": "queued" }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateThumbnailGenerationResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Thumbnail Generation", "tags": [ "thumbnails" ], "x-cli-command": "create-thumbnail-generation", "x-required-abilities": [ "scripts:write", "thumbnails:write" ], "x-required-ability-mode": "any", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/channels/{channel}/thumbnails/generations/{runId}": { "get": { "operationId": "getThumbnailGeneration", "responses": { "200": { "content": { "application/json": { "example": { "data": { "created_at": "2026-02-27T10:30:00Z", "idea_id": null, "output_urls": [ "https://subscribr.ai/storage/thumbnails/9b1deb4d_v1.png", "https://subscribr.ai/storage/thumbnails/9b1deb4d_v2.png" ], "run_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "status": "completed", "updated_at": "2026-02-27T10:30:45Z" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetThumbnailGenerationResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Thumbnail Generation", "tags": [ "thumbnails" ], "x-cli-command": "get-thumbnail-generation", "x-required-abilities": [ "scripts:read", "thumbnails:read" ], "x-required-ability-mode": "any", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "example": "run_123", "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } } ] }, "/api/v1/channels/{channel}/voices": { "get": { "operationId": "listChannelVoices", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "checksum": "9b2d", "created_at": "2026-07-22T12:00:00Z", "framework_version": 2, "id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "name": "Default Voice", "profile": { "writing_style_analysis": [] }, "revision": "voice-r1-example", "schema_version": 2, "updated_at": "2026-07-22T12:00:00Z", "writable": true } ], "meta": { "default_voice_id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "truncated": false } }, "schema": { "$ref": "#/components/schemas/ListChannelVoicesResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Channel Voices", "tags": [ "channels" ], "x-cli-command": "list-channel-voices", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "voices:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "behavior": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "voices" }, "parameters": [ { "example": 1, "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/channels/{channel}/voices/commit": { "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "commitVoiceProfile", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } }, { "description": "Required for update receipts and prohibited for create receipts.", "in": "header", "name": "If-Match", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "profile": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } }, "receipt": "vr2.current.opaque-token" }, "schema": { "$ref": "#/components/schemas/CommitVoiceProfileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "checksum": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "created_at": "2026-07-22T12:00:00Z", "framework_version": 2, "id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "name": "Practical guide", "profile": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } }, "revision": "voice-r1-example", "schema_version": 2, "updated_at": "2026-07-22T12:05:00Z", "writable": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VoiceProfileResponse" } } }, "description": "Updated Voice Profile.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "201": { "content": { "application/json": { "example": { "data": { "checksum": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "created_at": "2026-07-22T12:00:00Z", "framework_version": 2, "id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "name": "Practical guide", "profile": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } }, "revision": "voice-r1-example", "schema_version": 2, "updated_at": "2026-07-22T12:00:00Z", "writable": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VoiceProfileResponse" } } }, "description": "Created Voice Profile.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Commit an exactly validated Voice Profile receipt", "tags": [ "voices" ], "x-cli-command": "commit-voice-profile", "x-required-abilities": [ "voices:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "behavior": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "voices", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/channels/{channel}/voices/validate": { "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "validateVoiceProfile", "requestBody": { "content": { "application/json": { "example": { "intent": "create", "name": "Practical guide", "profile": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } } }, "schema": { "$ref": "#/components/schemas/ValidateVoiceProfileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "checksum": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "diff": [ "voice.created" ], "expected_revision": null, "expires_at": "2026-07-22T12:10:00Z", "normalized": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } }, "receipt": "vr2.current.opaque-token", "schema_version": 2, "voice_id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "warnings": [] } }, "schema": { "$ref": "#/components/schemas/ValidateVoiceProfileResponse" } } }, "description": "Validated canonical payload and bound short-lived receipt." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Validate and canonicalize a complete Voice Profile v2 without mutating data", "tags": [ "voices" ], "x-cli-command": "validate-voice-profile", "x-required-abilities": [ "voices:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "behavior": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "voices", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "revalidate" } } }, "/api/v1/channels/{channel}/voices/{voice}": { "get": { "operationId": "getVoiceProfile", "responses": { "200": { "content": { "application/json": { "example": { "data": { "checksum": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "created_at": "2026-07-22T12:00:00Z", "framework_version": 2, "id": "2d3b57bd-916d-4ce2-a85b-a65dc8fc97b4", "name": "Practical guide", "profile": { "writing_style_analysis": { "adherence_checklist": [ "No invented specifics." ], "delivery_recipe": { "cadence": "Short claims.", "energy": "Warm.", "pacing_and_emphasis": [ "Front-load the point." ] }, "diction_and_syntax": { "avoid": [ "Empty jargon." ], "preferred_constructions": [ "Here is the tradeoff." ], "sentence_shape": "Mix short and medium sentences.", "vocabulary_level": "conversational", "word_complexity": "Prefer short words." }, "do_dont": { "do": [ "Lead with value." ], "dont": [ "Invent facts." ], "never_does": [ "Hide uncertainty." ] }, "example_paragraph": "Start with the decision your viewer needs to make. Then give them only the evidence that changes it.", "formatting_directives": [ "Use short paragraphs." ], "jargon_policy": { "allow": [], "explain_with": [ "a tiny example" ] }, "lexical_glossary": [], "locale_and_dialect": "Natural American English.", "phrase_kit": { "avoid": [], "replacements": [], "uses": [] }, "rewriter_directives": [ "Address the listener as you." ], "rhetorical_toolkit": { "analogy_and_evidence": "Use one analogy.", "cta_patterns": [], "explanation_patterns": [ "Make it concrete." ], "hook_patterns": [ "Open with a misconception." ], "humor_and_empathy": "Keep humor light.", "storytelling_patterns": [ "Start at the decision." ], "transitions": [ "Here is the useful part." ] }, "speaker_archetype": { "axes": { "age_vibe": "experienced peer", "authority_posture": "confident", "profession_archetype": "strategist", "temperament": "calm" }, "description": "Calm expert.", "label": "Practical guide" }, "spoken_patterns": { "common_phrases": [], "starter_words": [], "transition_phrases": [] }, "stance_and_relationship": { "audience_model": "Experienced creators.", "certainty_level": "Names uncertainty.", "intimacy_distance": "trusted peer", "narrative_person": "second person" }, "style_examples": [ "Start with the decision your viewer needs to make. Then build the explanation around the evidence that changes that decision." ], "thinking_style": "Test conclusions against evidence." } }, "revision": "voice-r1-example", "schema_version": 2, "updated_at": "2026-07-22T12:00:00Z", "writable": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VoiceProfileResponse" } } }, "description": "Voice Profile.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Channel Voice Profile", "tags": [ "voices" ], "x-cli-command": "get-voice-profile", "x-required-abilities": [ "voices:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "behavior": [ "tests/Feature/Api/VoiceProfileApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "voices" }, "parameters": [ { "in": "path", "name": "channel", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "in": "path", "name": "voice", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/api/v1/ideas/{idea}": { "get": { "operationId": "getIdea", "responses": { "200": { "content": { "application/json": { "example": { "data": { "angle": "Reveal the hidden implication...", "channel_id": 123, "id": 456, "notes": null, "outlier_score": null, "script_id": null, "source_type": "user_added", "status": "new", "suggested_length": 1200, "suggested_template_id": 22, "thumbnail_concept": "Split-screen before/after", "title": "Why Apple's AI Changes Everything", "topic": "Analysis of Apple Intelligence" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetIdeaResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Idea", "tags": [ "ideas" ], "x-cli-command": "get-idea", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas" }, "parameters": [ { "example": 1, "in": "path", "name": "idea", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/ideas/{idea}/change-topic": { "parameters": [ { "example": 1, "in": "path", "name": "idea", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "changeIdeaTopic", "requestBody": { "content": { "application/json": { "example": { "topic": "Instead of productivity apps, apply this to morning routines" }, "schema": { "$ref": "#/components/schemas/ChangeIdeaTopicRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "idea_id": 456 }, "message": "Topic change started.", "success": true }, "schema": { "$ref": "#/components/schemas/ChangeIdeaTopicResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Change Idea Topic", "tags": [ "ideas" ], "x-cli-command": "change-idea-topic", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ChangeIdeaTopicTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/ideas/{idea}/write": { "parameters": [ { "example": 1, "in": "path", "name": "idea", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "writeIdea", "responses": { "201": { "content": { "application/json": { "example": { "data": { "canvas_url": "https://subscribr.ai/chat/my-channel-thread/canvas/789", "script_id": 789, "script_number": 12, "thread_id": 456 }, "success": true }, "schema": { "$ref": "#/components/schemas/WriteIdeaResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Write Idea", "tags": [ "ideas" ], "x-cli-command": "write-idea", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "ideas", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/intel/bookmarks": { "get": { "operationId": "listIntelBookmarks", "parameters": [ { "description": "GET only — page number (default 1, 50 per page)", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "DELETE only — bookmark ID at /intel/bookmarks/{bookmark}", "in": "query", "name": "bookmark", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "pagination": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 0 }, "success": true }, "schema": { "$ref": "#/components/schemas/ListIntelBookmarksResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Intel Bookmarks", "tags": [ "intel" ], "x-cli-command": "list-intel-bookmarks", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "intel:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel" }, "post": { "operationId": "createIntelBookmark", "parameters": [ { "description": "GET only — page number (default 1, 50 per page)", "in": "query", "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "description": "DELETE only — bookmark ID at /intel/bookmarks/{bookmark}", "in": "query", "name": "bookmark", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "external_id": "UCBJycsmduvYEL83R_U4JriQ", "notes": "Strong format", "tags": [ "competitor" ], "title": "Competitor: MKBHD", "type": "channel", "url": "https://youtube.com/@mkbhd" }, "schema": { "$ref": "#/components/schemas/CreateIntelBookmarkRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "external_id": "UCBJycsmduvYEL83R_U4JriQ", "id": 1, "notes": "Strong format", "tags": [ "competitor" ], "title": "Competitor: MKBHD", "type": "channel", "url": "https://youtube.com/@mkbhd" }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateIntelBookmarkResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Intel Bookmark", "tags": [ "intel" ], "x-cli-command": "create-intel-bookmark", "x-required-abilities": [ "intel:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/intel/bookmarks/{bookmark}": { "delete": { "operationId": "deleteIntelBookmark", "responses": { "200": { "content": { "application/json": { "example": { "message": "Bookmark deleted successfully", "success": true }, "schema": { "$ref": "#/components/schemas/DeleteIntelBookmarkResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Delete Intel Bookmark", "tags": [ "intel" ], "x-cli-command": "delete-intel-bookmark", "x-required-abilities": [ "intel:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } }, "parameters": [ { "example": 1, "in": "path", "name": "bookmark", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/intel/channels/lookup": { "post": { "operationId": "lookupIntelChannel", "requestBody": { "content": { "application/json": { "example": { "identifiers": [ "@mkbhd", "UCBJycsmduvYEL83R_U4JriQ" ] }, "schema": { "$ref": "#/components/schemas/LookupIntelChannelRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "channels": [ { "channel_id": "UCBJycsmduvYEL83R_U4JriQ", "country": "US", "description": "Channel description (truncated to 500 chars)", "handle": "mkbhd", "published_at": "2008-01-20T00:00:00Z", "subscriber_count": 19000000, "thumbnails": { "default": { "url": "https://i.ytimg.com/..." } }, "title": "Marques Brownlee", "video_count": 1650, "view_count": 4200000000 } ], "errors": [] }, "success": true }, "schema": { "$ref": "#/components/schemas/LookupIntelChannelResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Lookup Intel Channel", "tags": [ "intel" ], "x-cli-command": "lookup-intel-channel", "x-required-abilities": [ "intel:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/intel/channels/search": { "post": { "operationId": "searchIntelChannels", "requestBody": { "content": { "application/json": { "example": { "limit": 10, "query": "tech reviews" }, "schema": { "$ref": "#/components/schemas/SearchIntelChannelsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "channels": [ { "channel_id": "UCBJycsmduvYEL83R_U4JriQ", "country": "US", "description": "Channel description (truncated to 500 chars)", "handle": "mkbhd", "published_at": "2008-01-20T00:00:00Z", "subscriber_count": 19000000, "thumbnails": { "default": { "url": "https://i.ytimg.com/..." } }, "title": "Marques Brownlee", "video_count": 1650, "view_count": 4200000000 } ], "message": "Channels found matching your criteria.", "query": "tech reviews", "total_results": 1 }, "success": true }, "schema": { "$ref": "#/components/schemas/SearchIntelChannelsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Search Intel Channels", "tags": [ "intel" ], "x-cli-command": "search-intel-channels", "x-required-abilities": [ "intel:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/IntelSearchRerankApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/intel/videos/lookup": { "post": { "operationId": "lookupIntelVideo", "requestBody": { "content": { "application/json": { "example": { "identifiers": [ "dQw4w9WgXcQ", "https://youtube.com/watch?v=abc123" ] }, "schema": { "$ref": "#/components/schemas/LookupIntelVideoRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "errors": [], "videos": [ { "angle": "Nostalgia", "channel": { "channel_id": "UCuAXFkgsw1L7xaCfnd5JJOw", "handle": "RickAstleyVEVO", "title": "Rick Astley" }, "comment_count": 10000, "description": "Video description", "duration": "PT3M33S", "format": "Music", "goals": "Entertainment", "like_count": 50000, "outlier_score": 1.25, "published_at": "2009-10-25T06:57:33Z", "thumbnail_url": "https://i.ytimg.com/...", "title": "Video Title", "topic": "Pop", "video_id": "dQw4w9WgXcQ", "view_count": 1000000 } ] }, "success": true }, "schema": { "$ref": "#/components/schemas/LookupIntelVideoResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Lookup Intel Video", "tags": [ "intel" ], "x-cli-command": "lookup-intel-video", "x-required-abilities": [ "intel:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/intel/videos/search": { "post": { "operationId": "searchIntelVideos", "requestBody": { "content": { "application/json": { "example": { "limit": 20, "query": "iPhone 15 review" }, "schema": { "$ref": "#/components/schemas/SearchIntelVideosRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "message": "Videos found matching your criteria.", "query": "iPhone 15 review", "total_results": 1, "videos": [ { "angle": "Hands-on", "channel": { "channel_id": "UCBJycsmduvYEL83R_U4JriQ", "handle": "mkbhd", "title": "Marques Brownlee" }, "comment_count": 1200, "description": "Description (truncated to 300 chars)...", "duration": "PT12M", "format": "Review", "goals": "Inform", "like_count": 15000, "outlier_score": 1.12, "published_at": "2026-01-01T00:00:00Z", "thumbnail_url": "https://i.ytimg.com/...", "title": "iPhone 15 Review", "topic": "Smartphones", "video_id": "abc123", "view_count": 500000 } ] }, "success": true }, "schema": { "$ref": "#/components/schemas/SearchIntelVideosResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Search Intel Videos", "tags": [ "intel" ], "x-cli-command": "search-intel-videos", "x-required-abilities": [ "intel:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/IntelSearchRerankApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "intel", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/operations/{operation}": { "get": { "operationId": "getOperation", "parameters": [ { "in": "path", "name": "operation", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "domain_resource": null, "error": null, "id": "6b33d5a6-72c8-4e1e-9bc4-8024f38be3fb", "progress": 10, "result": null, "retry": { "action": null, "after": null, "supported": false }, "status": "running", "timestamps": { "created_at": "2026-07-29T00:00:00+00:00", "expires_at": "2026-08-05T00:00:00+00:00", "finished_at": null, "started_at": "2026-07-29T00:00:01+00:00" }, "type": "generate_ideas", "warnings": [] } }, "schema": { "$ref": "#/components/schemas/GetOperationResponse" } } }, "description": "Operation status." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get an asynchronous operation", "tags": [ "operations" ], "x-cli-command": "get-operation", "x-required-abilities": [ "operations:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Operations/OperationApiTest.php" ], "behavior": [ "tests/Feature/Api/Operations/OperationApiTest.php", "tests/Feature/Mcp/CustomerMcpReceiptAndOperationTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "operations" } }, "/api/v1/project-notifications": { "get": { "operationId": "listProjectNotifications", "parameters": [ { "$ref": "#/components/parameters/Cursor" }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "unread", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "next_cursor": null } }, "schema": { "$ref": "#/components/schemas/ProjectNotificationListResponse" } } }, "description": "Allowlisted notifications." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Project notifications", "tags": [ "notifications" ], "x-cli-command": "list-project-notifications", "x-pagination": { "stable_order": true, "style": "cursor" }, "x-required-abilities": [ "notifications:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" } }, "/api/v1/project-notifications/read-all": { "post": { "operationId": "readAllProjectNotifications", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "marked_read": 2 } }, "schema": { "$ref": "#/components/schemas/ReadAllProjectNotificationsResponse" } } }, "description": "Count marked read." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Mark all Project notifications read", "tags": [ "notifications" ], "x-cli-command": "read-all-project-notifications", "x-required-abilities": [ "notifications:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/project-notifications/{notification}/read": { "post": { "operationId": "readProjectNotification", "parameters": [ { "in": "path", "name": "notification", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actor": null, "created_at": "2026-07-22T11:00:00+00:00", "id": "00000000-0000-4000-8000-000000000001", "message": "Moved project", "project_id": "project:v1:script:1", "read_at": "2026-07-22T12:00:00+00:00", "target_available": true, "type": "kanban_script_status_changed" } }, "schema": { "$ref": "#/components/schemas/ProjectNotificationResponse" } } }, "description": "Updated notification." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Mark one Project notification read", "tags": [ "notifications" ], "x-cli-command": "read-project-notification", "x-required-abilities": [ "notifications:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects": { "get": { "operationId": "listProjects", "parameters": [ { "$ref": "#/components/parameters/Cursor" }, { "in": "query", "name": "channel_ids[]", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" } }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "include_archived", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "next_cursor": null } }, "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } }, "description": "Projects page." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Projects", "tags": [ "projects" ], "x-cli-command": "list-projects", "x-pagination": { "stable_order": true, "style": "cursor" }, "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" }, "post": { "operationId": "createProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "channel_id": 1, "source": "idea", "stage": "new", "title": "New idea" }, "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision", "source": "idea", "title": "New idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Created Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Project", "tags": [ "projects" ], "x-cli-command": "create-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}": { "get": { "operationId": "getProject", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision", "source": "idea", "title": "Idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Project", "tags": [ "projects" ], "x-cli-command": "get-project", "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" }, "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "patch": { "operationId": "updateProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "title": "Updated title" }, "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision-2", "source": "idea", "title": "Updated title" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Updated Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update Project", "tags": [ "projects" ], "x-cli-command": "update-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/activity": { "get": { "operationId": "listProjectActivity", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "truncated": false } }, "schema": { "$ref": "#/components/schemas/ProjectActivityListResponse" } } }, "description": "Bounded activity." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Project activity", "tags": [ "projects" ], "x-cli-command": "list-project-activity", "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" } }, "/api/v1/projects/{project}/archive": { "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "post": { "operationId": "archiveProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision-2", "source": "idea", "title": "Idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Archived Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Archive Project", "tags": [ "projects" ], "x-cli-command": "archive-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/attachments": { "get": { "operationId": "listProjectAttachments", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "truncated": false } }, "schema": { "$ref": "#/components/schemas/ProjectAttachmentListResponse" } } }, "description": "Bounded metadata without content or signed URLs." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Project attachment metadata", "tags": [ "projects" ], "x-cli-command": "list-project-attachments", "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" } }, "/api/v1/projects/{project}/comments": { "get": { "operationId": "listProjectComments", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "truncated": false } }, "schema": { "$ref": "#/components/schemas/ProjectCommentListResponse" } } }, "description": "Bounded comments." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Project comments", "tags": [ "projects" ], "x-cli-command": "list-project-comments", "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" }, "post": { "operationId": "createProjectComment", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "body": "Ready for review.", "mentioned_user_ids": [] }, "schema": { "$ref": "#/components/schemas/CreateProjectCommentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "author": { "id": 1, "name": "Creator" }, "body": "Ready for review.", "created_at": "2026-07-22T12:00:00+00:00", "edited_at": null, "id": 1, "mentioned_user_ids": [] }, "meta": { "no_op": false } }, "schema": { "$ref": "#/components/schemas/ProjectCommentResponse" } } }, "description": "Created comment." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Project comment", "tags": [ "projects" ], "x-cli-command": "create-project-comment", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "optional", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/move": { "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "post": { "operationId": "moveProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "stage": "considering" }, "schema": { "$ref": "#/components/schemas/MoveProjectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision-2", "source": "idea", "title": "Idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Moved Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Move Project", "tags": [ "projects" ], "x-cli-command": "move-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/production": { "get": { "operationId": "getProjectProduction", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "checklist": [], "checklist_total": 0, "checklist_truncated": false, "project_id": "project:v1:script:1", "stage": "upload", "thumbnail": { "review_notes": null, "review_status": null, "reviewed_at": null, "text": null, "winner_selected": false }, "upload": { "all_required_checked": true, "description": null, "made_for_kids": false, "publish_at": null, "status": null, "tags": [], "visibility": "public" } }, "meta": { "idempotent_replay": false, "revision": "project-r1-example" } }, "schema": { "$ref": "#/components/schemas/ProjectProductionResponse" } } }, "description": "Production metadata.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Project production metadata", "tags": [ "projects" ], "x-cli-command": "get-project-production", "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectProductionApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectProductionApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" }, "patch": { "operationId": "updateProjectProduction", "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "description": "Ready to upload.", "tags": [ "tutorial" ], "visibility": "unlisted" }, "schema": { "$ref": "#/components/schemas/UpdateProjectProductionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "checklist": [], "checklist_total": 0, "checklist_truncated": false, "project_id": "project:v1:script:1", "stage": "upload", "thumbnail": { "review_notes": null, "review_status": null, "reviewed_at": null, "text": null, "winner_selected": false }, "upload": { "all_required_checked": true, "description": "Ready to upload.", "made_for_kids": false, "publish_at": null, "status": null, "tags": [ "tutorial" ], "visibility": "unlisted" } }, "meta": { "idempotent_replay": false, "revision": "project-r1-example" } }, "schema": { "$ref": "#/components/schemas/ProjectProductionResponse" } } }, "description": "Updated production metadata.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update Project production metadata", "tags": [ "projects" ], "x-cli-command": "update-project-production", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectProductionApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectProductionApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/promote": { "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "post": { "operationId": "promoteProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "content": { "application/json": { "example": { "stage": "scripting" }, "schema": { "$ref": "#/components/schemas/PromoteProjectRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:script:1", "revision": "revision-2", "source": "script", "title": "Idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Canonical Script Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Promote idea Project", "tags": [ "projects" ], "x-cli-command": "promote-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/projects/{project}/restore": { "parameters": [ { "in": "path", "name": "project", "required": true, "schema": { "$ref": "#/components/schemas/ProjectReference" } } ], "post": { "operationId": "restoreProject", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "project:v1:idea:1", "revision": "revision-2", "source": "idea", "title": "Idea" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "description": "Restored Project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Restore Project", "tags": [ "projects" ], "x-cli-command": "restore-project", "x-required-abilities": [ "projects:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectsApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/scripts/{script}": { "get": { "operationId": "getScript", "responses": { "200": { "content": { "application/json": { "example": { "data": { "angle": "Explain the hidden implication most reviews miss", "canvas_url": "https://subscribr.ai/chat/my-channel-thread/canvas/789", "channel_id": 123, "format": "Tutorial", "has_outline": true, "has_script": false, "hook": "Open with a surprising fact", "id": 789, "language": "English", "length": 1200, "notes": "Notes for collaborators", "production_status": "scripting", "script_number": 12, "status": "active", "template_id": 22, "thread_id": 456, "thumbnail": "Apple AI Shock", "title": "Why Apple's AI Changes Everything", "topic": "Break down the key changes...", "voice": "neutral" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetScriptResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Script", "tags": [ "scripts" ], "x-cli-command": "get-script", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/scripts/{script}/agent/generate": { "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "startScriptAgentRun", "requestBody": { "content": { "application/json": { "example": { "model": "minimax_m27", "research": "deep_research", "visual_cues": "on" }, "schema": { "$ref": "#/components/schemas/StartScriptAgentRunRequest" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "example": { "cancel_url": "https://subscribr.ai/api/v1/scripts/789/agent/runs/42/cancel", "message": "Script agent run queued. Poll the poll_url for status updates.", "model": "kimi_k26", "poll_url": "https://subscribr.ai/api/v1/scripts/789/agent/runs/42", "research": "auto", "resolved_model": "kimi-k2.6", "run_id": 42, "status": "queued", "visual_cues": "off" }, "schema": { "$ref": "#/components/schemas/StartScriptAgentRunResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Start Script Agent Run", "tags": [ "scripts" ], "x-cli-command": "start-script-agent-run", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/DroidExec/ScriptAgentApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/scripts/{script}/agent/runs/{run}": { "get": { "operationId": "getScriptAgentRun", "responses": { "200": { "content": { "application/json": { "example": { "data": { "auth_path": "byok_anthropic", "current_step": null, "current_step_label": null, "elapsed_seconds": 112, "executor": "claude_sdk", "run_id": 42, "script_url": "https://subscribr.ai/api/v1/scripts/789", "status": "completed", "usage": { "completion_tokens": 1103, "prompt_tokens": 8420, "reasoning_tokens": null, "total_tokens": 9523 } }, "success": true }, "schema": { "$ref": "#/components/schemas/GetScriptAgentRunResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Script Agent Run", "tags": [ "scripts" ], "x-cli-command": "get-script-agent-run", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/DroidExec/ScriptAgentApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "example": 1, "in": "path", "name": "run", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/scripts/{script}/agent/runs/{run}/cancel": { "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } }, { "example": 1, "in": "path", "name": "run", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "cancelScriptAgentRun", "responses": { "200": { "content": { "application/json": { "example": { "cancelled": true, "message": "Run cancelled. Credits were refunded.", "refunded": true, "run_id": 42, "status": "cancelled" }, "schema": { "$ref": "#/components/schemas/CancelScriptAgentRunResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Cancel Script Agent Run", "tags": [ "scripts" ], "x-cli-command": "cancel-script-agent-run", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/DroidExec/ScriptAgentApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/scripts/{script}/content": { "get": { "operationId": "getScriptContent", "responses": { "200": { "content": { "application/json": { "example": { "data": { "content_version": 7, "outline": "# Outline\\n...", "outline_version": 3, "script": "# Script\\n...", "script_id": 789 }, "success": true }, "schema": { "$ref": "#/components/schemas/GetScriptContentResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Script Content", "tags": [ "scripts" ], "x-cli-command": "get-script-content", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/scripts/{script}/export": { "get": { "operationId": "exportScript", "parameters": [ { "description": "Output format: `markdown` (raw markdown), `html` (converted HTML), or `text` (plain text with markdown markers stripped)", "in": "query", "name": "format", "required": true, "schema": { "enum": [ "markdown", "html", "text" ], "type": "string" } }, { "description": "When false, strips markdown heading markers before export. Default true.", "in": "query", "name": "include_headings", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "content": "# Script\\n...", "format": "markdown", "include_headings": true, "script_id": 789, "title": "Why Apple's AI Changes Everything" }, "success": true }, "schema": { "$ref": "#/components/schemas/ExportScriptResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Export Script", "tags": [ "scripts" ], "x-cli-command": "export-script", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/scripts/{script}/generate/poll": { "get": { "operationId": "pollScriptGeneration", "parameters": [ { "description": "Run UUID from Generate Outline, Generate Script, or Humanize Script", "in": "query", "name": "run_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "content_type": "script", "outline": "# Outline\n\n## Section 1\n...", "run_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "script": "# Script\n\nOpening hook...\n", "status": "completed" }, "success": true }, "schema": { "$ref": "#/components/schemas/PollScriptGenerationResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Poll Script Generation", "tags": [ "scripts" ], "x-cli-command": "poll-script-generation", "x-required-abilities": [ "scripts:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ScriptPollGenerationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts" }, "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/scripts/{script}/outline/generate": { "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "generateScriptOutline", "responses": { "202": { "content": { "application/json": { "example": { "data": { "run_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "status": "queued" }, "success": true }, "schema": { "$ref": "#/components/schemas/GenerateScriptOutlineResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Generate Script Outline", "tags": [ "scripts" ], "x-cli-command": "generate-script-outline", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ScriptOutlineApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/scripts/{script}/script/generate": { "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "generateScript", "responses": { "202": { "content": { "application/json": { "example": { "data": { "run_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "status": "queued" }, "success": true }, "schema": { "$ref": "#/components/schemas/GenerateScriptResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Generate Script", "tags": [ "scripts" ], "x-cli-command": "generate-script", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ScriptCreditChargeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/scripts/{script}/script/humanize": { "parameters": [ { "example": 1, "in": "path", "name": "script", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "humanizeScript", "responses": { "202": { "content": { "application/json": { "example": { "data": { "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "queued" }, "success": true }, "schema": { "$ref": "#/components/schemas/HumanizeScriptResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Humanize Script", "tags": [ "scripts" ], "x-cli-command": "humanize-script", "x-required-abilities": [ "scripts:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/HumanizeScriptApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "scripts", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/tasks": { "get": { "operationId": "listProjectTasks", "parameters": [ { "$ref": "#/components/parameters/Cursor" }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "overdue", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "meta": { "next_cursor": null } }, "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } }, "description": "Assigned Script-backed Projects." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List assigned Project tasks", "tags": [ "projects" ], "x-cli-command": "list-project-tasks", "x-pagination": { "stable_order": true, "style": "cursor" }, "x-required-abilities": [ "projects:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "behavior": [ "tests/Feature/Api/Projects/ProjectCollaborationApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "projects" } }, "/api/v1/team": { "get": { "operationId": "getTeam", "responses": { "200": { "content": { "application/json": { "example": { "team": { "id": 456, "name": "My Content Team", "owner": { "id": 123, "name": "John Doe" }, "subscription": { "is_paused": false, "plan": "Creator", "status": "active", "trial_ends_at": null }, "user_role": "admin" } }, "schema": { "$ref": "#/components/schemas/GetTeamResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Team", "tags": [ "team" ], "x-cli-command": "get-team", "x-required-abilities": [], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/TeamDataValidationTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "team" } }, "/api/v1/team/credits": { "get": { "operationId": "getTeamCredits", "responses": { "200": { "content": { "application/json": { "example": { "credits": { "credits_expire_at": "2026-02-28T00:00:00Z", "credits_remaining": 850, "credits_used_this_period": 150, "current_credits": 850, "next_credit_refresh": "2026-03-01T00:00:00Z", "plan_credits": 1000 } }, "schema": { "$ref": "#/components/schemas/GetTeamCreditsResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Team Credits", "tags": [ "team" ], "x-cli-command": "get-team-credits", "x-required-abilities": [], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/TeamDataValidationTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "team" } }, "/api/v1/team/thumbnails/usage": { "get": { "operationId": "getThumbnailUsage", "responses": { "200": { "content": { "application/json": { "example": { "data": { "addon_pool": { "limit": 50, "next_reset": "2026-04-15", "remaining": 40, "reserved": 0, "used": 10 }, "eligible": true, "free_pool": { "limit": 5, "next_reset": "2026-04-01", "remaining": 2, "reserved": 1, "used": 2 }, "pack_pool": { "limit": 100, "next_reset": null, "remaining": 95, "reserved": 0, "used": 5 }, "total_remaining": 137 }, "success": true }, "schema": { "$ref": "#/components/schemas/GetThumbnailUsageResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Thumbnail Usage", "tags": [ "thumbnails" ], "x-cli-command": "get-thumbnail-usage", "x-required-abilities": [ "scripts:read", "thumbnails:read" ], "x-required-ability-mode": "any", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/ThumbnailApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "thumbnails" } }, "/api/v1/team/tokens": { "get": { "operationId": "listApiTokens", "responses": { "200": { "content": { "application/json": { "example": { "tokens": [ { "abilities": [ "intel:read", "scripts:read" ], "id": 123, "last_used_at": "2026-02-01T18:22:00Z", "name": "Zapier Integration" } ] }, "schema": { "$ref": "#/components/schemas/ListApiTokensResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Api Tokens", "tags": [ "team" ], "x-cli-command": "list-api-tokens", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "tokens:manage" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "team" }, "post": { "operationId": "createApiToken", "requestBody": { "content": { "application/json": { "example": { "abilities": [ "intel:read", "scripts:read", "channels:read" ], "name": "Automation Token" }, "schema": { "$ref": "#/components/schemas/CreateApiTokenRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "token": { "abilities": [ "intel:read", "scripts:read", "channels:read" ], "id": 456, "name": "Automation Token", "token": "plain-text-token-value" } }, "schema": { "$ref": "#/components/schemas/CreateApiTokenResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Api Token", "tags": [ "team" ], "x-cli-command": "create-api-token", "x-required-abilities": [ "tokens:manage" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "team", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/team/tokens/{token}": { "delete": { "operationId": "deleteApiToken", "responses": { "200": { "content": { "application/json": { "example": { "message": "Token deleted successfully" }, "schema": { "$ref": "#/components/schemas/DeleteApiTokenResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Delete Api Token", "tags": [ "team" ], "x-cli-command": "delete-api-token", "x-required-abilities": [ "tokens:manage" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "team", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } }, "parameters": [ { "example": 1, "in": "path", "name": "token", "required": true, "schema": { "minimum": 1, "type": "integer" } } ] }, "/api/v1/video/avatars": { "get": { "operationId": "videoListAvatars", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "per_page", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 0 } }, "schema": { "$ref": "#/components/schemas/VideoAssetListResponse" } } }, "description": "Custom avatars." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List custom avatars available to the current team", "tags": [ "video" ], "x-cli-command": "list-avatars", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/avatars/{avatar}": { "get": { "operationId": "videoGetAvatar", "parameters": [ { "in": "path", "name": "avatar", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "allowed_actions": [ "retry_training" ], "id": "820e8400-e29b-41d4-a716-446655440002", "kind": "custom_avatar", "name": "Backup host", "state": "failed" } }, "schema": { "$ref": "#/components/schemas/VideoAssetResponse" } } }, "description": "Custom avatar." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a custom avatar available to the current team", "tags": [ "video" ], "x-cli-command": "get-avatar", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/capabilities": { "get": { "operationId": "videoListCapabilities", "responses": { "200": { "content": { "application/json": { "example": { "data": [], "version": "1.0.0" }, "schema": { "$ref": "#/components/schemas/VideoCapabilityCatalogResponse" } } }, "description": "Versioned capability catalog." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List available Subscribr Video capabilities", "tags": [ "video" ], "x-cli-command": "list-capabilities", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/channels": { "get": { "operationId": "videoListChannels", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "configuration": { "active": true, "captions": { "enabled": true, "style": "default" }, "music": { "enabled": false, "sfx_family": null }, "pacing": { "pace_profile": null, "slideshow_max_seconds": null, "structure_hint": null }, "post_processing": { "profile": null }, "presenter": { "avatar": { "identity_status": "none", "resource_id": null, "selection": "none" }, "layout": { "position": null, "style": null }, "look": { "identity_status": "none", "resource_id": null, "selection": "none" }, "type": null }, "reference_media": { "attachment_count": 0, "identity_status": "none", "resource_ids": [] }, "style": { "configured": true }, "theme": { "id": "academic_explainer", "overrides": { "archival_treatment": null, "brand_accent_color": null, "brand_highlight_color": null, "data_count_treatment": null, "evidence_label_style": null, "section_reset_treatment": null } }, "voice": { "delivery_mode": null, "identity_status": "unresolved", "resource_id": null, "selection": "catalog", "speaking_rate": 1.08 } }, "configuration_revision": 1, "created_at": "2026-07-29T00:00:00+00:00", "display_name": "Example", "handle": "example", "id": "stch_example", "mode": "faceless", "origin": { "kind": "standalone", "main_channel_id": null }, "readiness": { "missing_requirements": [], "status": "ready" }, "updated_at": "2026-07-29T00:00:00+00:00" } ] }, "schema": { "$ref": "#/components/schemas/VideoChannelListResponse" } } }, "description": "Video channels." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Subscribr Video channels for the current team", "tags": [ "video" ], "x-cli-command": "list-channels", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/channels/{videoChannel}": { "get": { "operationId": "videoGetChannel", "parameters": [ { "in": "path", "name": "videoChannel", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "configuration": { "active": true, "captions": { "enabled": true, "style": "default" }, "music": { "enabled": false, "sfx_family": null }, "pacing": { "pace_profile": null, "slideshow_max_seconds": null, "structure_hint": null }, "post_processing": { "profile": null }, "presenter": { "avatar": { "identity_status": "none", "resource_id": null, "selection": "none" }, "layout": { "position": null, "style": null }, "look": { "identity_status": "none", "resource_id": null, "selection": "none" }, "type": null }, "reference_media": { "attachment_count": 0, "identity_status": "none", "resource_ids": [] }, "style": { "configured": true }, "theme": { "id": "academic_explainer", "overrides": { "archival_treatment": null, "brand_accent_color": null, "brand_highlight_color": null, "data_count_treatment": null, "evidence_label_style": null, "section_reset_treatment": null } }, "voice": { "delivery_mode": null, "identity_status": "unresolved", "resource_id": null, "selection": "catalog", "speaking_rate": 1.08 } }, "configuration_revision": 1, "created_at": "2026-07-29T00:00:00+00:00", "display_name": "Example", "handle": "example", "id": "stch_example", "mode": "faceless", "origin": { "kind": "standalone", "main_channel_id": null }, "readiness": { "missing_requirements": [], "status": "ready" }, "updated_at": "2026-07-29T00:00:00+00:00" } }, "schema": { "$ref": "#/components/schemas/VideoChannelResponse" } } }, "description": "Video channel." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video channel for the current team", "tags": [ "video" ], "x-cli-command": "get-channel", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoFacadeReadApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/media-assets": { "get": { "operationId": "videoListMediaAssets", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "per_page", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 0 } }, "schema": { "$ref": "#/components/schemas/VideoAssetListResponse" } } }, "description": "Reference media assets." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List reference media available to the current team", "tags": [ "video" ], "x-cli-command": "list-media-assets", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/media-assets/{mediaAsset}": { "get": { "operationId": "videoGetMediaAsset", "parameters": [ { "in": "path", "name": "mediaAsset", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "allowed_actions": [ "retry_processing" ], "id": "820e8400-e29b-41d4-a716-446655440006", "kind": "reference_media", "name": "Retry reference", "state": "failed" } }, "schema": { "$ref": "#/components/schemas/VideoAssetResponse" } } }, "description": "Reference media asset." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get reference media available to the current team", "tags": [ "video" ], "x-cli-command": "get-media-asset", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects": { "get": { "operationId": "videoListProjects", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "channel_id": "stch_example", "created_at": "2026-08-01T00:00:00Z", "current_artifact": { "published_at": "2026-08-02T00:00:00Z", "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "id": "proj_01hz3k9pb1z7c5m2r6n0y4x2a2", "status": "complete", "title": "Example title" } ], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 1 } }, "schema": { "$ref": "#/components/schemas/VideoProjectListResponse" } } }, "description": "List Subscribr Video projects." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Subscribr Video projects", "tags": [ "video" ], "x-cli-command": "list-projects", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" }, "post": { "operationId": "videoCreateVideo", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example title", "script": "This is an example script for a short video." }, "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "operation": { "domain_resource": { "id": "proj_01hz3k9pb1z7c5m2r6n0y4x2a2", "type": "video_project" }, "error": null, "id": "9f8b6b0e-6b8e-4b8e-8b8e-6b8e4b8e8b8f", "progress": 10, "result": null, "status": "running", "type": "video_generate" } }, "schema": { "$ref": "#/components/schemas/VideoApplyRevisionResponse" } } }, "description": "Create a Subscribr Video project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create a Subscribr Video project", "tags": [ "video" ], "x-cli-command": "create-video", "x-required-abilities": [ "video:generate" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "unsupported", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/quote": { "post": { "operationId": "videoQuoteVideo", "requestBody": { "content": { "application/json": { "example": { "name": "Example title", "script": "This is an example script for a short video." }, "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "dry_run": true, "estimated_seconds": 120, "required_credits": 2 } }, "schema": { "$ref": "#/components/schemas/VideoQuoteVideoResponse" } } }, "description": "Quote a Subscribr Video generation." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Quote a Subscribr Video generation", "tags": [ "video" ], "x-cli-command": "quote-video", "x-required-abilities": [ "video:generate" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/video/projects/{project}": { "get": { "operationId": "videoGetProject", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "channel_id": "stch_example", "created_at": "2026-08-01T00:00:00Z", "current_artifact": { "published_at": "2026-08-02T00:00:00Z", "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "id": "proj_01hz3k9pb1z7c5m2r6n0y4x2a2", "status": "complete", "title": "Example title" } }, "schema": { "$ref": "#/components/schemas/VideoProjectResponse" } } }, "description": "Get a Subscribr Video project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video project", "tags": [ "video" ], "x-cli-command": "get-project", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/cancel": { "post": { "operationId": "videoCancelVideo", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "reason": "No longer needed" }, "schema": { "$ref": "#/components/schemas/VideoCancelVideoRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "channel_id": "stch_example", "created_at": "2026-08-01T00:00:00Z", "current_artifact": null, "id": "proj_01hz3k9pb1z7c5m2r6n0y4x2a2", "status": "cancelled", "title": "Example title" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoCancelVideoResponse" } } }, "description": "Cancel a Subscribr Video project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Cancel a Subscribr Video project", "tags": [ "video" ], "x-cli-command": "cancel-video", "x-required-abilities": [ "video:generate" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoGenerationFacadeApiTest.php", "tests/Feature/Services/Video/VideoGenerationGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "unsupported", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/download": { "get": { "operationId": "videoGetProjectDownload", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "download_url": "https://cdn.video.subscribr.ai/proj_01.mp4?sig=abc", "expires_at": "2026-08-27T13:00:00Z" } }, "schema": { "$ref": "#/components/schemas/VideoProjectDownloadResponse" } } }, "description": "Get a Subscribr Video project's download URL." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video project's download URL", "tags": [ "video" ], "x-cli-command": "get-project-download", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/editable-content": { "get": { "operationId": "videoGetEditableContent", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "edit_availability": { "can_apply": true, "can_start_new_pass": true, "edit_window_ends_at": "2026-09-01T12:00:00Z", "explanation": "You can stage and apply one revision pass." }, "edit_session": { "editable": true, "status": "draft" }, "overlays": [], "settings": { "captions": { "enabled": true, "style": "default" }, "music": { "removal_available": true } }, "visual_blocks": [ { "available_actions": [ "replace_with_media" ], "key": "block_1", "replace_with_media_paid": false } ] } }, "schema": { "$ref": "#/components/schemas/VideoEditableContentResponse" } } }, "description": "Get a Subscribr Video project's editable Review & Fix content.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video project's editable Review & Fix content", "tags": [ "video" ], "x-cli-command": "get-editable-content", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/overlay-templates": { "get": { "operationId": "videoListOverlayTemplates", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "description": "A lower-third caption overlay.", "id": "lower_third", "input_fields": [ { "key": "text", "label": "Text", "max_chars": 60, "required": true, "type": "string" } ], "label": "Lower third", "preview_url": "/api/v1/videos/proj_01hz3k9pb1z7c5m2r6n0y4x2a2/revision-overlay-templates/lower_third/preview" } ] }, "schema": { "$ref": "#/components/schemas/VideoOverlayTemplatesResponse" } } }, "description": "List overlay templates available for a Subscribr Video project." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List overlay templates available for a Subscribr Video project", "tags": [ "video" ], "x-cli-command": "list-overlay-templates", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/quality-report": { "get": { "operationId": "videoGetQualityReport", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "artifact": { "duration_seconds": 898.2, "revision": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" }, "audio_status": "pass", "findings": [ { "category": "timing", "end_time": 15, "id": "quality_review.duration_parity_failed", "message": "The captioned duration differs from the audio track by 0.4s.", "severity": "warning", "start_time": 12.4 } ], "measured_at": "2026-08-27T12:05:00Z", "overall_status": "pass", "status": "ready", "summary": { "count": 1, "severe_count": 0 }, "visual_status": "pass" } }, "schema": { "$ref": "#/components/schemas/VideoQualityReportResponse" } } }, "description": "Get a Subscribr Video project's latest quality report." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video project's latest quality report", "tags": [ "video" ], "x-cli-command": "get-quality-report", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoQualityReportFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoQualityReportFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/revision-manifest": { "get": { "operationId": "videoGetRevisionManifest", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "in": "query", "name": "per_page", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "end_time": 2, "id": "item_1", "inputs": { "text": "Hello" }, "label": "Add on-screen text", "operation": "add", "overlay_id": "ov_1", "scope": "moment", "start_time": 1, "status": "ready", "status_label": "Ready to apply", "template": "lower_third" } ], "revision": { "number": 3, "status": "draft" } }, "meta": { "next_cursor": null } }, "schema": { "$ref": "#/components/schemas/VideoRevisionManifestResponse" } } }, "description": "Get a Subscribr Video project's revision manifest.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a Subscribr Video project's revision manifest", "tags": [ "video" ], "x-cli-command": "get-revision-manifest", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/revision/apply": { "post": { "operationId": "videoApplyRevision", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "example": { "operation": { "domain_resource": { "id": "pass_01hz3k9pb1z7c5m2r6n0y4x2a2", "type": "video_revision_pass" }, "error": null, "id": "9f8b6b0e-6b8e-4b8e-8b8e-6b8e4b8e8b8e", "progress": 10, "result": null, "status": "running", "type": "video_apply_revision" } }, "schema": { "$ref": "#/components/schemas/VideoApplyRevisionResponse" } } }, "description": "Apply a Subscribr Video revision and publish a new version." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Apply a Subscribr Video revision and publish a new version", "tags": [ "video" ], "x-cli-command": "apply-revision", "x-required-abilities": [ "video:publish" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/captions": { "put": { "operationId": "videoUpdateCaptions", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "enabled": true, "style": "default" }, "schema": { "$ref": "#/components/schemas/VideoUpdateCaptionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "update_captions", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a4", "status": "ready" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Update caption settings in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update caption settings in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "update-captions", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/items/{item}": { "delete": { "operationId": "videoDiscardEdit", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The revision item's public id.", "in": "path", "name": "item", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "deleted": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionDeleteResponse" } } }, "description": "Discard a staged edit from a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Discard a staged edit from a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "discard-edit", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/music": { "put": { "operationId": "videoRemoveMusic", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "remove": true }, "schema": { "$ref": "#/components/schemas/VideoRemoveMusicRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "music_removal", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a5", "status": "ready" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Update background music removal in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update background music removal in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "remove-music", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/overlays": { "post": { "operationId": "videoAddOverlay", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "inputs": { "text": "New product launch" }, "playhead_time": 42, "template": "lower_third" }, "schema": { "$ref": "#/components/schemas/VideoAddOverlayRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "end_time": 43, "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a2", "overlay_id": "ov_01hz3k9pb1z7c5m2r6n0y4x2a2", "revision_item_id": "item_01hz3k9pb1z7c5m2r6n0y4x2a2", "start_time": 41, "status": "generating", "template": "lower_third" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoAddOverlayResponse" } } }, "description": "Add a staged overlay to a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Add a staged overlay to a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "add-overlay", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/overlays/{item}": { "delete": { "operationId": "videoRemoveStagedOverlay", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The revision item's public id.", "in": "path", "name": "item", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "deleted": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionDeleteResponse" } } }, "description": "Remove a staged overlay from a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Remove a staged overlay from a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "remove-staged-overlay", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/passes/{pass}": { "get": { "operationId": "videoGetRevisionPass", "parameters": [ { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The revision pass's public id.", "in": "path", "name": "pass", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "applied_at": "2026-08-27T12:00:00Z", "artifact": { "published_at": "2026-08-27T12:01:00Z", "revision": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd" }, "download": { "available": true, "endpoint": "/api/v1/video/projects/proj_01hz3k9pb1z7c5m2r6n0y4x2a2/download" }, "error": null, "id": "pass_01hz3k9pb1z7c5m2r6n0y4x2a2", "number": 3, "quality_review": { "status": "ready" }, "status": "complete" } }, "schema": { "$ref": "#/components/schemas/VideoRevisionPassResponse" } } }, "description": "Get one Subscribr Video revision pass." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get one Subscribr Video revision pass", "tags": [ "video" ], "x-cli-command": "get-revision-pass", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/projects/{project}/revision/presenter": { "put": { "operationId": "videoShowPresenter", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "block_key": "slide_7", "note": "Show the presenter here instead." }, "schema": { "$ref": "#/components/schemas/VideoShowPresenterRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "use_avatar_only", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a8", "status": "generating" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Switch a visual block to the presenter in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Switch a visual block to the presenter in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "show-presenter", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/published-overlays/{overlay}": { "delete": { "operationId": "videoRemoveOverlay", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The published overlay's public id.", "in": "path", "name": "overlay", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "deleted": true }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionDeleteResponse" } } }, "description": "Remove a published overlay from a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Remove a published overlay from a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "remove-overlay", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } }, "patch": { "operationId": "videoUpdateOverlay", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The published overlay's public id.", "in": "path", "name": "overlay", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "inputs": { "text": "Updated overlay text" } }, "schema": { "$ref": "#/components/schemas/VideoUpdateOverlayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "update_overlay", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a3", "status": "generating" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Update a published overlay in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update a published overlay in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "update-overlay", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/regenerate-visual": { "put": { "operationId": "videoRegenerateVisual", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "block_key": "slide_5", "prompt": "A wide shot of a modern kitchen" }, "schema": { "$ref": "#/components/schemas/VideoRegenerateVisualRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "regenerate_visual", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a7", "status": "generating" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Regenerate a visual block in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Regenerate a visual block in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "regenerate-visual", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/replace-with-media": { "put": { "operationId": "videoReplaceWithMedia", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "block_key": "slide_5", "media_asset_id": "9c1b6a1a-8e2b-4b8a-9a1e-2f7a5c6d9e3b" }, "schema": { "$ref": "#/components/schemas/VideoReplaceWithMediaRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "replace_with_media", "cropped": false, "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a7", "status": "ready" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoReplaceWithMediaResponse" } } }, "description": "Replace a visual block with a media-library asset in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Replace a visual block with a media-library asset in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "replace-with-media", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/projects/{project}/revision/slide-text": { "patch": { "operationId": "videoEditSlideText", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/IfMatch" }, { "description": "The video project's public id.", "in": "path", "name": "project", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "block_key": "slide_3", "field_edits": [ { "key": "headline", "value": "New headline" } ] }, "schema": { "$ref": "#/components/schemas/VideoEditSlideTextRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "action": "edit_slide_text", "id": "item_01hz3k9pb1z7c5m2r6n0y4x2a6", "status": "ready" }, "meta": { "idempotent_replay": false } }, "schema": { "$ref": "#/components/schemas/VideoRevisionEditResponse" } } }, "description": "Edit slide text in a Subscribr Video revision.", "headers": { "ETag": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Edit slide text in a Subscribr Video revision", "tags": [ "video" ], "x-cli-command": "edit-slide-text", "x-required-abilities": [ "video:edit" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoRevisionFacadeApiTest.php", "tests/Feature/Services/Video/VideoRevisionGatewayTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video", "x-write-safety": { "concurrency": "required", "idempotency": "required", "retry": "same-key" } } }, "/api/v1/video/voices": { "get": { "operationId": "videoListVoices", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "per_page", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [], "pagination": { "current_page": 1, "last_page": 1, "per_page": 20, "total": 0 } }, "schema": { "$ref": "#/components/schemas/VideoAssetListResponse" } } }, "description": "Custom voices." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List custom voices available to the current team", "tags": [ "video" ], "x-cli-command": "list-voices", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/video/voices/{voice}": { "get": { "operationId": "videoGetVoice", "parameters": [ { "in": "path", "name": "voice", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "allowed_actions": [], "id": "820e8400-e29b-41d4-a716-446655440003", "kind": "custom_voice", "name": "Narration voice", "state": "ready" } }, "schema": { "$ref": "#/components/schemas/VideoAssetResponse" } } }, "description": "Custom voice." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" }, "503": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get a custom voice available to the current team", "tags": [ "video" ], "x-cli-command": "get-voice", "x-required-abilities": [ "video:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "behavior": [ "tests/Feature/Api/Video/VideoAssetFacadeApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "video" } }, "/api/v1/webhooks": { "get": { "operationId": "listWebhooks", "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "active": true, "events": [ "script.generated", "idea.created" ], "id": 12, "last_delivery": null, "name": "Production notifications", "success_rate": 98.5, "url": "https://example.com/webhooks/subscribr" } ], "success": true }, "schema": { "$ref": "#/components/schemas/ListWebhooksResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "List Webhooks", "tags": [ "webhooks" ], "x-cli-command": "list-webhooks", "x-pagination": { "stable_order": true, "style": "endpoint-defined" }, "x-required-abilities": [ "webhooks:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/WebhookApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks" }, "post": { "operationId": "createWebhook", "requestBody": { "content": { "application/json": { "example": { "events": [ "script.generated" ], "headers": { "X-Partner": "subscribr" }, "name": "Partner hook", "timeout": 30, "url": "https://example.com/webhooks/subscribr" }, "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "active": true, "events": [ "script.generated" ], "id": 13, "name": "Partner hook", "secret": "store-this-secret-once", "timeout": 30, "url": "https://example.com/webhooks/subscribr" }, "success": true }, "schema": { "$ref": "#/components/schemas/CreateWebhookResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Create Webhook", "tags": [ "webhooks" ], "x-cli-command": "create-webhook", "x-required-abilities": [ "webhooks:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/WebhookApiTest.php", "tests/Feature/Api/ApiResponseMiddlewareTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/webhooks/{webhook}": { "delete": { "operationId": "deleteWebhook", "responses": { "200": { "content": { "application/json": { "example": { "message": "Webhook deleted successfully", "success": true }, "schema": { "$ref": "#/components/schemas/DeleteWebhookResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Delete Webhook", "tags": [ "webhooks" ], "x-cli-command": "delete-webhook", "x-required-abilities": [ "webhooks:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } }, "get": { "operationId": "getWebhook", "responses": { "200": { "content": { "application/json": { "example": { "data": { "active": true, "deliveries": [ { "event_type": "script.generated", "id": 901, "response_code": 200, "status": "success" } ], "events": [ "script.generated", "idea.created" ], "headers": null, "id": 12, "name": "Production notifications", "success_rate": 98.5, "timeout": 30, "url": "https://example.com/webhooks/subscribr" }, "success": true }, "schema": { "$ref": "#/components/schemas/GetWebhookResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Get Webhook", "tags": [ "webhooks" ], "x-cli-command": "get-webhook", "x-required-abilities": [ "webhooks:read" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks" }, "parameters": [ { "example": 1, "in": "path", "name": "webhook", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "put": { "operationId": "updateWebhook", "requestBody": { "content": { "application/json": { "example": { "active": false, "headers": { "X-Partner": "updated" }, "timeout": 45 }, "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "active": false, "events": [ "script.generated" ], "id": 12, "name": "Production notifications", "timeout": 30, "url": "https://example.com/webhooks/subscribr" }, "success": true }, "schema": { "$ref": "#/components/schemas/UpdateWebhookResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Update Webhook", "tags": [ "webhooks" ], "x-cli-command": "update-webhook", "x-required-abilities": [ "webhooks:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/LegacyReadWriteEndpointCoverageTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } }, "/api/v1/webhooks/{webhook}/test": { "parameters": [ { "example": 1, "in": "path", "name": "webhook", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "post": { "operationId": "testWebhook", "responses": { "200": { "content": { "application/json": { "example": { "data": { "error": null, "response_body": "{\"received\":true}", "status_code": 200, "success": true }, "success": true }, "schema": { "$ref": "#/components/schemas/TestWebhookResponse" } } }, "description": "Successful response." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/TemporaryFailure" } }, "security": [ { "personalAccessToken": [] } ], "summary": "Test Webhook", "tags": [ "webhooks" ], "x-cli-command": "test-webhook", "x-required-abilities": [ "webhooks:write" ], "x-required-ability-mode": "all", "x-runtime-evidence": { "auth_smoke": [ "tests/Feature/ApiContract/ApiContractRuntimeTest.php" ], "behavior": [ "tests/Feature/Api/WebhookApiTest.php" ], "status": "covered", "uncovered": [] }, "x-skill-group": "webhooks", "x-write-safety": { "concurrency": "unsupported", "idempotency": "unsupported", "retry": "never" } } } }, "servers": [ { "description": "Production", "url": "https://subscribr.ai" } ], "tags": [ { "name": "team" }, { "name": "intel" }, { "name": "channels" }, { "name": "ideas" }, { "name": "scripts" }, { "name": "thumbnails" }, { "name": "webhooks" }, { "name": "operations" }, { "description": "Subscribr Video operations. Concrete operations are published only with their implemented Laravel route, authorization, tests, and generated artifacts.", "name": "video" } ], "x-compatibility-policy": { "required_operation_ids": true, "semantic_version_ranges": true, "source_checksum_is_provenance_only": true }, "x-generated-notice": "DO NOT EDIT: generated from openapi/subscribr-v1.json", "x-source-sha256": "77bc890bb5e3f1b5a48b1ccf0ceb0cb6b6b54300b1fdbf3e84e6a1585bf191a5", "x-subscribr-contract-version": "1.0.0", "x-subscribr-operation-manifest-version": "1.0.0", "x-subscribr-video-contract": { "abilities": [ "video:read", "video:edit", "video:publish", "video:generate" ], "capability_catalog_schema": "VideoCapabilityCatalogResponse", "error_codes": [ "video_provisioning_required", "video_configuration_not_ready", "video_capability_unavailable", "video_edit_rejected", "video_insufficient_balance" ], "namespace": "/api/v1/video", "operation_id_prefix": "video", "private_service": "Studio", "product": "Subscribr Video", "version": "1.0.0" } }