Tests
Tests

Update a test scenario

Patch an existing test-harness scenario. Every field is optional, only the fields you send change. Resolve the scenarioId with list_scenarios first. Use this to rewrite the caller agent's instructions brief, tighten the expected-outcome judge prompt, rename it, move it between folders, retag it, switch connectionMode (bridge / phone), switch toolMode (mock / real, where real lets a run call the customer's live API), set or clear callerModel (the caller agent's LLM override), or change its attachments: metricIds (which catalogue metrics grade it), personaId (the simulated caller's persona, voice scenarios), testProfileId (caller-identity fixture data), language, workflowChecks (checks on the agent's pre-call, hang-up and post-call functions) and callSetup (how the call starts: inbound, lead callback or campaign call). workflowChecks and callSetup replace the stored value whole, so read the scenario with get_scenario first. This edits the TEST HARNESS only, it never changes the agent's own behaviour.

PATCH
/workspaces/{workspace}/agents/{agent}/tests/{test}

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Path Parameters

workspace*string

Workspace slug (GET /me lists yours).

agent*string

Agent slug within the workspace.

test*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/workspaces/string/agents/string/tests/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "scenarioId": "string",
  "property1": null,
  "property2": null
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}