Get agent by ID | Smallest AI Docs

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

{
  "status": true,
  "data": {
    "_id": "string",
    "name": "string",
    "description": "string",
    "backgroundSound": "",
    "organization": "string",
    "workflowId": "string",
    "workflowType": "workflow_graph",
    "createdBy": "string",
    "globalKnowledgeBaseId": "string",
    "language": {
      "enabled": "en",
      "switching": {
        "isEnabled": true,
        "minWordsForDetection": 1.1,
        "strongSignalThreshold": 1.1,
        "weakSignalThreshold": 1.1,
        "minConsecutiveForWeakThresholdSwitch": 1.1
      },
      "supported": [
        "string"
      ]
    },
    "synthesizer": {
      "voiceConfig": {
        "model": "waves_lightning_large",
        "voiceId": "nyah",
        "gender": "female"
      },
      "speed": 1.2,
      "consistency": 0.5,
      "similarity": 0,
      "enhancement": 1
    },
    "slmModel": "electron",
    "defaultVariables": {},
    "preCallAPI": {
      "url": "string",
      "method": "GET",
      "isEnabled": false,
      "headers": {},
      "body": {},
      "timeout": 5,
      "queryParams": {},
      "responseVariables": [
        {
          "variableName": "string",
          "jsonPath": "string"
        }
      ]
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "activeVersionId": "string",
    "versionId": "string",
    "_resolvedConfig": {
      "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"
          ]
        }
      ],
      "postCallAnalyticsConfig": {
        "dispositionMetrics": [
          {
            "identifier": "call_resolved",
            "dispositionMetricPrompt": "Was the customer issue resolved by the end of the call?",
            "dispositionMetricType": "STRING",
            "choices": [
              "resolved",
              "escalated",
              "callback_scheduled",
              "no_action"
            ]
          }
        ],
        "useInternalAnalyticsModel": true,
        "useReasoningModel": false,
        "successMetrics": [
          {
            "identifier": "string",
            "successMetricPrompt": "string",
            "successMetricType": "NUMERIC_SCALE"
          }
        ],
        "summaryPrompt": ""
      },
      "callDispositionConfig": "string"
    }
  }
}

Returns the agent document merged with the currently-active version’s resolved config under _resolvedConfig. Non-versioned fields (name, telephonyProductId, allowInboundCall, etc.) sit at the top level; versioned fields (prompt, tools, language, synthesizer, post-call analytics, …) are resolved from the active version and exposed under _resolvedConfig.

Notable resolved fields:

_resolvedConfig.postCallAnalyticsConfig — disposition metrics + analytics model flags
_resolvedConfig.tools — configured tools on the active version
_resolvedConfig.prompt — active version’s prompt
activeVersionId / versionId — current published & active version ID

To read prompt + tools alone, use GET /agent/{id}/workflow (deprecated for new integrations but still live). To inspect a specific non-active version, use GET /agent/{id}/versions/{versionId}.

Returns the agent document merged with the currently-active version's resolved config under `_resolvedConfig`. Non-versioned fields (name, telephonyProductId, allowInboundCall, etc.) sit at the top level; versioned fields (prompt, tools, language, synthesizer, post-call analytics, …) are resolved from the active version and exposed under `_resolvedConfig`. Notable resolved fields: - `_resolvedConfig.postCallAnalyticsConfig` — disposition metrics + analytics model flags - `_resolvedConfig.tools` — configured tools on the active version - `_resolvedConfig.prompt` — active version's prompt - `activeVersionId` / `versionId` — current published & active version ID To read prompt + tools alone, use `GET /agent/{id}/workflow` (deprecated for new integrations but still live). To inspect a specific 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

Response

Successful response

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

Notable resolved fields:

_resolvedConfig.postCallAnalyticsConfig — disposition metrics + analytics model flags
_resolvedConfig.tools — configured tools on the active version
_resolvedConfig.prompt — active version’s prompt
activeVersionId / versionId — current published & active version ID

To read prompt + tools alone, use GET /agent/{id}/workflow (deprecated for new integrations but still live). To inspect a specific non-active version, use GET /agent/{id}/versions/{versionId}.