Skip to main content
GET
/
orgs
/
{org_id}
/
assistants
Get Assistants
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/assistants \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "enabled": true,
    "deleted": 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_auto_resolve": true,
        "enable_auto_follow_ups": true,
        "enable_auto_csat": true,
        "enable_private_chats": true,
        "enable_update_contact_tool": true
      },
      "knowledge_scope": "all",
      "timezone": "<string>",
      "instructions": "<string>"
    },
    "integrations": [
      {
        "id": "<string>",
        "enabled": true,
        "integration_id": "internal",
        "assistant_id": "<string>",
        "connection_id": "<string>",
        "config": {},
        "error": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "enabled": true,
        "name": "<string>",
        "instructions": "<string>",
        "action_id": "<string>",
        "assistant_id": "<string>",
        "connection_id": "<string>",
        "config": {
          "input": {},
          "definitions": [
            {
              "path": "<string>",
              "definition": {}
            }
          ]
        },
        "position": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "boards": [
      {
        "id": "<string>",
        "board_id": "<string>",
        "board_name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "initial_segment": {
          "id": "<string>",
          "name": "<string>",
          "color": "red",
          "contacts_count": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

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

​
deleted
boolean
required

Whether the assistant has been soft-deleted

​
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
​
boards
object[]
required
​
created_at
string<date-time> | null
required
​
updated_at
string<date-time> | null
required