HTTP API
AgentRunRequest
Request for a trial run made from the UI.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
message |
no | string |
User message. May be left empty only if IReadOnlyList<ToolApprovalDecision> AgentRunRequest.Approvals is sent. | — |
sessionId |
no | string |
Session identifier. If not given, the run is sessionless and no history is carried. | — |
lane |
no | string |
The lane a queued run (Prefer: respond-async) is queued under. See JobLanes. Ignored for a synchronous run — nothing is queued. Left empty, the run uses JobLanes.Default (or whatever TraconSchedulingOptions.LaneByHandlerKey maps JobHandlerKeys.AgentRun to). |
— |
culture |
no | string |
The culture to resolve the agent’s instructions with (see AgentDefinition.InstructionsByCulture). null uses the agent’s default instructions. |
— |
approvals |
no | array of ToolApprovalDecision |
Approval decisions for pending tool calls. | — |
toolResults |
no | array of ClientToolResult |
Results of client-side tool calls. | — |
inputResponses |
no | array of ToolInputResponse |
Answers to requests for user input that a tool raised in the previous turn (MCP elicitation). | — |
attachmentIds |
no | array of string (uuid) |
Identifiers of attachments previously uploaded via POST /api/attachments. |
— |
parameters |
no | object |
Values for the target agent’s IReadOnlyList<AgentParameter> AgentDefinition.Parameters schema. | — |
documents |
no | array of AgentRunDocument |
Reference text attached to this run, kept apart from the agent’s instructions. | — |