Skip to content

Get your task result

This endpoint retrieves the details and current status of a specific task by its unique task ID. Use this endpoint to poll the progress of your submitted tasks (such as image generation, text-to-model, image-to-model etc.) and obtain the final results once the task is completed.

Endpoint

Parameters

Required path param

task_id: The task id returned from your created tasks.

Returns

task_id: The unique identifier for the task, which should match the identifier used in the request.

type: Specifies the type of the task.

status: Reflects the current status of the task, categorized into two types: finalized (indicating no further updates for this task) and ongoing. There are eight possible status values:

  • Ongoing
    • queued: The task is awaiting its turn for processing.
    • running: The task is currently ongoing.
  • Finalized
    • success: The task has been completed successfully. The output values can be used as the final result.
    • failed: The task has failed, often due to issues on our end. Please refer to our error code first. If still unclear, please report the situation along with the task_id for support.
    • banned: The task has been banned due to violating our content policy.
    • expired: The task has expired after a certain period. Please try again and report this along with the task_id for support if it appears again.
    • cancelled: The task has been cancelled.
    • unknown: The current status of the task cannot be determined, which may indicate a system-level issue. Please contact support with the task_id.

input: An object containing input data, the structure of which varies depending on the task_type.

output: An object containing the results of the task. This may include:

  • model: A URL to download the model, which by default expires after five minutes.
  • base_model: A URL to download the base model, which by default expires after five minutes.
  • pbr_model: A URL to download the pbr model, which by default expires after five minutes.
  • generated_image: A URL for generated image, which by default expires after five minutes.
  • rendered_image: A URL for a preview image of the model, which by default expires after five minutes.
  • generate_multiview_image: The output for generate_multiview_image and edit_multiview_image tasks. It contains four fixed views in order: front, left, back, right.
    • front_view_url: Download URL for the front view image.
    • left_view_url: Download URL for the left view image.
    • back_view_url: Download URL for the back view image.
    • right_view_url: Download URL for the right view image.

progress: A numerical indicator of the task’s progress, ranging from 0 to 100 (inclusive).

  • When status is queued, the progress value will be 0.
  • When status is running, this value indicates the task’s progress.
  • When status is success, progress will be marked as 100.
  • In all other cases, progress value should not be considered meaningful.

consumed_credit: The number of credits consumed by this task, if the task failed, it will be 0.

queuing_num: The current queue position for this task. Returns -1 when the task is not in queue.

running_left_time: Estimated remaining running time in seconds. Returns -1 when the task finalized.

create_time: The timestamp when the task was created, providing a temporal reference.

Important Notes

  • Same API key required: A task must be queried using the same API key that initiated it. If you query a task with a different key (even one belonging to the same user), the API will return a "task not found" error.
  • Undocumented output fields: The output field may occasionally contain additional, undocumented fields. These fields can vary and may not always be present — do not rely on them for critical application logic.