Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
simulationJobId
string<uuid>
required

The simulation this session belongs to, from the agent-config resolve response (simulationJobId). Roark re-validates it against the live simulation before answering.

toolName
string
required

The tool the agent invoked.

Required string length: 1 - 200
Example:

"book_appointment"

sessionId
string

Your session or room identifier, echoed back in logs for correlation.

Maximum string length: 256
toolDescription
string

The tool's contract: its description and, ideally, its parameter and return shape. The more contract you pass, the more faithful the simulated response.

Maximum string length: 4000
Example:

"Books an appointment. Args: date (YYYY-MM-DD), time (HH:MM). Returns {confirmationId, status}."

arguments
object

The arguments the agent called the tool with, verbatim.

Example:

Response

The simulated tool response. Return result from your tool.

data
object
required

A simulated backend response for a guarded tool during a Roark test call. The real tool was not, and must not be, executed.