Skip to main content
POST
/
assistants
Create Assistant
curl --request POST \
  --url https://api.dev.opencorpus.ai/assistants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "<string>",
  "system_instruction": "<string>",
  "description": "<string>",
  "first_message": "Hello! I'm here to help you. How can I assist you today?",
  "voice": {
    "voice_id": "<string>",
    "tts_provider": "cartesia",
    "tts_model": "default",
    "language": "en"
  },
  "llm": {
    "llm_provider": "google",
    "model": "gemini-1.5-flash"
  },
  "transcriber": {
    "stt_provider": "deepgram",
    "stt_model": "nova-3",
    "language": "en"
  },
  "knowledge_base": {
    "pinecone_index": "<string>",
    "pinecone_namespace": "<string>"
  },
  "transport": {
    "sip_config": {}
  }
}
EOF
{
  "name": "<string>",
  "system_instruction": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "<string>",
  "description": "<string>",
  "first_message": "Hello! I'm here to help you. How can I assist you today?",
  "voice": {
    "voice_id": "<string>",
    "tts_provider": "cartesia",
    "tts_model": "default",
    "language": "en"
  },
  "llm": {
    "llm_provider": "google",
    "model": "gemini-1.5-flash"
  },
  "transcriber": {
    "stt_provider": "deepgram",
    "stt_model": "nova-3",
    "language": "en"
  },
  "knowledge_base": {
    "pinecone_index": "<string>",
    "pinecone_namespace": "<string>"
  },
  "transport": {
    "sip_config": {}
  },
  "attached_knowledge_bases": [
    {}
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating an assistant (excludes ID)

​
name
string
required
​
system_instruction
string
required
​
description
string | null
​
first_message
string | null
default:Hello! I'm here to help you. How can I assist you today?
​
voice
Voice · object
​
llm
Llm · object
​
transcriber
Transcriber · object
​
knowledge_base
KnowledgeBase · object
​
transport
Transport · object

Response

Successful Response

Response model for an assistant

​
name
string
required
​
system_instruction
string
required
​
id
string<uuid>
​
user_id
string | null
​
description
string | null
​
first_message
string | null
default:Hello! I'm here to help you. How can I assist you today?
​
voice
Voice · object
​
llm
Llm · object
​
transcriber
Transcriber · object
​
knowledge_base
KnowledgeBase · object
​
transport
Transport · object
​
attached_knowledge_bases
Attached Knowledge Bases · object[]
​
created_at
string | null
​
updated_at
string | null