Tasks

Retrieve a task

Fetch a task by id, including its current status and (once ready) its output.

get/v1/tasks/{id}

Request

  • Base URL: https://api.hotapi.ai
  • URL: https://api.hotapi.ai/v1/tasks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

An async task. Creation returns 202 with status=queued; poll GET /v1/tasks/{id} (or await the webhook) until a terminal status.

idstring required
object'task' required
modelstring required
task_kindstring required
inputobject required

The normalized request input the task was created with.

outputobject

Result payload, present once status=succeeded. Contains hosted asset URLs (re-hosted on our CDN).

estimated_credits_costinteger required

Credits charged up-front when the task was created (1000 credits = $1).

reference_video_secondsnumber

Input-video seconds measured and frozen at submission; reused for draft finalization billing. Zero when no reference video was supplied.

actual_credits_costinteger

Final credits charged after settlement (equals estimate today).

webhook_urlstring uri
api_key_idstring

The organization's API key that created the task; absent for dashboard/session-created tasks.

created_atinteger required

Unix seconds.

queued_atinteger

Unix seconds.

started_atinteger

Unix seconds.

completed_atinteger

Unix seconds.

expires_atinteger required

Unix seconds; result + asset retention deadline.

Example response

{
  "id": "task_8sd9f7aQ2",
  "model": "z-image-spicy",
  "task_kind": "image.generate",
  "error": {
    "type": "provider_error",
    "code": "generation_failed",
    "message": "Generation failed"
  },
  "estimated_credits_cost": 26,
  "api_key_id": "ak_8sd9f7aQ2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.