Sign in

v1

latestOpenAPI 3.0.22026-07-174617345.8 KB
Conversations

Send a message to a conversation in openai format.

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.

post/api/v1/projects/{projectId}/chat/completions

Path parameters

projectIdinteger required

Request body

modelstring nullable

ID of the model to use

streamboolean

Whether to stream the response

langstring

Response language

external_idstring nullable

External identifier

is_inline_citationboolean

Whether to include inline citations

Response

OpenAI chat completion response

idstring
objectstring
createdinteger
modelstring nullable

Example response

{
  "id": "176",
  "object": "chat.completion",
  "created": 1743037634,
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Hello! How can I assist you today?"
      },
      "finish_reason": "stop"
    }
  ]
}