Skip to main content
GET
/
orgs
/
{org_id}
/
assistants
Get Assistants
curl --request GET \
  --url https://api.example.com/orgs/{org_id}/assistants
[
  {
    "id": "<string>",
    "name": "<string>",
    "enabled": true,
    "secret_key": "<string>",
    "avatar_url": "<string>",
    "config": {
      "language": "auto",
      "model": "<string>",
      "stt": {
        "model": "<string>"
      },
      "tts": {
        "model": "<string>",
        "voice_id": "<string>"
      },
      "conversation": {
        "thread_mode": "new",
        "enable_memories": true,
        "enable_transfer_to_human_tool": true,
        "welcome_banner": "<string>",
        "suggested_messages": [
          "<string>"
        ],
        "auto_intro_message": "<string>",
        "enable_end_conversation_tool": true,
        "enable_block_contact_tool": true,
        "enable_private_chats": true
      },
      "knowledge_scope": "all",
      "instructions": "<string>"
    },
    "integrations": [
      {
        "id": "<string>",
        "enabled": true,
        "integration_id": "internal",
        "assistant_id": "<string>",
        "connection_id": "<string>",
        "config": {},
        "error": "<string>",
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25"
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "enabled": true,
        "name": "<string>",
        "instructions": "<string>",
        "action_id": "<string>",
        "assistant_id": "<string>",
        "connection_id": "<string>",
        "config": {
          "input": {},
          "definitions": [
            {
              "path": "<string>",
              "definition": {}
            }
          ]
        },
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25"
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  }
]

Path Parameters

​
org_id
string
required

The ID of the org

Query Parameters

​
page
number

Page number

​
take
number

Number of items to take

​
next
string

Next page token (Only used on special endpoints)

Response

200 - application/json

An array of assistants.

​
id
string
required
​
name
string
required

The name of the assistant

​
enabled
boolean
required

Whether the assistant is enabled

​
secret_key
string | null
required

The secret key to create session hashes

​
avatar_url
string | null
required

The URL of the avatar photo

​
config
object
required

Schema for the configuration of an assistant

​
integrations
object[]
required
​
actions
object[]
required
​
created_at
string<date> | null
required
​
updated_at
string<date> | null
required