Skip to main content
GET

Overview

Query the status and result of character creation tasks. Retrieve detailed information about created characters (character ID, display name, username, etc.) for use in subsequent video generation.
Usage Notes:
  • Character creation is an async task - poll this endpoint for results
  • Task completion returns character details
  • Character username can be referenced in prompts using @username format
  • Character task ID can be used via character_url parameter in video generation

Path Parameters

string
required
Character creation task IDThis is the task ID returned from the Create Character APIExample: "task_01KBZ0TZZ7C7M3WS1TJM0PH8J4"

Authentication

string
required
Bearer Token authentication
Get your API Key from the API Key Management Page

Response Fields

string
Unique task identifier (character creation task ID)
string
Object type, always generation.task
string
Model name used
string
Task status:
  • queued - Queued for processing
  • in_progress - Processing
  • completed - Successfully completed
  • failed - Failed
integer
Task progress percentage (0-100)
integer
Task creation time (Unix timestamp)
integer
Task completion time (Unix timestamp, only available after completion)
integer
Result expiration time (Unix timestamp, only available after completion)
object
Task result (only available when status is completed)result.type is character, and result.data.characters contains the character list
object
Error information (only available when status is failed)

Using Character in Video Generation

After character creation completes, you can use the character in video generation. There are two ways to reference:

Method 1: Use @username in prompt

Method 2: Use character_url parameter

Tip: username is obtained from the characters[].username field in query results, character_url uses the character creation task’s task_id.

Polling Recommendations