ROroarkhq
Simulation

Set a tool fixture

Changed on

Create-or-replace by scope: one fixture per tool project-wide, plus one per (tool, flow variant). Setting the same scope twice replaces the response, so CI can apply fixtures idempotently. During Roark test calls the tool guard answers with the fixture verbatim instead of generating a response; real callers are never affected.

post/v1/simulation/tool-fixture

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/tool-fixture
  • Auth
    HTTP bearer

Request body

toolNamestring required

The tool this fixture answers for.

responseunknown
customerFlowVariantIdstring uuid

Pin the fixture to one flow variant (scenario). Omit for a project-wide fixture. A variant-pinned fixture beats the project-wide one.

descriptionstring

Why this fixture exists.

enabledboolean

Defaults to true.

Example request

{
  "toolName": "lookup_availability",
  "response": {
    "slots": []
  },
  "description": "Forces the no-availability branch"
}

Response

The fixture as stored.

Example response

{
  "data": {
    "toolName": "lookup_availability"
  }
}

Changes