v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB

Agents

List Agents

Returns a list of all Agents.

get/agents/me

Query parameters

sort_by'created_at' | 'modified_at' | 'chats' | 'score' | 'created_by'

Available fields to be sorted by

order'ascending' | 'descending'

Order of return results. Ascending, from A to Z. Descending, from Z to A

limitnumber double

Pagination - the amount of agents to return

tokenstring

Pagination - the pagination token from the previous response, default = 100

Response

tokenstring

Example response

{
  "agents": [
    {
      "presenter": {
        "voice": {
          "voice_id": "en-US-JennyNeural",
          "voice_config": {
            "rate": "0.5",
            "pitch": "+2st"
          },
          "language": "English (United States)"
        }
      },
      "llm": {
        "prompt_customization": {
          "role": "Salesperson",
          "topics_to_avoid": [
            "Politics",
            "Religion"
          ],
          "max_response_length": 75
        }
      },
      "triggers": {
        "chat/end": {
          "webhooks": [
            {
              "url": "https://example.com"
            }
          ]
        }
      },
      "pronunciation_dictionary": {
        "id": "dict_V1StGXR8_Z5jdHi6B-myT"
      }
    }
  ]
}