Getting Started

This page describes the basic integration requirements for the PixVerse API, including the service URL, authentication headers, common response structure, and endpoint documentation conventions.

Base URL

Environment	Base URL
Production	`https://app-api.pixverse.ai`

All endpoint paths are based on the above Base URL.

Example:

POST https://app-api.pixverse.ai/openapi/v2/video/text/generate

Authentication

Requests use the following headers:

Header	Required	Description
`API-KEY`	Yes	API Key used for authentication
`Ai-trace-id`	Yes	Unique request identifier used for tracing and troubleshooting
`Content-Type`	Depends on the endpoint	Use `application/json` for JSON endpoints and `multipart/form-data` for upload endpoints

Description:

Send API-KEY in the request header, not in the request body or URL query string.

Use a new UUID v4 value for Ai-trace-id with every request.

When contacting technical support, provide the Ai-trace-id from the affected request.

General response structure

Except for special cases such as file uploads and Webhook callbacks, PixVerse API responses usually use this structure:

{
  "ErrCode": 0,
  "ErrMsg": "Success",
  "Resp": {
    "video_id": 413620241010894,
    "credits": 35
  }
}

Field	Type	Description
`ErrCode`	integer	Business error code; `0` indicates success
`ErrMsg`	string	Business result message
`Resp`	object	Response payload; its structure varies by endpoint

Notes

ErrCode is the PixVerse business error code and is independent of the HTTP status code.

The HTTP status code indicates whether the request reached and was processed by the service at the protocol level.

To determine whether the business operation succeeded, check that ErrCode is 0.

The structure of Resp varies by endpoint. Refer to the response fields section on the relevant endpoint page.

Start Here

Getting Started#

Base URL#

Authentication#

General response structure#

Notes#

Getting Started

Base URL

Authentication

General response structure

Notes