Skip to main content
POST
/
orgs
/
{org_id}
/
assistants
Create Assistant
curl --request POST \
  --url https://api.useinvent.com/orgs/{org_id}/assistants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enabled": true,
  "avatar_id": "<string>",
  "generate_secret_key": true,
  "config": {
    "instructions": "<string>",
    "model": "<string>",
    "timezone": "<string>"
  },
  "contact_fields": [
    {
      "field_id": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "enabled": true,
  "deleted": true,
  "secret_key": "<string>",
  "avatar_url": "<string>",
  "config": {
    "model": "<string>",
    "stt": {
      "model": "<string>"
    },
    "tts": {
      "model": "<string>",
      "voice_id": "<string>"
    },
    "conversation": {
      "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_ai_replies": true,
      "enable_auto_resolve": true,
      "enable_auto_follow_ups": true,
      "enable_auto_csat": true,
      "enable_private_chats": true,
      "enable_update_contact_tool": true
    },
    "timezone": "<string>",
    "instructions": "<string>"
  },
  "integrations": [
    {
      "id": "<string>",
      "enabled": true,
      "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"
    }
  ],
  "contact_fields": [
    {
      "field": {
        "id": "<string>",
        "table_id": "<string>",
        "key": "<string>",
        "schema": {
          "name": "<string>",
          "description": "<string>",
          "optional": true,
          "array": true,
          "placeholder": "<string>",
          "display": {},
          "order": 1,
          "link": "<string>",
          "metadata": {},
          "allowed_modes": [],
          "broadcast_hidden": true,
          "broadcast_field": true,
          "integration_field": true,
          "display_field": true,
          "conditions": [
            {
              "field": "<string>",
              "value": "<unknown>"
            }
          ],
          "hidden": true,
          "picker": {
            "views": [],
            "selectable_mime_types": [
              "<string>"
            ]
          },
          "disable_variables": true,
          "allowed_types": [
            "<string>"
          ],
          "visibility": "PRIVATE"
        },
        "readonly": true
      },
      "created_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

Body

The assistant information.

Schema for creating a new assistant

​
name
string
required

The name of the assistant

Required string length: 1 - 1024
​
enabled
boolean

Whether the assistant is enabled

​
avatar_id
string | null

The ID of the avatar file id

​
generate_secret_key
boolean

When true, generates a secret key immediately (same as POST …/rotate-secret-key). When omitted or false, no secret key is stored until you rotate.

​
config
object

Schema for creating or updating the configuration of an assistant

​
contact_fields
object[]
Maximum array length: 32

Response

200 - application/json

The created assistant.

Schema for an assistant

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