GET
/
api
/
v1
/
agents
{
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "phoneNumberId": "<string>",
      "voicemailMessage": "<string>",
      "useKnowledgeBase": true,
      "enableBackgroundAudio": false,
      "backgroundAudio": 50,
      "versions": [
        {
          "id": "<string>",
          "version": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "mode": "FLOW",
          "flows": {
            "blocks": [
              {
                "blockId": "<string>",
                "blockType": "prompt",
                "systemPrompt": "<string>",
                "loop": false,
                "tools": [],
                "nextBlocks": [],
                "metadata": {},
                "inputCaptureType": "phone",
                "transferNumber": "<string>"
              }
            ],
            "startBlockId": "<string>",
            "systemPrompt": "<string>"
          },
          "prompt": {
            "system": "<string>"
          },
          "sttConfigId": "<string>",
          "ttsConfigId": "<string>",
          "llmConfigId": "<string>",
          "overrideSTTConfig": {},
          "overrideTTSConfig": {},
          "overrideLLMConfig": {},
          "voiceId": "<string>",
          "channels": [
            "INBOUND_CALL"
          ]
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string
​
limit
string

Response

200
application/json

List of agents retrieved successfully

The response is of type object.