Skip to main content
POST
Try a worker on one message

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

worker_id
string
required

The worker's id, from GET /v1/digital_workers

Body

application/json
message
string
required

What the customer wrote

Required string length: 1 - 10000
account_id
string | null

The account the asker is at, from GET /v1/objects/account/records. Without it the turn has no account to read

Required string length: 1 - 255
changes
Changes · object

Settings to try instead of the live ones, as PATCH /v1/digital_workers/{worker_id} takes them, without status. Nothing is saved

context
Context · object | null

Facts about the asker, as the in-app SDK token's context claim carries them, e.g. {"user_type": "Corporate non-administrator"}. A part a live token would drop is refused with a 422

sender_name
string | null

The asker's name

Maximum string length: 255
version_id
string | null

Try a saved version instead. The version's id, from GET /v1/digital_workers/{worker_id}/versions

Maximum string length: 64

Response

200 - application/json

Successful Response

held
boolean
required

Whether it would wait for a person before it goes out

held_reason
string | null
required

Why it would wait, when it would

loop_in
PreviewLoopIn · object | null
required

The part of the message only a person can do, handed to the account's team beside the reply (which still answers the rest); null when nothing is left for a person. A reply that says a colleague will follow up has someone behind it only when this is set or the reply is held

reply
string
required

The message the worker would send

untested
string[]
required

The parts of changes one turn never reads (channels, autonomy, accounts, assignment): they take effect only once the change is live