Skip to main content
GET
cURL
Request Headers Query Attributes Response Attributes
cURL
The url field may be empty before completion. Use it only when status is 3. Poll until status is 3 or 4. A query with code: 1000 may still describe a failed generation task; inspect data.status and data.error_reason.
For input limits, billing, callbacks, and error codes, see the Character Swap V5 overview.

Authorizations

x-api-key
string
header
required

Query Parameters

_id
string
required

Stable task data.list[]._id returned by create, not downstream task_id; the record must belong to your user/team.

Pattern: ^[a-fA-F0-9]{24}$

Response

200 - application/json

Business response. Code 1000 means the request succeeded; inspect task status or data.errors for generation/submission outcomes.

code
integer
Example:

1000

msg
string
Example:

"OK"

data
object