Operations
Operations

Get agent template

Read one agent template in full before using it: what starts its calls, its greeting and instructions (the instructions only for a workspace on a paid plan; otherwise systemPrompt is null), the {{variables}} the business fills in (each marked as covered by a Shared setting or still needed), its tools (built-in, or HTTP ones that need a connection), and its workflow (pre-call, hang-up and post-call functions, with each function's condition and whether it is on, plus the post-call analysis fields). Never includes variables, endpoints, headers or mocks. Only listed templates (add_agent_template) can be read.

POST
/operations/get_agent_template

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

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 POST "https://example.com/operations/get_agent_template" \  -H "Content-Type: application/json" \  -d '{    "template": "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
}

Agent health POST

Health check for the agent, answers 'is it live, is it ready, could it improve' in one call. Returns: status (live / published-inactive / draft / archived) and whether an unpublished draft is ahead of the published version; readiness (ready / could-improve / needs-work) with the validator's blocking errors and non-blocking risks (each with section, message, fix link, and, for risks, the riskKey you can pass to acknowledge_risk); reachable (a caller can reach it, a phone number routes here or a channel is enabled) and proven (at least one test's verdict is a pass), surfaced together as qualifiers on a 'ready' label (e.g. 'ready (untested)') since a clean agent that no one can reach or that has never passed a test is not truly ready; a tests summary by each test's latest counted verdict (passed / failed / not-run / inconclusive), where an operator override wins, a passed run whose critical metric failed is a failure, a latest run an operator flagged for review is inconclusive (an older pass does not stand in for it), and an errored, cancelled, unfinished or still-scoring run is inconclusive rather than failed; and recent call activity. Use this first when asked how an agent is doing or whether it's ready to publish.

Read alert fire POST

Read one alert fire's detail. Pass a fireId to get that fire's header (rule name, reason, value, baseline, window, delivery status, the triggering call's sessionId) PLUS the rule's keyset-paginated 7-day fire history, the same payload the alert-fire detail page shows. Or pass an alertId (a RULE id from list_alerts) to read that rule's recent 7-day firing history directly. Use it to investigate a fire before deciding whether to retune the rule (update_alert) or summarise the pattern (summarise_alert_fire). Read-only and workspace-scoped, it never re-scores a call or changes a rule.