Skip to content
Handinger
Get started
API Reference
Tasks

Create a task

client.tasks.create(TaskCreateParams { input, budget, taskId, workerId } body, RequestOptionsoptions?): Worker { id, created_at, error, 13 more }
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.

ParametersExpand Collapse
body: TaskCreateParams { input, budget, taskId, workerId }
input: string
minLength1
budget?: "low" | "standard" | "high" | "unlimited"

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

One of the following:
"low"
"standard"
"high"
"unlimited"
taskId?: string

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

minLength1
workerId?: string

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

minLength1
ReturnsExpand Collapse
Worker { id, created_at, error, 13 more }
id: string
created_at: number | null
error: unknown
files: Array<File>
filename: string | null
mediaType: string
url: string
formaturi
size?: number
minimum0
incomplete_details: unknown
messages: Array<unknown>
metadata: Record<string, unknown>
object: "worker"
output: Array<Output>
id: string
content: Array<Content>
text: string
type: "output_text"
role: "assistant"
status: "completed"
type: "message"
output_text: string
running: boolean
sources: Array<Source>
id: string
title: string | null
type: "url"
url: string
status: "running" | "completed" | "pending"
One of the following:
"running"
"completed"
"pending"
structured_output: Record<string, unknown> | null
url: string

Web URL of the worker in the Handinger dashboard.

usage?: Usage { durationMs }
durationMs?: number
minimum0

Create a task

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);
{
  "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
  }
}
Returns Examples
{
  "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
  }
}