Agents

Get all agents

Changed on

Agents are the main entities in the system. Agents are used to create conversations. You can create workflow for an agent and configure it for different use cases. You can also create custom workflows for an agent. This API will give you the list of agents created by organization you are a part of.

get/agent

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number

offsetinteger

Number of items to return per page

searchstring

Search query

type'single_prompt' | 'workflow_graph'

Filter agents by workflow type

sortField'createdAt' | 'updatedAt' | 'totalCalls' | 'name' | 'workflowType'

Field to sort results by

sortOrder'asc' | 'desc'

Sort direction

archivedboolean

When true, returns only archived agents. Omit or set to false to return active agents.

Response

Successful response

statusboolean

Example response

{
  "status": true,
  "data": {
    "agents": [
      {
        "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"
              ]
            }
          ]
        },
        "_resolvedConfig": {
          "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"
                }
              ],
              "auth": {
                "token": "ORDER_API_TOKEN",
                "name": "X-API-Key",
                "value": "SEARCH_API_KEY"
              },
              "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"
              ]
            }
          ],
          "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"
                ]
              }
            ]
          }
        },
        "_versionedWorkflow": {
          "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"
                }
              ],
              "auth": {
                "token": "ORDER_API_TOKEN",
                "name": "X-API-Key",
                "value": "SEARCH_API_KEY"
              },
              "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"
              ]
            }
          ]
        }
      }
    ]
  }
}

Changes

  • 8546eaa96566Revision changes
    • warning

      added the new client_tool enum value to the ////// response property for the response status

    • warning

      added the new client_tool enum value to the ////// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 49ce8525306eRevision changes
    • warning

      added the new gpt-5.2-azure enum value to the /// response property for the response status

    • warning

      added the new multi_agents enum value to the /// response property for the response status