Skip to content
Handinger
Get started
API Reference
Workers

Create a worker template

$ handinger workers create
POST/api/workers

Create a new worker. The worker is a reusable agent template; tasks are runs against this template. Use POST /tasks to actually run the agent.

ParametersExpand Collapse
--instructions: optional string

Persistent system prompt the worker uses for every task it runs.

--output-schema: optional map[unknown]

Optional JSON Schema (Draft-07) describing the structured object the worker must produce. When set, every task response is validated against the schema and exposed as structuredOutput.

--prompt: optional string

Natural-language description of the worker to use for AI-generated instructions when instructions is omitted.

--summary: optional string

Short one-line description of the worker’s purpose. Auto-generated when omitted and a prompt is provided.

--title: optional string

Optional display name. When omitted, Handinger assigns a random dog-themed name.

--visibility: optional "public" or "private"

public (default) is visible to all org members. private is only visible to invited members.

ReturnsExpand Collapse
worker_template: object { id, createdAt, instructions, 8 more }
id: string
createdAt: string
instructions: string
organizationId: string
outputSchema: map[unknown]
summary: string
title: string
updatedAt: string
url: string

Web URL of the worker in the Handinger dashboard.

userId: string
visibility: "public" or "private"
"public"
"private"

Create a worker template

handinger workers create \
  --api-key 'My API Key'
{
  "id": "id",
  "createdAt": "createdAt",
  "instructions": "instructions",
  "organizationId": "organizationId",
  "outputSchema": {
    "foo": "bar"
  },
  "summary": "summary",
  "title": "title",
  "updatedAt": "updatedAt",
  "url": "https://v3.handinger.com/worker/wrk_vk81XUHKHG-qr4",
  "userId": "userId",
  "visibility": "public"
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "instructions": "instructions",
  "organizationId": "organizationId",
  "outputSchema": {
    "foo": "bar"
  },
  "summary": "summary",
  "title": "title",
  "updatedAt": "updatedAt",
  "url": "https://v3.handinger.com/worker/wrk_vk81XUHKHG-qr4",
  "userId": "userId",
  "visibility": "public"
}