Quick Start

Integrate with PixVerse in six steps:

Create an API Key.

Upload any required source media.

Submit a generation request.

Save Resp.video_id.

Query the task status.

Retrieve the completed output from Resp.url.

Prerequisites

A PixVerse API Platform account

An active API Key

1. Create an API Key

Sign in at https://platform.pixverse.ai and create an API Key. Keep it on your server and never expose it in client-side code, URLs, screenshots, or public logs.

2. Configure the Request

Production Base URL:

https://app-api.pixverse.ai

Header	Required	Description
`API-KEY`	Yes	Your PixVerse API Key.
`Ai-trace-id`	Yes	A new UUID for this request.
`Content-Type`	Depends on endpoint	Use `application/json` for JSON requests. Upload endpoints use `multipart/form-data`.

Ai-trace-id is a tracing identifier, not an idempotency key. Reusing it may create another task. Before retrying a generation request, check whether the original request returned a task ID.

3. Prepare Input Media

Upload source files before calling endpoints that require media IDs.

Input	Endpoint	Returned value
Image	`POST /openapi/v2/image/upload`	`Resp.img_id`
Video or audio	`POST /openapi/v2/media/upload`	`Resp.media_id`

Use the returned ID only with compatible endpoints in the same API account and region.

4. Create a Video Task

Choose the HTTP interface that matches your workflow, such as Text-to-Video, Image-to-Video, Video Templates, First and Last Frame Video, or a supported solution endpoint. Complete request parameters and examples are provided on each interface page.

Example Text-to-Video request:

A successful creation response returns ErrCode=0 and a Resp.video_id. It does not mean that generation has completed.

5. Query Task Status

Call GET /openapi/v2/video/result/{video_id} every 3-5 seconds with a new Ai-trace-id.

`status`	Meaning
`1`	Generation completed
`5`	Generating
`7`	Content moderation failed
`8`	Generation failed

6. Retrieve the Result

Treat the task as complete only when status=1 and Resp.url is accessible. Preserve the request time, video_id, HTTP status, ErrCode, and Ai-trace-id when troubleshooting.

Get Help

Contact api_business@pixverse.ai and include non-sensitive request details. Never send your full API Key.

Prerequisites#

1. Create an API Key#

2. Configure the Request#

3. Prepare Input Media#

4. Create a Video Task#

5. Query Task Status#

6. Retrieve the Result#

Get Help#