Get List Of Assistants

Retrieve assistants.

GET /api/v1/assistant

Get List Of Assistants

cURL

curl --request GET \
  --url 'https://api.example.com/api/v1/assistant?api_key='

200

{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "attributes": {},
        "system_prompt": "",
        "voice": false,
        "custom_voice": false,
        "voice_languages": [
          "en-US",
          "de-DE",
          "mr-IN",
          "hi-IN"
        ],
        "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "show_images": false,
        "hide_ds": false,
        "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "has_human_agent": false,
        "use_tools": false,
        "conversation_flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

Your API KeyHTTPBearer

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

page · integer · default: 1

Required range: x >= 1

size · integer · default: 50

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

data · PageBase[IAssistantRead] · object · required

Show child attributes

message · string | null · default: ""

meta · Meta · object