Send a message to a conversation.

post https://app.customgpt.ai/api/v1/projects/{projectId}/conversations/{sessionId}/messages

Send a message to a conversation within an agent (formerly known as project) identified by its unique projectId and sessionId. This endpoint enables you to send a new message to a specific conversation, facilitating seamless communication and collaboration within the agent. By providing the projectId and sessionId, you can target the desired conversation and contribute to the ongoing discussion. This API endpoint supports real-time streaming, allowing for instant message delivery and dynamic updates which enables efficient and interactive communication between the user and agent.
Here is an example to send a message to a conversation: API SDK.

Path Params

projectId

integer

required

The ID of the agent to get the messages for

sessionId

string

required

The session ID of the converstaions to get the messages for

Query Params

stream

boolean

Defaults to false

Whether to stream the response or not, if stream the responses will be sent as data-only server-sent events as they become available, with the stream terminated by a status: "finish" message. Example Python code.

lang

string

Defaults to en

The language to use for the prompt

external_id

string

length ≤ 128

The external ID of the prompt history.

Body Params

Send a message to a conversation.

prompt

string

Prompt to send to OpenAI

custom_persona

string | null

Custom persona to use for the conversation

chatbot_model

string | null

Agent model to use for the conversation

response_source

string | null

Defaults to default

By default, we ask ChatGPT to use only your content in its response (recommended). If you wish ChatGPT to improvise and use its own knowledgebase as well, you can set this to "openai_content".

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://app.customgpt.ai/api/v1/projects/projectId/conversations/sessionId/messages?stream=false&lang=en' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "response_source": "default"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Send a message to a conversation

400Bad Argument

401API Token is either missing or invalid

404Agent not found

429Resource Exhausted when sending a message to a conversation

500Internal Server Error