Skip to content
Get started

Update a worker template

workers.update(strworker_id, WorkerUpdateParams**kwargs) -> WorkerTemplate
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: str
instructions: Optional[str]

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

maxLength20000
output_schema: Optional[Dict[str, object]]

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

summary: Optional[str]

Replaces the worker’s short one-line summary.

maxLength80
title: Optional[str]

New display name for the worker.

minLength1
maxLength200
visibility: Optional[Literal["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: str
created_at: Optional[str]
instructions: str
organization_id: str
output_schema: Optional[Dict[str, object]]
summary: str
title: str
updated_at: Optional[str]
url: str

Web URL of the worker in the Handinger dashboard.

user_id: str
visibility: Literal["public", "private"]
One of the following:
"public"
"private"

Update a worker template

import os
from handinger import Handinger

client = Handinger(
    api_key=os.environ.get("HANDINGER_API_KEY"),  # This is the default and can be omitted
)
worker_template = client.workers.update(
    worker_id="t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
    title="Claim verdict v2",
)
print(worker_template.id)
{
  "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"
}