# Text-to-Video ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /openapi/v2/video/text/generate: post: summary: Text-to-Video deprecated: false description: Generate a video from a text prompt. operationId: video_text_generate tags: - API /Core Capabilities - Core Capabilities parameters: - name: API-KEY in: header description: Your PixVerse API key. required: true example: your-api-key schema: type: string - name: Ai-trace-id in: header description: A unique UUID for this request. required: true example: 550e8400-e29b-41d4-a716-446655440000 schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: model: type: string description: Video generation model. enum: - c1 - v6 - v3.5 - v4 - v4.5 - v5 - v5-fast - v5.5 - v5.6 examples: - v6 prompt: type: string description: Generation prompt. maxLength: 5000 examples: - A cinematic scene with natural motion. duration: type: integer description: >- Duration in seconds. C1/V6: 1-15; V5.5/V5.6: 5, 8, or 10; older models: 5 or 8. Do not use unsupported duration/quality combinations. minimum: 1 maximum: 15 examples: - 5 quality: type: string description: Output resolution. enum: - 360p - 540p - 720p - 1080p examples: - 720p seed: type: integer description: Random seed. minimum: 0 maximum: 2147483647 examples: - 12345 webhook_id: type: string description: >- Optional ID of a Webhook configured in the same account, not a callback URL. Omit it when polling task status. examples: - replace-with-your-webhook-id aspect_ratio: type: string description: Output aspect ratio. 2:3, 3:2, and 21:9 are C1/V6 options. enum: - '16:9' - '9:16' - '4:3' - '3:4' - '1:1' - '2:3' - '3:2' - '21:9' generate_audio_switch: type: boolean description: >- Generate native audio with V5.5, V5.6, V6, or C1. Set to true to enable audio or false for silent output. default: false generate_multi_clip_switch: type: boolean description: >- Enable multi-clip generation with V5.5 or V6. Not supported with other models or template_id. default: false required: - model - prompt - duration - quality - aspect_ratio allOf: - anyOf: - properties: model: type: string duration: type: string x-apidog-orders: - model - duration type: object - properties: model: type: string duration: type: string not: properties: duration: enum: - 10 quality: enum: - 1080p required: - duration - quality x-apidog-orders: - duration - quality x-apidog-orders: - model - duration type: object - properties: model: type: string duration: type: string not: properties: duration: enum: - 8 quality: enum: - 1080p required: - duration - quality x-apidog-orders: - duration - quality x-apidog-orders: - model - duration type: object - properties: model: type: string duration: type: string x-apidog-orders: - model - duration type: object - anyOf: - properties: generate_multi_clip_switch: type: string x-apidog-orders: - generate_multi_clip_switch type: object - properties: model: type: string x-apidog-orders: - model type: object x-apidog-orders: - model - prompt - duration - quality - seed - webhook_id - aspect_ratio - generate_audio_switch - generate_multi_clip_switch examples: text_v6_minimum: value: model: v6 prompt: A blue glass marble rolls across a clean white table duration: 1 quality: 360p aspect_ratio: '1:1' summary: Minimal request (replace resource IDs) text_v6_complete: value: model: v6 prompt: >- Shot 1: A blue glass marble rolls across a clean white table in morning light. Shot 2: The camera follows as it reaches the edge and reflects the city skyline; cinematic lighting and realistic motion. duration: 5 quality: 720p aspect_ratio: '16:9' seed: 20260804 generate_audio_switch: true generate_multi_clip_switch: true summary: Complete scenario (replace resource IDs) text_c1_complete: value: model: c1 prompt: >- A cinematic red paper airplane glides through a sunlit glass studio, banks gently around a white sculpture, then lands on a wooden table; smooth tracking camera and natural synchronized ambience. duration: 5 quality: 720p aspect_ratio: '16:9' seed: 20260803 generate_audio_switch: true summary: Complete scenario (replace resource IDs) responses: '200': x-apidog-name: OK x-apidog-ordering: 0 description: >- Request processed. ErrCode=0 indicates business success; a nonzero ErrCode indicates failure, even with HTTP 200. content: application/json: schema: type: object properties: ErrCode: type: integer ErrMsg: type: string Resp: type: object properties: video_id: type: integer description: Task ID. Poll GET /openapi/v2/video/result/{video_id}. format: int64 minimum: 1 examples: - 123456789 credits: type: integer description: Credits consumed by the task. required: - video_id x-apidog-orders: - video_id - credits nullable: true required: - ErrCode - ErrMsg x-apidog-orders: - ErrCode - ErrMsg - Resp examples: accepted: summary: Illustrative accepted task; poll to completion value: ErrCode: 0 ErrMsg: Success Resp: video_id: 123456789 credits: 10 failure_multiclip_v56_reject: summary: V5.6 multi-clip request rejected value: ErrCode: 400017 ErrMsg: >- generate_multi_clip_switch is supported in model v5.5, v6 only. Resp: null failure_duration_1080_v4_5: summary: 'V4.5: 8 seconds at 1080p rejected' value: ErrCode: 400017 ErrMsg: durations longer than 5 seconds at 1080p need v5 or above. Resp: null headers: {} '400': x-apidog-ordering: 1 description: >- Invalid request. Preserve the response and trace ID for troubleshooting. content: application/json: schema: type: object properties: ErrCode: type: integer ErrMsg: type: string required: - ErrCode - ErrMsg x-apidog-orders: - ErrCode - ErrMsg headers: {} x-apidog-name: '' '401': x-apidog-ordering: 2 description: Authentication failure. Use a key from the global environment. content: application/json: schema: type: object properties: ErrCode: type: integer ErrMsg: type: string required: - ErrCode - ErrMsg x-apidog-orders: - ErrCode - ErrMsg headers: {} x-apidog-name: '' security: [] x-apidog-folder: API /Core Capabilities x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/772214/apis/api-13016634-run components: schemas: {} securitySchemes: {} servers: - url: https://app-api.pixverse.ai description: Prod Env security: [] ```