Get agent workflow | Smallest AI Docs

from smallest_ai import SmallestAI
client = SmallestAI(
    token="YOUR_TOKEN_HERE",
)
client.atoms.agents.get_agent_workflow(
    id="id",
)

{
  "status": true,
  "data": {
    "prompt": "string",
    "tools": [
      {
        "type": "end_call",
        "name": "end_call",
        "description": "End the conversation when the user is satisfied",
        "enabled": true,
        "transferNumber": "+1234567890",
        "transferOption": {
          "type": "cold_transfer",
          "privateHandoffOption": {
            "type": "prompt",
            "prompt": "string"
          },
          "publicHandoffOption": {
            "type": "prompt",
            "prompt": "string"
          }
        },
        "onHoldMusic": "ringtone",
        "transferOnlyIfHuman": true,
        "detectionTimeout": 30,
        "url": "https://api.example.com/orders",
        "method": "GET",
        "timeout": 5000,
        "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}}\"}",
        "llmParameters": [
          {
            "name": "string",
            "description": "string",
            "type": "text",
            "values": [
              "string"
            ],
            "required": false
          }
        ],
        "responseVariables": [
          {
            "variableName": "orderStatus",
            "jsonPath": "$.data.status"
          }
        ],
        "variablesExtractionSchema": [
          {
            "name": "customer_name",
            "description": "The customer's full name",
            "type": "text",
            "values": [
              "satisfied",
              "unsatisfied",
              "neutral"
            ]
          }
        ],
        "knowledgeBaseId": "60d0fe4f5311236168a109ca",
        "fillerPhrases": [
          "Let me check that for you",
          "One moment please"
        ]
      }
    ],
    "type": "workflow_graph",
    "data": {
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "position": {
            "x": 1.1,
            "y": 1.1
          },
          "data": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "type": "string"
        }
      ]
    }
  }
}

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}.

**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}`.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

The ID of the agent

Response

Successful response

statusboolean

dataobject

The active version's workflow.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error