PixVerse V6 — API reference

PixVerse V6 uses the model ID pixverse/v6/text-to-video. PixVerse V6 Text to Video on Runware with optional native synchronized audio.

1. Calling the API

Send requests to https://api.higgsfield.ai/pixverse/v6/text-to-video with a JSON body matching the parameters below.

Install

Install an official server-side SDK. cURL needs no package.

npm install @higgsfield/client

Setup

Keep credentials in server-side environment variables. The SDKs accept the same KEY_ID:KEY_SECRET value under their documented variable names.

export HF_CREDENTIALS="YOUR_KEY_ID:YOUR_KEY_SECRET" # TypeScript
export HF_KEY="YOUR_KEY_ID:YOUR_KEY_SECRET"         # Python and cURL

Request parameters

Parameter	Type	Required	Default	Description
`seed`	`integer`	No	`—`	Seed. Minimum: 0. Maximum: 2147483647.
`prompt`	`string`	Yes	`—`	Prompt. Minimum length: 1. Maximum length: 5000.
`duration`	`number`	No	`5`	Duration. Minimum: 1. Maximum: 15.
`resolution`	`string`	No	`"720p"`	Resolution. Options: 360p, 540p, 720p, 1080p.
`aspect_ratio`	`string`	No	`"16:9"`	Aspect ratio. Options: 16:9, 4:3, 1:1, 3:4, 9:16.
`generate_audio`	`boolean`	No	`true`	Generate audio.
`negative_prompt`	`string`	No	`—`	Negative prompt. Minimum length: 1. Maximum length: 2048.

2. Authentication

The official SDKs read credentials from the server environment and send the required Authorization: Key KEY_ID:KEY_SECRET header.

API Key

Never expose the secret in browser-side code or commit it to source control. The TypeScript SDK is server-side only. For direct HTTP calls, use:

Authorization: Key $HF_KEY

3. Queue

subscribe submits the asynchronous request and waits for a terminal result. The TypeScript SDK polls automatically when withPolling: true; the Python SDK's synchronous subscribe call also waits. A completed request returns the generated file in the video field.

Submit and wait

import { config, higgsfield } from "@higgsfield/client/v2";

config({
  credentials: process.env.HF_CREDENTIALS,
});

const result = await higgsfield.subscribe(
  "pixverse/v6/text-to-video",
  {
    input: {
      "prompt": "A cinematic scene at sunset",
      "duration": 5,
      "resolution": "720p",
      "aspect_ratio": "16:9",
      "generate_audio": true
    },
    withPolling: true,
  },
);

console.log(result);

Explicit lifecycle control

Use the Python SDK when a worker needs explicit status, result, or cancellation control for an existing request. The TypeScript v2 client currently exposes automatic polling through subscribe.

import higgsfield_client

request_id = "{request_id}"
status = higgsfield_client.status(request_id=request_id)
result = higgsfield_client.result(request_id=request_id)
higgsfield_client.cancel(request_id=request_id)