# Tasks

## Create a task

`client.tasks.create(TaskCreateParamsbody, RequestOptionsoptions?): Worker`

**post** `/api/tasks`

Run a new task against an existing worker and wait for the result. Send a `taskId` of a prior task to add a follow-up turn instead of starting a fresh task. Send `multipart/form-data` to attach files; the bytes are bootstrapped into the worker's workspace before the task starts. The task runs to completion on the server even if the connection drops; subscribe to task webhooks for long-running tasks.

### Parameters

- `body: TaskCreateParams`

  - `input: string`

  - `budget?: "low" | "standard" | "high" | "unlimited"`

    Compute budget the worker is allowed to spend on the task. Defaults to `standard`.

    - `"low"`

    - `"standard"`

    - `"high"`

    - `"unlimited"`

  - `taskId?: string`

    Optional client-provided task id. Reuse this id to add turns to an existing task.

  - `workerId?: string`

    Worker id the task belongs to. If omitted, a new worker is created on-the-fly using the input as instructions.

### Returns

- `Worker`

  - `id: string`

  - `created_at: number | null`

  - `error: unknown`

  - `files: Array<File>`

    - `filename: string | null`

    - `mediaType: string`

    - `url: string`

    - `size?: number`

  - `incomplete_details: unknown`

  - `messages: Array<unknown>`

  - `metadata: Record<string, unknown>`

  - `object: "worker"`

    - `"worker"`

  - `output: Array<Output>`

    - `id: string`

    - `content: Array<Content>`

      - `text: string`

      - `type: "output_text"`

        - `"output_text"`

    - `role: "assistant"`

      - `"assistant"`

    - `status: "completed"`

      - `"completed"`

    - `type: "message"`

      - `"message"`

  - `output_text: string`

  - `running: boolean`

  - `sources: Array<Source>`

    - `id: string`

    - `title: string | null`

    - `type: "url"`

      - `"url"`

    - `url: string`

  - `status: "running" | "completed" | "pending"`

    - `"running"`

    - `"completed"`

    - `"pending"`

  - `structured_output: Record<string, unknown> | null`

  - `url: string`

    Web URL of the worker in the Handinger dashboard.

  - `usage?: Usage`

    - `durationMs?: number`

### Example

```typescript
import Handinger from '@ramensoft/handinger';

const client = new Handinger({
  apiKey: process.env['HANDINGER_API_KEY'], // This is the default and can be omitted
});

const worker = await client.tasks.create({
  input: "What's the weather today in Barcelona?",
  workerId: 'wrk_vk81XUHKHG-qr4',
});

console.log(worker.id);
```

#### Response

```json
{
  "id": "id",
  "created_at": 0,
  "error": null,
  "files": [
    {
      "filename": "filename",
      "mediaType": "mediaType",
      "url": "https://example.com",
      "size": 0
    }
  ],
  "incomplete_details": null,
  "messages": [
    {}
  ],
  "metadata": {
    "foo": "bar"
  },
  "object": "worker",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "text": "text",
          "type": "output_text"
        }
      ],
      "role": "assistant",
      "status": "completed",
      "type": "message"
    }
  ],
  "output_text": "output_text",
  "running": true,
  "sources": [
    {
      "id": "id",
      "title": "title",
      "type": "url",
      "url": "url"
    }
  ],
  "status": "running",
  "structured_output": {
    "foo": "bar"
  },
  "url": "https://v3.handinger.com/worker/wrk_vk81XUHKHG-qr4",
  "usage": {
    "durationMs": 0
  }
}
```

## Retrieve a task

`client.tasks.retrieve(stringtaskID, RequestOptionsoptions?): TaskRetrieveResponse`

**get** `/api/tasks/{taskId}`

Retrieve a single task.

### Parameters

- `taskID: string`

### Returns

- `TaskRetrieveResponse`

  - `task: Task`

    - `id: string`

    - `completedAt: string | null`

    - `createdAt: string`

    - `createdByUserId: string | null`

    - `organizationId: string`

    - `status: "pending" | "running" | "completed" | 2 more`

      - `"pending"`

      - `"running"`

      - `"completed"`

      - `"error"`

      - `"aborted"`

    - `title: string`

    - `totals: Totals`

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

      - `credits: number`

      - `durationMs: number`

      - `turnCount: number`

    - `triggeredBy: "api" | "email" | "schedule" | "ui"`

      - `"api"`

      - `"email"`

      - `"schedule"`

      - `"ui"`

    - `url: string`

      Web URL of the task in the Handinger dashboard.

    - `workerId: string`

### Example

```typescript
import Handinger from '@ramensoft/handinger';

const client = new Handinger({
  apiKey: process.env['HANDINGER_API_KEY'], // This is the default and can be omitted
});

const task = await client.tasks.retrieve('tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D');

console.log(task.task);
```

#### Response

```json
{
  "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"
  }
}
```

## List task turns

`client.tasks.listTurns(stringtaskID, RequestOptionsoptions?): TaskTurnList`

**get** `/api/tasks/{taskId}/turns`

List the individual turns for a task in execution order.

### Parameters

- `taskID: string`

### Returns

- `TaskTurnList`

  - `items: Array<Turn>`

    - `id: string`

    - `completedAt: string | null`

    - `credits: number`

    - `durationMs: number`

    - `files: Array<File>`

      Files published by this turn.

      - `filename: string | null`

      - `mediaType: string`

      - `url: string`

      - `size?: number`

    - `input: string`

    - `inputTokens: number`

    - `outputText: string`

    - `outputTokens: number`

    - `role: string`

    - `seq: number`

    - `startedAt: string`

    - `status: string`

    - `structuredOutput: Record<string, unknown> | null`

      Structured JSON payload when the worker is configured with an output schema. `null` otherwise.

    - `taskId: string`

  - `taskId: string`

