Text-to-Video generation

POST

/openapi/v2/video/text/generate

OpenAPI 接口

Text-to-Video generation task

Request

Header Params

API-KEY

string

required

app-key from PixVerse platform

Ai-trace-id

string

required

traceID format: UUID, must be unique for each request

Example:

Body Params application/json

aspect_ratio

string

required

Aspect ratio (16:9, 4:3, 1:1, 3:4, 9:16)

Example:

16:9

duration

integer

required

Video duration (5, 8 seconds, --model=v3.5 only allows 5,8; --quality=1080p does not support 8s)

Example:

model

string

required

Model version (only supports v3.5)

Example:

v3.5

motion_mode

string

optional

Motion mode (normal, fast, --fast only available when duration=5; --quality=1080p does not support fast)

Default:

normal

Example:

normal

negative_prompt

string

optional

Negative prompt

<= 2048 characters

prompt

string

required

Prompt

<= 2048 characters

quality

string

required

Video quality ("360p"(Turbo model), "540p", "720p", "1080p")

Example:

540p

seed

integer

optional

Random seed, range: 0 - 2147483647

style

string

optional

Style (effective when model=v3.5, "anime", "3d_animation", "clay", "comic", "cyberpunk") Do not include style parameter unless needed

Example:

anime

template_id

integer

optional

Template ID (template_id must be activated before use)

Example:

302325299692608

water_mark

boolean

optional

Watermark (true: add watermark, false: no watermark)

Default:

false

Example:

false

Example

{
  "aspect_ratio": "16:9",
  "duration": 5,
  "model": "v3.5",
  "motion_mode": "normal",
  "negative_prompt": "string",
  "prompt": "string",
  "quality": "540p",
  "seed": 0,
  "template_id": 302325299692608,
  "water_mark": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app-api.pixverse.ai/openapi/v2/video/text/generate' \
--header 'API-KEY;' \
--header 'Ai-trace-id: {{$string.uuid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aspect_ratio": "16:9",
    "duration": 5,
    "model": "v3.5",
    "motion_mode": "normal",
    "negative_prompt": "string",
    "prompt": "string",
    "quality": "540p",
    "seed": 0,
    "template_id": 302325299692608,
    "water_mark": false
}'

Responses

🟢200OK

application/json

Token Expired

Body

ErrCode

integer

optional

ErrMsg

string

optional

Resp

object

dto.V2OpenAPII2VResp

optional

video_id

integer

optional

Video_id

Example

{
  "ErrCode": 0,
  "ErrMsg": "string",
  "Resp": {
    "video_id": 0
  }
}

Upload Image

Image-to-Video generation