{"components":{"schemas":{"Error":{"properties":{"error":{"properties":{"message":{"type":"string"},"type":{"type":"string"}},"type":"object"}},"type":"object"},"Video":{"properties":{"ai_images":{"type":"boolean"},"aspect_ratio":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"credits":{"type":"integer"},"credits_refunded":{"type":"boolean"},"duration_requested_sec":{"type":"integer"},"duration_sec":{"type":["number","null"]},"error":{"type":["string","null"]},"id":{"type":"string"},"language":{"type":"string"},"metadata":{"type":["object","null"]},"object":{"const":"video"},"progress":{"type":"integer"},"prompt":{"type":"string"},"resolution":{"type":"integer"},"status":{"enum":["queued","processing","completed","failed"],"type":"string"},"style":{"type":"string"},"thumbnail_url":{"type":["string","null"]},"title":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"video_url":{"description":"MP4 download, signed, valid 24 h.","type":["string","null"]},"voice":{"type":["string","null"]}},"type":"object"},"VideoCreate":{"properties":{"ai_images":{"default":false,"description":"AI-generated images instead of stock footage (+1 credit).","type":"boolean"},"aspect_ratio":{"description":"Default 9:16, or what the prompt asks for.","enum":["9:16","16:9"],"type":"string"},"duration_sec":{"default":60,"maximum":300,"minimum":6,"type":"integer"},"language":{"description":"Narration language (GET /languages). Default: the one requested or written in the prompt.","type":"string"},"metadata":{"description":"Your own data, returned as-is (max 2 KB).","type":"object"},"prompt":{"description":"What the video is about, in any language. Vaideo writes the script.","maxLength":4000,"minLength":5,"type":"string"},"style":{"description":"Visual style id (GET /styles). Default 'photo'.","type":"string"},"subtitles":{"default":true,"type":"boolean"},"voice":{"description":"Voice id (GET /voices) or 'none'.","type":"string"},"webhook_url":{"description":"Public https URL notified when the video completes or fails.","format":"uri","type":"string"}},"required":["prompt"],"type":"object"}},"securitySchemes":{"bearer":{"bearerFormat":"vd_live_\u2026","scheme":"bearer","type":"http"}}},"info":{"description":"Turn text into finished narrated videos. Docs: https://app2.vaideo.org/developers","title":"Vaideo API","version":"2026-11-20"},"openapi":"3.1.0","paths":{"/account":{"get":{"operationId":"getAccount","responses":{"200":{"description":"Account"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid API key"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limited"}},"summary":"Balance, pricing and webhook secret"}},"/credits/transactions":{"get":{"operationId":"listCreditTransactions","responses":{"200":{"description":"Transactions"}},"summary":"Credit history"}},"/languages":{"get":{"operationId":"listLanguages","responses":{"200":{"description":"Languages"}},"summary":"Narration languages"}},"/styles":{"get":{"operationId":"listStyles","responses":{"200":{"description":"Styles"}},"summary":"Visual styles"}},"/videos":{"get":{"operationId":"listVideos","parameters":[{"in":"query","name":"limit","schema":{"maximum":100,"type":"integer"}},{"in":"query","name":"starting_after","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Video"},"type":"array"},"has_more":{"type":"boolean"}},"type":"object"}}},"description":"Videos"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid API key"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limited"}},"summary":"List videos"},"post":{"operationId":"createVideo","parameters":[{"description":"Retry-safe: same key returns the same video.","in":"header","name":"Idempotency-Key","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Video"}}},"description":"Video queued"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid API key"},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not enough credits"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Prompt blocked by content policy"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limited"}},"summary":"Create a video"}},"/videos/estimate":{"post":{"operationId":"estimateVideo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoCreate"}}}},"responses":{"200":{"description":"Estimate"}},"summary":"Estimate credits"}},"/videos/{id}":{"get":{"operationId":"getVideo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Video"}}},"description":"Video"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid API key"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limited"}},"summary":"Get a video"}},"/videos/{id}/download":{"get":{"operationId":"downloadVideo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"302":{"description":"Redirect to the MP4"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not completed yet"}},"summary":"Download the MP4 (302 redirect)"}},"/voices":{"get":{"operationId":"listVoices","parameters":[{"in":"query","name":"language","schema":{"type":"string"}}],"responses":{"200":{"description":"Voices"}},"summary":"Voices"}}},"security":[{"bearer":[]}],"servers":[{"url":"https://app2.vaideo.org/api/v1"}]}
