v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Agents

Get agent workflow

Deprecated — prefer GET /agent/{id} (config is resolved into _resolvedConfig including prompt, tools, and post-call analytics).

Returns the active version's prompt and tools for single-prompt agents, or the workflow graph data for workflow_graph agents. Customers still rely on this to fetch their current prompt + tools — endpoint is kept live for now.

Caveat: the versionId query param (if passed) is silently ignored. The response always reflects the currently-active version. To inspect a non-active version, use GET /agent/{id}/versions/{versionId}.

get/agent/{id}/workflow

Path parameters

idstring required

The ID of the agent

Response

Successful response

statusboolean

Example response

{
  "status": true,
  "data": {
    "tools": [
      {
        "name": "end_call",
        "description": "End the conversation when the user is satisfied",
        "transferNumber": "+1234567890",
        "url": "https://api.example.com/orders",
        "method": "GET",
        "headers": {
          "Authorization": "Bearer TOKEN",
          "Content-Type": "application/json"
        },
        "headersArray": [
          {
            "key": "Authorization",
            "value": "Bearer TOKEN"
          }
        ],
        "queryParams": [
          {
            "key": "id",
            "value": "{{order_id}}"
          }
        ],
        "requestBody": "{\"customer_id\": \"{{customer_id}}\"}",
        "responseVariables": [
          {
            "variableName": "orderStatus",
            "jsonPath": "$.data.status"
          }
        ],
        "variablesExtractionSchema": [
          {
            "name": "customer_name",
            "description": "The customer's full name",
            "values": [
              "satisfied",
              "unsatisfied",
              "neutral"
            ]
          }
        ],
        "knowledgeBaseId": "60d0fe4f5311236168a109ca",
        "fillerPhrases": [
          "Let me check that for you",
          "One moment please"
        ]
      }
    ]
  }
}