API Reference

Tasks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve a task

tasks.retrieve(strtask_id) -> TaskRetrieveResponse

GET/api/tasks/{taskId}

Retrieve a single task.

ParametersExpand Collapse

task_id: str

ReturnsExpand Collapse

class TaskRetrieveResponse: …

task: Task

id: str

completed_at: Optional[str]

created_at: str

created_by_user_id: Optional[str]

organization_id: str

status: Literal["pending", "running", "completed", 2 more]

One of the following:

"pending"

"running"

"completed"

"error"

"aborted"

title: str

totals: Totals

Aggregate credit spend, elapsed wall-clock, and number of turns across the task.

credits: int

duration_ms: int

turn_count: int

triggered_by: Literal["api", "email", "schedule", "ui"]

One of the following:

"api"

"email"

"schedule"

"ui"

url: str

Web URL of the task in the Handinger dashboard.

worker_id: str

Retrieve a task

Python

HTTP

TypeScript

Python

Go

Ruby

CLI Tool

import os
from handinger import Handinger

client = Handinger(
    api_key=os.environ.get("HANDINGER_API_KEY"),  # This is the default and can be omitted
)
task = client.tasks.retrieve(
    "tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
)
print(task.task)

200 example

{
  "task": {
    "id": "tsk_2Z-YWz3hFq6VlW",
    "completedAt": "2026-05-11T09:14:48.000Z",
    "createdAt": "2026-05-11T09:14:22.000Z",
    "createdByUserId": "usr_7yh-91XzM2nQ4",
    "organizationId": "org_8s1Df9aLp-1z",
    "status": "completed",
    "title": "Weather report for Barcelona",
    "totals": {
      "credits": 42,
      "durationMs": 25812,
      "turnCount": 1
    },
    "triggeredBy": "api",
    "url": "https://v3.handinger.com/worker/wrk_vk81XUHKHG-qr4/task/tsk_2Z-YWz3hFq6VlW",
    "workerId": "wrk_vk81XUHKHG-qr4"
  }
}

Returns Examples

200 example

{
  "task": {
    "id": "tsk_2Z-YWz3hFq6VlW",
    "completedAt": "2026-05-11T09:14:48.000Z",
    "createdAt": "2026-05-11T09:14:22.000Z",
    "createdByUserId": "usr_7yh-91XzM2nQ4",
    "organizationId": "org_8s1Df9aLp-1z",
    "status": "completed",
    "title": "Weather report for Barcelona",
    "totals": {
      "credits": 42,
      "durationMs": 25812,
      "turnCount": 1
    },
    "triggeredBy": "api",
    "url": "https://v3.handinger.com/worker/wrk_vk81XUHKHG-qr4/task/tsk_2Z-YWz3hFq6VlW",
    "workerId": "wrk_vk81XUHKHG-qr4"
  }
}