API Reference

Workers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a worker template

workers.update(worker_id, **kwargs) -> WorkerTemplate { id, created_at, instructions, 8 more }

PATCH/api/workers/{workerId}

Update a worker’s instructions, title, summary, visibility, or output schema. Only the fields you send are changed; omitted fields keep their current values. Only the worker creator can update a worker.

ParametersExpand Collapse

worker_id: String

instructions: String

Replaces the persistent system prompt. Subsequent tasks pick up the new instructions immediately; in-flight tasks keep using the previous version.

maxLength20000

output_schema: Hash[Symbol, untyped]

Replace the worker’s structured output schema. Pass null to clear it and return to free-form text responses.

summary: String

Replaces the worker’s short one-line summary.

maxLength80

title: String

New display name for the worker.

minLength1

maxLength200

visibility: :public | :private

Change visibility between public (any org member can run tasks) and private (only invited members).

One of the following:

:public

:private

ReturnsExpand Collapse

class WorkerTemplate { id, created_at, instructions, 8 more }

id: String

created_at: String

instructions: String

organization_id: String

output_schema: Hash[Symbol, untyped]

summary: String

title: String

updated_at: String

url: String

Web URL of the worker in the Handinger dashboard.

user_id: String

visibility: :public | :private

One of the following:

:public

:private

Update a worker template

Ruby

HTTP

TypeScript

Python

Go

Ruby

CLI Tool

require "handinger"

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

worker_template = handinger.workers.update("t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM")

puts(worker_template)

200 example

{
  "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

200 example

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