Skip to content

API Overview ​

Browse HTTP endpoints by module. Each page lists operations, parameters, request bodies, and responses.

For integration flows and best practices, see the Guide.

V2fun Algorithm API Hub

Task-based multimodal generation and asset-processing APIs.

  • Version: 1.5

Modules ​

Task State Objects ​

When polling a task status endpoint, the response body is one of the following formats depending on the current state.

Task has been accepted and is waiting in the queue (status: QUEUED). Returned with HTTP 201 from task-creation endpoints.

TaskCreated
└task_uuid
required
string(Task Uuid)

Unique identifier for the task

└task_type
required
string(Task Type)

Logical task category used by the backend pipeline.

└model
required
string(Model)

Model or worker name assigned to the task.

└status
required
string(TaskStatus)
Enum: QUEUED PROCESSING COMPLETED FAILED
└created_at
required
integer(Created At)

Unix timestamp, in seconds, when the task was created.

└queue_position
integer | null[0..∞]

Snapshot position in the model ready queue while the task is still waiting to start. This is not a guaranteed execution order under client-aware dispatching.

└estimated_queue_time
number | null[0..∞]

Best-effort estimate of seconds before processing starts, when available.

Task is currently being processed (status: PROCESSING).

TaskInProgress
└task_uuid
required
string(Task Uuid)

Unique identifier for the task

└task_type
required
string(Task Type)

Logical task category used by the backend pipeline.

└model
required
string(Model)

Model or worker name assigned to the task.

└status
required
string(TaskStatus)
Enum: QUEUED PROCESSING COMPLETED FAILED
└created_at
required
integer(Created At)

Unix timestamp, in seconds, when the task was created.

└progress
number(Progress)[0..1]

Normalized task progress between 0 and 1.

Default: `0`

Task has failed (status: FAILED). The result field may contain partial output if available before failure.

TaskFailed
└task_uuid
required
string(Task Uuid)

Unique identifier for the task

└task_type
required
string(Task Type)

Logical task category used by the backend pipeline.

└model
required
string(Model)

Model or worker name assigned to the task.

└status
required
string(TaskStatus)
Enum: QUEUED PROCESSING COMPLETED FAILED
└created_at
required
integer(Created At)

Unix timestamp, in seconds, when the task was created.

└failed_at
integer | null

Unix timestamp, in seconds, when the task failed.

└result
any(Result)

Task-specific partial output returned before failure, when available.

When a task completes successfully (status: COMPLETED), the response body contains the endpoint-specific result object (e.g. ImageCaptionResponse). See each endpoint's 200 response schema for details.

Synchronous vs Asynchronous ​

Task-based endpoints may return one of two success codes:

StatusWhenResponse body
200Task completed within the request (synchronous)Full task result
201Task accepted but not yet complete (asynchronous)Task reference with task_uuid

For asynchronous tasks, poll the corresponding GET /{endpoint}/{task_uuid} endpoint using the task_uuid from the response body to retrieve the final result.