Send message (OpenAI format).

Sends a message using the OpenAI-compatible request and response format. Use this if you are migrating from OpenAI or want to use existing OpenAI client libraries. Supports streaming for real-time responses.

Notes: This is a convenience endpoint for OpenAI compatibility. For full CustomGPT features, use the native message endpoint.

Path Params
integer
required

The unique identifier of the agent to send the message to.

Body Params

Send a message in OpenAI chat completion format.

messages
array of objects

The messages to send to OpenAI

messages
string | null

ID of the model to use

boolean
Defaults to false

Whether to stream the response

string
Defaults to en

Response language

string | null

External identifier

boolean
Defaults to false

Whether to include inline citations

labels
array of strings | null

Optional source-label filter. List of label IDs (as strings) or names (project-scoped). Invalid values are ignored. Only the first 500 labels are processed.

labels
boolean
Defaults to false

If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/event-stream