Tests
Tests

List test scenarios

List the agent's test-harness scenarios (the simulated callers the eval engine plays) with each one's id, name, scenarioType (conditional / instruction / scripted), folder, tags, and latest-run status. Call this FIRST to resolve a scenario id before update_scenario, and before create_scenario so you don't duplicate one that already exists. Optionally filter by folder. This reads the test harness, it does not change the agent.

GET
/workspaces/{workspace}/agents/{agent}/tests

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.

Query Parameters

folder?string

Optional exact folder match (the library rail). Omit to list every folder.

limit?integer

Items per page, 1 to 200. Default 50.

Range1 <= value <= 200
cursor?string

The next_cursor of the previous page.

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 GET "https://example.com/workspaces/string/agents/string/tests"
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "property1": null,
      "property2": null
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
{
  "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
}

Get a test scenario GET

Read one scenario's full payload, name, type, folder, tags, the per-type caller script (conditions / instructions / callerUtterances), the expected-outcome judge prompt, attached metricIds, persona, the linked test profile with its variables, caller tool toggles, language, connectionMode, toolMode, agentSpeaksFirst, callerModel, its assertions, workflowChecks, callSetup and line-condition environment, and its latest run status. Use this before update_scenario so you patch from the current state rather than guessing, list_scenarios only returns summaries.

Update a test scenario PATCH

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.