Skip to main content
POST
Run a registered tool synchronously

Authorizations

x-api-key
string
header
required

Body

application/json

A synchronous tool-run request: the tool_name, its keyword arguments, and an optional subject.

Mirrors the shape read_tool_call enforces at runtime.

subject names the addressed subject this run's async parks index under (the door deposits it as the run's StateContext); a run whose tool never parks ignores it.

tool_name
string
required

Registered tool name.

Minimum string length: 1
arguments
Arguments · object

Tool keyword arguments.

subject
StateSubject · object | null

The addressed subject an async park of this run indexes under.

Response

Success.

data
RunResultAnswer · object
required

A run that finished: its value, whatever shape it has.