API Reference

Tasks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve a task

tasks.retrieve(task_id) -> TaskRetrieveResponse { task }

GET/api/tasks/{taskId}

Retrieve a single task.

ParametersExpand Collapse

task_id: String

ReturnsExpand Collapse

class TaskRetrieveResponse { task }

task: Task { id, completed_at, created_at, 8 more }

id: String

completed_at: String

created_at: String

created_by_user_id: String

organization_id: String

status: :pending | :running | :completed | 2 more

One of the following:

:pending

:running

:completed

:error

:aborted

title: String

totals: Totals{ credits, duration_ms, turn_count}

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

credits: Integer

duration_ms: Integer

turn_count: Integer

triggered_by: :api | :email | :schedule | :ui

One of the following:

:api

:email

:schedule

:ui

url: String

Web URL of the task in the Handinger dashboard.

worker_id: String

Retrieve a task

Ruby

HTTP

TypeScript

Python

Go

Ruby

CLI Tool

require "handinger"

handinger = Handinger::Client.new(api_key: "My API Key")

task = handinger.tasks.retrieve("tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D")

puts(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"
  }
}