### Example

```typescript
import Handinger from '@ramensoft/handinger';

const client = new Handinger({
  apiKey: process.env['HANDINGER_API_KEY'], // This is the default and can be omitted
});

const taskTurnList = await client.tasks.listTurns('tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D');

console.log(taskTurnList.items);
```

#### Response

```json
{
  "items": [
    {
      "id": "trn_4Hq-9Vk2pLm8Rx",
      "completedAt": "2026-05-11T09:14:48.000Z",
      "credits": 42,
      "durationMs": 25812,
      "files": [
        {
          "filename": "filename",
          "mediaType": "mediaType",
          "url": "https://example.com",
          "size": 0
        }
      ],
      "input": "What's the weather today in Barcelona?",
      "inputTokens": 1842,
      "outputText": "It's currently 21°C and sunny in Barcelona with a light breeze from the south-east.",
      "outputTokens": 312,
      "role": "assistant",
      "seq": 0,
      "startedAt": "2026-05-11T09:14:22.000Z",
      "status": "completed",
      "structuredOutput": {
        "temperatureCelsius": "bar",
        "conditions": "bar"
      },
      "taskId": "tsk_2Z-YWz3hFq6VlW"
    }
  ],
  "taskId": "tsk_2Z-YWz3hFq6VlW"
}
```

## Archive a task

`client.tasks.delete(stringtaskID, RequestOptionsoptions?): DeleteTaskResponse`

**delete** `/api/tasks/{taskId}`

Archive a task so it stops appearing in `GET /tasks` results. Turns and files are retained for audit purposes. Only the worker creator can archive a task.

### Parameters

- `taskID: string`

### Returns

- `DeleteTaskResponse`

  - `archived: boolean`

### Example

```typescript
import Handinger from '@ramensoft/handinger';

const client = new Handinger({
  apiKey: process.env['HANDINGER_API_KEY'], // This is the default and can be omitted
});

const deleteTaskResponse = await client.tasks.delete('tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D');

console.log(deleteTaskResponse.archived);
```

#### Response

```json
{
  "archived": true
}
```

## Domain Types

### Create Task

- `CreateTask`

  - `input: string`

  - `budget?: "low" | "standard" | "high" | "unlimited"`

    Compute budget the worker is allowed to spend on the task. Defaults to `standard`.

    - `"low"`

    - `"standard"`

    - `"high"`

    - `"unlimited"`

  - `taskId?: string`

    Optional client-provided task id. Reuse this id to add turns to an existing task.

  - `workerId?: string`

    Worker id the task belongs to. If omitted, a new worker is created on-the-fly using the input as instructions.

### Delete Task Response

- `DeleteTaskResponse`

  - `archived: boolean`

### Task

- `Task`

  - `id: string`

  - `completedAt: string | null`

  - `createdAt: string`

  - `createdByUserId: string | null`

  - `organizationId: string`

  - `status: "pending" | "running" | "completed" | 2 more`

    - `"pending"`

    - `"running"`

    - `"completed"`

    - `"error"`

    - `"aborted"`

  - `title: string`

  - `totals: Totals`

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

    - `credits: number`

    - `durationMs: number`

    - `turnCount: number`

  - `triggeredBy: "api" | "email" | "schedule" | "ui"`

    - `"api"`

    - `"email"`

    - `"schedule"`

    - `"ui"`

  - `url: string`

    Web URL of the task in the Handinger dashboard.

  - `workerId: string`

### Task Turn List

- `TaskTurnList`

  - `items: Array<Turn>`

    - `id: string`

    - `completedAt: string | null`

    - `credits: number`

    - `durationMs: number`

    - `files: Array<File>`

      Files published by this turn.

      - `filename: string | null`

      - `mediaType: string`

      - `url: string`

      - `size?: number`

    - `input: string`

    - `inputTokens: number`

    - `outputText: string`

    - `outputTokens: number`

    - `role: string`

    - `seq: number`

    - `startedAt: string`

    - `status: string`

    - `structuredOutput: Record<string, unknown> | null`

      Structured JSON payload when the worker is configured with an output schema. `null` otherwise.

    - `taskId: string`

  - `taskId: string`

### Turn

- `Turn`

  - `id: string`

  - `completedAt: string | null`

  - `credits: number`

  - `durationMs: number`

  - `files: Array<File>`

    Files published by this turn.

    - `filename: string | null`

    - `mediaType: string`

    - `url: string`

    - `size?: number`

  - `input: string`

  - `inputTokens: number`

  - `outputText: string`

  - `outputTokens: number`

  - `role: string`

  - `seq: number`

  - `startedAt: string`

  - `status: string`

  - `structuredOutput: Record<string, unknown> | null`

    Structured JSON payload when the worker is configured with an output schema. `null` otherwise.

  - `taskId: string`

### Task Retrieve Response

- `TaskRetrieveResponse`

  - `task: Task`

    - `id: string`

    - `completedAt: string | null`

    - `createdAt: string`

    - `createdByUserId: string | null`

    - `organizationId: string`

    - `status: "pending" | "running" | "completed" | 2 more`

      - `"pending"`

      - `"running"`

      - `"completed"`

      - `"error"`

      - `"aborted"`

    - `title: string`

    - `totals: Totals`

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

      - `credits: number`

      - `durationMs: number`

      - `turnCount: number`

    - `triggeredBy: "api" | "email" | "schedule" | "ui"`

      - `"api"`

      - `"email"`

      - `"schedule"`

      - `"ui"`

    - `url: string`

      Web URL of the task in the Handinger dashboard.

    - `workerId: string`