{"openapi":"3.1.0","info":{"title":"Videotok API","version":"1.0.0","description":"Generate static ads, video ads, UGC ads, and AI model outputs with scoped API keys."},"servers":[{"url":"https://www.videotok.app/api/v1"}],"security":[{"bearerAuth":[]}],"paths":{"/models":{"get":{"security":[],"operationId":"listModels","summary":"List supported templates and AI models","description":"Returns static ad, video ad, UGC ad, and AI model catalog data. Includes template slugs, preset ids, preview URLs, quality tiers, variants, and estimated credits.","responses":{"200":{"description":"Catalog response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResponse"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}},"/openapi.json":{"get":{"security":[],"operationId":"getOpenApiSchema","summary":"Return the OpenAPI schema","description":"Returns this machine-readable OpenAPI 3.1 contract for the Videotok public API.","responses":{"200":{"description":"OpenAPI document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiDocument"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}},"/assets":{"get":{"operationId":"listWorkspaceAssets","summary":"List workspace assets","description":"Returns brand kits, avatars, voices, and valid reference inspiration template targets for the authenticated workspace.","responses":{"200":{"description":"Workspace assets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAssets"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/generations":{"post":{"operationId":"createGeneration","summary":"Create one or more media generations","description":"Queues static ad, video ad, UGC ad, or AI model generation. Credits are calculated server-side and deducted atomically before queueing. Use idempotency keys for retries.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGenerationRequest"}}}},"responses":{"200":{"description":"Generation queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationBatch"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/generations/{id}":{"get":{"operationId":"getGeneration","summary":"Retrieve a generation","description":"Returns the status, final asset URL when complete, and structured failure details when generation fails.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Generation status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Generation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/slideshows":{"post":{"operationId":"createSlideshow","summary":"Create a slideshow or carousel","description":"Queues the slideshow workflow. Credits are deducted before queueing. Use idempotency keys for retries.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":160}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSlideshowRequest"}}}},"responses":{"200":{"description":"Slideshow queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowGeneration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/slideshows/{id}":{"get":{"operationId":"getSlideshow","summary":"Retrieve a slideshow","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Slideshow status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Slideshow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/faceless-videos":{"post":{"operationId":"createFacelessVideo","summary":"Create a faceless video","description":"Queues the automatic faceless video workflow. Credits are deducted before queueing. Use idempotency keys for retries.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":160}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFacelessVideoRequest"}}}},"responses":{"200":{"description":"Faceless video queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacelessVideoGeneration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/videos/{id}":{"get":{"operationId":"getVideo","summary":"Retrieve a video","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Video status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Video"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/reference-inspirations":{"get":{"operationId":"listReferenceInspirations","summary":"List, recommend, or suggest reference inspirations","description":"Lists saved references by default. Pass recommend=true to recommend references, or suggest_targets=true to suggest where uploaded media should be stored.","parameters":[{"name":"recommend","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"suggest_targets","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"template_slug","in":"query","required":false,"schema":{"type":"string"}},{"name":"template_category","in":"query","required":false,"schema":{"type":"string","enum":["static-ads","video-templates","slideshow-carousel"]}},{"name":"media_kind","in":"query","required":false,"schema":{"type":"string","enum":["image","slideshow","video"]}},{"name":"description","in":"query","required":false,"description":"Short media description used only with suggest_targets=true.","schema":{"type":"string","maxLength":2000}},{"name":"image_url","in":"query","required":false,"description":"Repeatable image URL used only with suggest_targets=true.","schema":{"type":"string","format":"uri"}},{"name":"video_url","in":"query","required":false,"description":"Video URL used only with suggest_targets=true.","schema":{"type":"string","format":"uri"}},{"name":"limit","in":"query","required":false,"description":"Maximum results. Max 20 for recommendations, max 12 for target suggestions.","schema":{"type":"integer","minimum":1,"maximum":20}}],"responses":{"200":{"description":"Reference inspiration response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReferenceList"},{"$ref":"#/components/schemas/ReferenceRecommendations"},{"$ref":"#/components/schemas/ReferenceTargetSuggestions"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}},"post":{"operationId":"createReferenceInspiration","summary":"Create a workspace reference inspiration","description":"Saves user-provided image, slideshow, or video references to a selected template target. Reference analysis costs 30 credits per media item, deducted before inline uploads and queueing.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReferenceInspirationRequest"}}}},"responses":{"200":{"description":"Reference saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceInspiration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/editor/videos":{"get":{"operationId":"listEditorVideos","summary":"List editable videos","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":30}}],"responses":{"200":{"description":"Editor videos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorVideoList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}},"post":{"operationId":"createEditorVideo","summary":"Create a ready editable video","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEditorVideoRequest"}}}},"responses":{"200":{"description":"Editor video","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorVideo"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/editor/videos/{id}":{"get":{"operationId":"getEditorVideo","summary":"Retrieve an editable video","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Editor video","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorVideo"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}},"patch":{"operationId":"applyEditorEdits","summary":"Apply editor operations","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyEditorEditsRequest"}}}},"responses":{"200":{"description":"Edit result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorEditResult"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/editor/media":{"get":{"operationId":"listEditorMedia","summary":"List editor media","parameters":[{"name":"media_type","in":"query","required":false,"schema":{"type":"string","enum":["image","video","audio","voice"]}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Editor media","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorMediaList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}}},"post":{"operationId":"uploadEditorMedia","summary":"Upload editor media","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEditorMediaRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadEditorMediaMultipartRequest"}}}},"responses":{"200":{"description":"Uploaded media","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorMediaUpload"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/editor/videos/{id}/media":{"post":{"operationId":"addEditorMedia","summary":"Add media to an editable video","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEditorMediaRequest"}}}},"responses":{"200":{"description":"Media added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorMediaAddition"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/skill.md":{"get":{"security":[],"operationId":"getSkillMarkdown","summary":"Return agent-ready API instructions","responses":{"200":{"description":"Markdown skill file","content":{"text/markdown":{"schema":{"type":"string"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"responses":{"BadRequest":{"description":"Invalid request body, path parameter, or query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Missing, malformed, invalid, or revoked bearer API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The API key is valid but does not include the required scope, or the referenced resource is not available to the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"PaymentRequired":{"description":"The organization does not have an active paid subscription or has insufficient credits for the requested generation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The requested generation, video, editor project, media item, brand kit, avatar, or reference was not found in the authenticated organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"The idempotency key is already processing or was previously used for a different request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"Generation rate limit exceeded. Retry later with the same idempotency key for paid generation requests. Rate-limit headers may be present when available.","headers":{"Retry-After":{"schema":{"type":"integer","minimum":0},"description":"Optional seconds to wait before retrying."},"X-RateLimit-Remaining":{"schema":{"type":"integer","minimum":0},"description":"Optional remaining request count for the current window."},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Optional Unix timestamp in milliseconds for reset."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServerError":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"OpenApiDocument":{"type":"object","description":"OpenAPI 3.1 document for the Videotok public API.","additionalProperties":true,"required":["openapi","info","paths"],"properties":{"openapi":{"type":"string"},"info":{"type":"object","additionalProperties":true},"paths":{"type":"object","additionalProperties":true},"components":{"type":"object","additionalProperties":true}}},"CreateGenerationRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["static_ad","video_ad","ugc_ad","ai_model"],"description":"Generation category. Use template_slug for static_ad/video_ad/ugc_ad and model_slug for ai_model."},"prompt":{"type":"string","maxLength":8000,"description":"Creative direction or user prompt. For template workflows with preset_id or custom_reference_inspiration_id, preserve the user prompt instead of expanding it into an agent-written brief."},"template_slug":{"type":"string","maxLength":160,"description":"Template slug from GET /models for static_ad, video_ad, or ugc_ad."},"model_slug":{"type":"string","maxLength":160,"description":"AI model slug from GET /models for ai_model."},"variant_id":{"type":"string","maxLength":160,"description":"Variant id from the selected AI model. Defaults server-side when omitted."},"preset_id":{"type":["string","null"],"maxLength":220,"description":"Built-in inspiration preset id from the selected template. Treat as an internal routing value in user-facing agents unless the user asks for API/debug details."},"aspect_ratio":{"type":"string","maxLength":24,"examples":["1:1","9:16","16:9"]},"duration":{"type":"integer","minimum":1,"maximum":30,"description":"Duration in seconds when supported."},"resolution":{"type":"string","maxLength":24,"examples":["720p","1K"]},"quality_tier":{"type":"string","enum":["high","low"],"default":"high"},"brand_kit_id":{"type":"integer","minimum":1,"description":"Brand kit id from GET /assets."},"avatar_id":{"type":"string","maxLength":160,"description":"Custom or public avatar id from GET /assets."},"custom_reference_inspiration_id":{"type":["string","null"],"format":"uuid","description":"Ready reference inspiration id from /reference-inspirations. Treat as an internal routing value in user-facing agents unless the user asks for API/debug details."},"reference_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":10},"reference_media_ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10,"description":"Completed My Media image ids from /editor/media. These are appended to reference_image_urls."},"source_video_url":{"type":"string","format":"uri"},"source_video_media_id":{"type":"string","format":"uuid","description":"Completed My Media video id to use instead of source_video_url."},"motion_video_url":{"type":"string","format":"uri"},"motion_video_media_id":{"type":"string","format":"uuid","description":"Completed My Media video id to use instead of motion_video_url."},"audio_url":{"type":"string","format":"uri"},"audio_media_id":{"type":"string","format":"uuid","description":"Completed My Media audio id to use instead of audio_url."},"generate_audio":{"type":"boolean","default":true},"request_count":{"type":"integer","minimum":1,"maximum":10,"default":1},"idempotency_key":{"type":"string","maxLength":160,"description":"Use for safe retries. The Idempotency-Key header is also accepted."}}},"CatalogResponse":{"type":"object","properties":{"object":{"type":"string","const":"catalog"},"static_ads":{"type":"array","items":{"$ref":"#/components/schemas/TemplateCatalogItem"}},"video_ads":{"type":"array","items":{"$ref":"#/components/schemas/VideoTemplateCatalogItem"}},"ugc_ads":{"type":"array","items":{"$ref":"#/components/schemas/VideoTemplateCatalogItem"}},"ai_models":{"type":"array","items":{"$ref":"#/components/schemas/AiModelCatalogItem"}}}},"TemplateCatalogItem":{"type":"object","properties":{"slug":{"type":"string"},"title":{"type":"string"},"preview_image_url":{"type":"string","format":"uri"},"section":{"type":"string","enum":["static_ads","video_ads","ugc_ads"]},"default_aspect_ratio":{"type":"string"},"default_resolution":{"type":"string"},"presets":{"type":"array","items":{"$ref":"#/components/schemas/PresetReference"}}}},"VideoTemplateCatalogItem":{"allOf":[{"$ref":"#/components/schemas/TemplateCatalogItem"},{"type":"object","properties":{"type":{"type":"string","enum":["video_ad","ugc_ad"]},"quality_tiers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"model":{"type":"string"},"default_duration":{"type":"integer"},"duration_options":{"type":"array","items":{"type":"integer"}},"resolution":{"type":"string"},"credits":{"type":["integer","null"]}}}}}}]},"PresetReference":{"type":"object","description":"Built-in inspiration reference. Pass id as preset_id.","properties":{"id":{"type":"string"},"label":{"type":"string"},"preview_image_url":{"type":"string","format":"uri"},"poster_image_url":{"type":"string","format":"uri"}}},"AiModelCatalogItem":{"type":"object","properties":{"slug":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"default_variant_id":{"type":"string"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"model":{"type":"string"},"input_mode":{"type":"string"},"default_aspect_ratio":{"type":"string"},"default_duration":{"type":"integer"},"default_resolution":{"type":"string"},"credits":{"type":["integer","null"]}}}}}},"GenerationBatch":{"type":"object","properties":{"object":{"type":"string","const":"generation_batch"},"status":{"type":"string","enum":["queued","partial"]},"request_count":{"type":"integer"},"credits_deducted":{"type":"integer"},"remaining_credits":{"type":"integer"},"generations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"generation"},"status":{"type":"string"},"credits_deducted":{"type":"integer"}}}},"error":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/ErrorObject"}]},"idempotent_replay":{"type":"boolean","description":"Present and true when a completed idempotent response is replayed."}}},"Generation":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"generation"},"type":{"type":"string"},"status":{"type":"string","enum":["generating","completed","error"]},"url":{"type":["string","null"],"format":"uri"},"error":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/ErrorObject"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"WorkspaceAssets":{"type":"object","properties":{"object":{"type":"string","const":"workspace_assets"},"brand_kits":{"type":"array","items":{"$ref":"#/components/schemas/BrandKit"}},"avatars":{"type":"array","items":{"$ref":"#/components/schemas/PublicApiAvatar"}},"voices":{"type":"array","description":"Built-in and ready custom cloned voices. Use voices[].id as voice_id when creating faceless videos.","items":{"$ref":"#/components/schemas/PublicApiVoice"}},"reference_template_targets":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceTemplateTarget"}}}},"BrandKit":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer"},"brand_id":{"type":"integer"},"kit_name":{"type":"string"},"kit_data":{"type":"object","additionalProperties":true},"training_status":{"type":["string","null"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"PublicApiAvatar":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"isCustom":{"type":"boolean"}}},"PublicApiVoice":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"preview_url":{"type":"string","format":"uri"},"source":{"type":"string","enum":["built_in","custom_clone"]},"locale":{"type":"array","items":{"type":"string"}},"credits_9_16":{"type":"integer"},"credits_16_9":{"type":"integer"},"gender":{"type":"string"},"age":{"type":"string"},"style_tags":{"type":"array","items":{"type":"string"}},"recommendation_summary":{"type":"string"}}},"ReferenceTemplateTarget":{"type":"object","properties":{"template_slug":{"type":"string"},"template_category":{"type":"string","enum":["static-ads","video-templates","slideshow-carousel"]},"label":{"type":"string"},"accepts_media_kinds":{"type":"array","items":{"type":"string","enum":["image","slideshow","video"]}}}},"CreateSlideshowRequest":{"type":"object","properties":{"prompt":{"type":"string"},"title":{"type":"string"},"slide_count":{"type":"integer","enum":[3,4,5,6,8,9,10],"default":6},"aspect_ratio":{"type":"string","enum":["9:16","1:1","4:5"],"default":"4:5"},"product_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":10},"avatar_id":{"type":"string"},"avatar_image_url":{"type":"string","format":"uri"},"brand_kit_id":{"type":"integer"},"custom_reference_inspiration_id":{"type":"string","format":"uuid"},"language":{"type":"string","default":"English"},"product_context":{"type":"string"},"generate_text_overlays":{"type":"boolean","default":false,"description":"When true, Videotok generates editable text overlays. When false, slides are created without generated overlay text. Defaults to false."},"idempotency_key":{"type":"string","minLength":1,"maxLength":160,"description":"Use for safe retries. The Idempotency-Key header is also accepted."}}},"SlideshowGeneration":{"type":"object","properties":{"object":{"type":"string","const":"slideshow_generation"},"status":{"type":"string","const":"queued"},"slideshow_id":{"type":"string","format":"uuid"},"video_id":{"type":"integer"},"title":{"type":"string"},"slide_count":{"type":"integer"},"credits_deducted":{"type":"integer"},"remaining_credits":{"type":"integer"},"idempotent_replay":{"type":"boolean","description":"Present and true when a completed idempotent response is replayed."}}},"Slideshow":{"type":"object","additionalProperties":true,"properties":{"object":{"type":"string","const":"slideshow"},"id":{"type":"string","format":"uuid"},"video_id":{"type":"integer"},"status":{"type":"string"}}},"CreateFacelessVideoRequest":{"type":"object","properties":{"prompt":{"type":"string"},"script":{"type":"string"},"title":{"type":"string"},"aspect_ratio":{"type":"string","enum":["9:16","16:9"],"default":"9:16"},"duration":{"type":"string","default":"26"},"image_style":{"type":"string","default":"Veo 3.1 Lite"},"voice_id":{"type":"string","default":"ash"},"language":{"type":"string","default":"en"},"reference_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":10},"selected_ai_styles":{"type":"array","items":{"type":"string"},"maxItems":8},"selected_flux_dev_styles":{"type":"array","items":{"type":"string"},"maxItems":8},"brand_kit_id":{"type":"integer"},"idempotency_key":{"type":"string","minLength":1,"maxLength":160,"description":"Use for safe retries. The Idempotency-Key header is also accepted."}}},"FacelessVideoGeneration":{"type":"object","properties":{"object":{"type":"string","const":"faceless_video_generation"},"status":{"type":"string","const":"queued"},"video_id":{"type":"integer"},"credits_deducted":{"type":"integer"},"remaining_credits":{"type":"integer"},"script":{"type":"string"},"idempotent_replay":{"type":"boolean","description":"Present and true when a completed idempotent response is replayed."}}},"Video":{"type":"object","additionalProperties":true,"properties":{"object":{"type":"string","const":"video"},"id":{"type":"integer"},"status":{"type":"string"},"video_url":{"type":["string","null"],"format":"uri"},"url":{"type":["string","null"],"format":"uri"}}},"CreateReferenceInspirationRequest":{"type":"object","required":["template_slug","template_category"],"properties":{"template_slug":{"type":"string"},"template_category":{"type":"string","enum":["static-ads","video-templates","slideshow-carousel"]},"media_kind":{"type":"string","enum":["image","slideshow","video"],"default":"image"},"visibility":{"type":"string","enum":["private","public"],"default":"private"},"label":{"type":"string"},"image_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":12},"images":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/InlineMedia"},"description":"Inline images must be PNG, JPEG, or WebP. Each base64 payload is limited to roughly 10 MB decoded."},"video_url":{"type":"string","format":"uri"}}},"ReferenceInspiration":{"type":"object","properties":{"object":{"type":"string","const":"reference_inspiration"},"reference":{"$ref":"#/components/schemas/ReferenceInspirationRecord"},"credits_deducted":{"type":"integer"},"remaining_credits":{"type":["integer","null"]}}},"ReferenceList":{"type":"object","properties":{"object":{"type":"string","const":"reference_inspiration_list"},"template_targets":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceTemplateTarget"}},"references":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceInspirationRecord"}}}},"ReferenceRecommendations":{"type":"object","properties":{"object":{"type":"string","const":"reference_inspiration_recommendations"},"references":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceInspirationRecord"}}}},"ReferenceInspirationRecord":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"integer"},"template_slug":{"type":"string"},"template_category":{"type":"string","enum":["static-ads","video-templates","slideshow-carousel"]},"media_kind":{"type":"string","enum":["image","slideshow","video"]},"visibility":{"type":"string","enum":["private","public"]},"label":{"type":"string"},"preview_image_url":{"type":["string","null"],"format":"uri"},"video_url":{"type":["string","null"],"format":"uri"},"media_urls":{"type":"array","items":{"type":"string","format":"uri"}},"analysis_status":{"type":"string"},"analysis_error":{"type":["string","null"]},"public_approval_status":{"type":"string"},"created_at":{"type":"string"}}},"ReferenceTargetSuggestions":{"type":"object","properties":{"object":{"type":"string","const":"reference_template_target_suggestions"},"media_kind":{"type":"string"},"image_count":{"type":"integer"},"has_video":{"type":"boolean"},"suggestions":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ReferenceTemplateTarget"},{"type":"object","properties":{"score":{"type":"number"},"reason":{"type":"string"}}}]}},"next_step":{"type":"string"}}},"CreateEditorVideoRequest":{"type":"object","properties":{"title":{"type":"string"},"aspect_ratio":{"type":"string","enum":["9:16","16:9","1:1","4:5"],"default":"9:16"},"fps":{"type":"integer","default":30,"minimum":1,"maximum":120}}},"EditorVideo":{"type":"object","properties":{"object":{"type":"string","const":"editor_video"},"video":{"$ref":"#/components/schemas/EditorVideoRecord"}}},"EditorVideoList":{"type":"object","properties":{"object":{"type":"string","const":"editor_video_list"},"videos":{"type":"array","items":{"$ref":"#/components/schemas/EditorVideoRecord"}}}},"EditorVideoRecord":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":["string","null"]},"status":{"type":["string","null"],"description":"Editor projects created through the public API use ready because they can be opened immediately."},"video_type":{"type":"string"},"aspect_ratio":{"oneOf":[{"$ref":"#/components/schemas/Dimensions"},{"type":"null"}]},"created_at":{"type":"string"},"editor_summary":{"$ref":"#/components/schemas/EditorSummary"},"editor":{"$ref":"#/components/schemas/EditorState"}}},"EditorSummary":{"type":"object","properties":{"trackCount":{"type":"integer"},"itemCount":{"type":"integer"},"assetCount":{"type":"integer"},"fps":{"type":"number"},"compositionWidth":{"type":"number"},"compositionHeight":{"type":"number"},"itemTypes":{"type":"object","additionalProperties":{"type":"integer"}},"totalDurationFrames":{"type":"integer"},"totalDurationSeconds":{"type":"number"}}},"EditorState":{"type":"object","properties":{"tracks":{"type":"array","items":{"type":"object","additionalProperties":true}},"items":{"type":"object","additionalProperties":{"type":"object"}},"assets":{"type":"object","additionalProperties":{"type":"object"}},"fps":{"type":"number"},"compositionWidth":{"type":"number"},"compositionHeight":{"type":"number"}}},"Dimensions":{"type":"object","properties":{"width":{"type":"number"},"height":{"type":"number"}}},"InlineMedia":{"type":"object","required":["filename","content_type","data"],"properties":{"filename":{"type":"string"},"content_type":{"type":"string"},"data":{"type":"string","description":"Base64 data, with or without a data URL prefix."}}},"UploadEditorMediaRequest":{"type":"object","description":"Upload media to My Media. For JSON requests, pass exactly one of media or source_url. Multipart requests can upload a file field directly.","properties":{"media":{"$ref":"#/components/schemas/InlineMedia"},"source_url":{"type":"string","format":"uri","description":"HTTPS URL that Videotok downloads into My Media. Useful for large agent-generated files."},"filename":{"type":"string","description":"Optional filename override for source_url."},"content_type":{"type":"string","description":"Optional MIME type hint for source_url."},"media_type":{"type":"string","enum":["image","video","audio"]},"title":{"type":"string"},"video_id":{"type":"integer","minimum":1},"add_to_editor":{"type":"boolean","default":false},"placement":{"$ref":"#/components/schemas/EditorPlacement"}},"oneOf":[{"required":["media"]},{"required":["source_url"]}]},"UploadEditorMediaMultipartRequest":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"Image, video, or audio file to upload."},"media_type":{"type":"string","enum":["image","video","audio"]},"title":{"type":"string"},"filename":{"type":"string"},"content_type":{"type":"string"},"video_id":{"type":"integer","minimum":1},"add_to_editor":{"type":"boolean","default":false},"placement":{"type":"string","description":"Optional JSON string matching EditorPlacement. Placement fields such as from_seconds and duration_seconds are also accepted as form fields."},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"source_start_seconds":{"type":"number","minimum":0},"playback_rate":{"type":"number","minimum":0.1,"maximum":8},"track_id":{"type":"string"},"audio_role":{"type":"string","enum":["source_video","audio","music","voice","voiceover","sound_effect"]},"fit":{"type":"string","enum":["cover","contain"]},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}}},"EditorMediaUpload":{"type":"object","properties":{"object":{"type":"string","const":"editor_media_upload"},"media":{"$ref":"#/components/schemas/EditorMediaItem"},"editor":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/EditorMediaAdditionResult"}]}}},"EditorMediaList":{"type":"object","properties":{"object":{"type":"string","const":"editor_media_list"},"media":{"type":"array","items":{"$ref":"#/components/schemas/EditorMediaItem"}}}},"EditorMediaItem":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","format":"uuid"},"media_type":{"type":"string","enum":["image","video","audio","voice"]},"url":{"type":"string","format":"uri"},"filename":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"AddEditorMediaRequest":{"type":"object","properties":{"media_id":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri"},"media_type":{"type":"string","enum":["image","video","audio","voice"]},"filename":{"type":"string"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"from_seconds":{"type":"number","minimum":0,"default":0},"source_start_seconds":{"type":"number","minimum":0,"default":0},"playback_rate":{"type":"number","minimum":0.1,"maximum":8,"default":1},"track_id":{"type":"string"},"audio_role":{"type":"string","enum":["source_video","audio","music","voice","voiceover","sound_effect"]},"fit":{"type":"string","enum":["cover","contain"]},"left":{"type":"number"},"top":{"type":"number"},"item_width":{"type":"number","exclusiveMinimum":0},"item_height":{"type":"number","exclusiveMinimum":0}}},"EditorPlacement":{"type":"object","properties":{"from_seconds":{"type":"number","minimum":0,"default":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"source_start_seconds":{"type":"number","minimum":0,"default":0},"playback_rate":{"type":"number","minimum":0.1,"maximum":8,"default":1},"track_id":{"type":"string"},"audio_role":{"type":"string","enum":["source_video","audio","music","voice","voiceover","sound_effect"]},"fit":{"type":"string","enum":["cover","contain"],"default":"cover"},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}}},"EditorMediaAddition":{"type":"object","allOf":[{"$ref":"#/components/schemas/EditorMediaAdditionResult"},{"type":"object","properties":{"object":{"type":"string","const":"editor_media_addition"}}}]},"EditorMediaAdditionResult":{"type":"object","properties":{"video_id":{"type":"integer"},"asset_id":{"type":"string"},"item_id":{"type":"string"},"editor_summary":{"$ref":"#/components/schemas/EditorSummary"}}},"ApplyEditorEditsRequest":{"type":"object","properties":{"instructions":{"type":"string"},"operations":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/EditorOperation"}}}},"CaptionWord":{"type":"object","required":["word","startMs","endMs"],"properties":{"word":{"type":"string","minLength":1,"maxLength":120},"startMs":{"type":"number","minimum":0},"endMs":{"type":"number","minimum":0},"confidence":{"type":"number","minimum":0,"maximum":1}}},"CaptionEntry":{"type":"object","required":["text","startMs","endMs"],"properties":{"text":{"type":"string","minLength":1,"maxLength":500},"startMs":{"type":"number","minimum":0},"endMs":{"type":"number","minimum":0},"timestampMs":{"type":"number","nullable":true,"minimum":0},"confidence":{"type":"number","nullable":true,"minimum":0,"maximum":1},"words":{"type":"array","maxItems":120,"items":{"$ref":"#/components/schemas/CaptionWord"}}}},"TextStyle":{"type":"object","properties":{"color":{"type":"string"},"align":{"type":"string","enum":["left","center","right"]},"font_family":{"type":"string"},"font_weight":{"type":"string"},"font_size":{"type":"number","minimum":8,"maximum":400},"line_height":{"type":"number","minimum":0.5,"maximum":4},"letter_spacing":{"type":"number","minimum":-20,"maximum":80},"direction":{"type":"string","enum":["ltr","rtl"]},"stroke_width":{"type":"number","minimum":0,"maximum":40},"stroke_color":{"type":"string"},"background_color":{"type":"string","nullable":true},"background_horizontal_padding":{"type":"number","minimum":0,"maximum":200},"background_border_radius":{"type":"number","minimum":0,"maximum":200},"fade_in_seconds":{"type":"number","minimum":0,"maximum":30},"fade_out_seconds":{"type":"number","minimum":0,"maximum":30}}},"CaptionStyle":{"allOf":[{"$ref":"#/components/schemas/TextStyle"},{"type":"object","properties":{"highlight_color":{"type":"string"},"highlight_background_color":{"type":"string"},"page_duration_ms":{"type":"integer","minimum":100,"maximum":10000},"caption_start_seconds":{"type":"number","minimum":0},"max_lines":{"type":"integer","minimum":1,"maximum":6},"template_key":{"type":"string"},"words_per_caption":{"type":"integer","minimum":1,"maximum":12},"split_on_punctuation":{"type":"boolean"},"playback_rate":{"type":"number","minimum":0.1,"maximum":8}}}]},"VoiceoverSettings":{"type":"object","properties":{"stability":{"type":"number","minimum":0,"maximum":1},"similarity_boost":{"type":"number","minimum":0,"maximum":1},"style":{"type":"number","minimum":0,"maximum":1},"use_speaker_boost":{"type":"boolean"},"speed":{"type":"number","minimum":0.7,"maximum":1.2}}},"AnimationConfig":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["none","fade","slide","scale","bounce","flip","zoom","glitch","swipe","float","snap"]},"duration_seconds":{"type":"number","minimum":0,"maximum":30},"direction":{"type":"string","enum":["left","right","top","bottom"]}}},"EditorOperation":{"oneOf":[{"type":"object","required":["type","title"],"properties":{"type":{"type":"string","const":"set_title"},"title":{"type":"string","minLength":1,"maxLength":160}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"remove_item"},"item_id":{"type":"string","minLength":1}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"set_item_timing"},"item_id":{"type":"string","minLength":1},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"set_item_source"},"item_id":{"type":"string","minLength":1},"source_start_seconds":{"type":"number","minimum":0},"playback_rate":{"type":"number","minimum":0.1,"maximum":8}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"set_item_audio"},"item_id":{"type":"string","minLength":1},"volume_db":{"type":"number","minimum":-60,"maximum":24},"audio_fade_in_seconds":{"type":"number","minimum":0,"maximum":30},"audio_fade_out_seconds":{"type":"number","minimum":0,"maximum":30}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"set_audio_levels"},"item_ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1}},"exclude_item_ids":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1}},"item_types":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"string","enum":["audio","video"]}},"audio_roles":{"type":"array","minItems":1,"maxItems":6,"items":{"type":"string","enum":["source_video","audio","music","voice","voiceover","sound_effect"]}},"volume_db":{"type":"number","minimum":-60,"maximum":24},"audio_fade_in_seconds":{"type":"number","minimum":0,"maximum":30},"audio_fade_out_seconds":{"type":"number","minimum":0,"maximum":30}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"set_item_animation"},"item_id":{"type":"string","minLength":1},"enter":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/AnimationConfig"}]},"exit":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/AnimationConfig"}]}}},{"type":"object","required":["type","from_item_id","to_item_id"],"properties":{"type":{"type":"string","const":"apply_item_transition"},"from_item_id":{"type":"string","minLength":1},"to_item_id":{"type":"string","minLength":1},"overlap_seconds":{"type":"number","minimum":0,"maximum":30},"preserve_to_item_end":{"type":"boolean"},"exit":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/AnimationConfig"}]},"enter":{"anyOf":[{"type":"null"},{"$ref":"#/components/schemas/AnimationConfig"}]}}},{"type":"object","required":["type","item_id","at_seconds"],"properties":{"type":{"type":"string","const":"split_item"},"item_id":{"type":"string","minLength":1},"at_seconds":{"type":"number","minimum":0}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"set_item_transform"},"item_id":{"type":"string","minLength":1},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0},"opacity":{"type":"number","minimum":0,"maximum":1}}},{"type":"object","required":["type","item_id","track_id"],"properties":{"type":{"type":"string","const":"move_item_to_track"},"item_id":{"type":"string","minLength":1},"track_id":{"type":"string","minLength":1}}},{"type":"object","required":["type","item_id","position"],"properties":{"type":{"type":"string","const":"set_item_layer_order"},"item_id":{"type":"string","minLength":1},"position":{"type":"string","enum":["front","back"]}}},{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"add_text"},"text":{"type":"string","minLength":1,"maxLength":2000},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"track_id":{"type":"string"},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0},"style":{"$ref":"#/components/schemas/TextStyle"}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"update_text"},"item_id":{"type":"string","minLength":1},"text":{"type":"string","minLength":1,"maxLength":2000},"style":{"$ref":"#/components/schemas/TextStyle"}}},{"type":"object","required":["type","captions"],"properties":{"type":{"type":"string","const":"add_captions"},"captions":{"type":"array","minItems":1,"maxItems":2000,"items":{"$ref":"#/components/schemas/CaptionEntry"}},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"track_id":{"type":"string"},"left":{"type":"number"},"top":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0},"style":{"$ref":"#/components/schemas/CaptionStyle"}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"add_sound_effect"},"sound_effect_id":{"type":"string","minLength":1,"maxLength":120},"url":{"type":"string","format":"uri"},"media_id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":180},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"source_start_seconds":{"type":"number","minimum":0},"volume_db":{"type":"number","minimum":-60,"maximum":24},"audio_fade_in_seconds":{"type":"number","minimum":0,"maximum":30},"audio_fade_out_seconds":{"type":"number","minimum":0,"maximum":30},"track_id":{"type":"string"}}},{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"add_voiceover"},"text":{"type":"string","minLength":1,"maxLength":12000},"voice_id":{"type":"string","minLength":1,"maxLength":160},"voice_name":{"type":"string","maxLength":180},"instructions":{"type":"string","maxLength":1000},"filename":{"type":"string","maxLength":180},"from_seconds":{"type":"number","minimum":0},"duration_seconds":{"type":"number","minimum":0.1,"maximum":3600},"source_start_seconds":{"type":"number","minimum":0},"volume_db":{"type":"number","minimum":-60,"maximum":24},"audio_fade_in_seconds":{"type":"number","minimum":0,"maximum":30},"audio_fade_out_seconds":{"type":"number","minimum":0,"maximum":30},"track_id":{"type":"string"},"voice_settings":{"$ref":"#/components/schemas/VoiceoverSettings"}}},{"type":"object","required":["type","item_id"],"properties":{"type":{"type":"string","const":"update_captions"},"item_id":{"type":"string","minLength":1},"captions":{"type":"array","minItems":1,"maxItems":2000,"items":{"$ref":"#/components/schemas/CaptionEntry"}},"style":{"$ref":"#/components/schemas/CaptionStyle"}}},{"type":"object","required":["type","source_item_ids"],"properties":{"type":{"type":"string","const":"generate_captions_from_items"},"source_item_ids":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1}},"captions_item_id":{"type":"string","minLength":1},"language":{"type":"string","minLength":1,"maxLength":32},"track_id":{"type":"string"},"style":{"$ref":"#/components/schemas/CaptionStyle"}}}]},"EditorEditResult":{"type":"object","properties":{"object":{"type":"string","const":"editor_edit_result"},"video_id":{"type":"integer"},"applied":{"type":"array","items":{"type":"string"}},"instructions_recorded":{"type":"boolean"},"editor_summary":{"type":"object","additionalProperties":true}}},"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/ErrorObject"}}},"ErrorObject":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","enum":["bad_request","forbidden","idempotency_conflict","insufficient_credits","invalid_api_key","not_found","payment_required","rate_limited","server_error","unauthorized"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"context":{"type":"object"}}}}}}