Agents
Execute OpenAI Compatible
Execute a specific chat agent by ID using the OpenAI-compatible API.
POST
Code Examples
See the OpenAI SDK documentation for more info. At the moment, our API only support thetemperature and messages (roles system, user and assistant) model parameters. Additionally, the tools parameter is a string enum. To verify the model parameters of an specific agent, see the Get Agent endpoint.
Headers
integer
required
Workspace ID. Required as of 2026-09-01. Until then, if omitted, the user’s selected workspace is used (deprecated). After the cutoff, a missing header returns 422.
Path Parameters
Request Body
See the OpenAI API documentation for the full parameter reference. At the moment, our API only supports thetemperature and messages (roles system, user and assistant) model parameters. Additionally, the tools parameter is a string enum. To verify the model parameters of a specific agent, see the Get Agent endpoint.
Response
See the OpenAI API documentation for the response format.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Workspace ID. Required as of 2026-09-01. Until then, if omitted, the user's selected workspace is used (deprecated). After the cutoff, a missing header returns 422.
Path Parameters
The agent ID.
Body
application/json
Send a JSON object in OpenAI-compatible format. You can also include custom root-level fields when needed by your agent configuration.
Free-form JSON object in OpenAI-compatible format. Custom fields can also be sent at the root level.
Response
200
Chat completion response.