Skip to main content
POST
/
agents
/
{id}
/
openai
/
chat
/
completions
curl --request POST \
  --url https://api.tess.im/agents/{id}/openai/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "temperature": 1,
  "model": "tess-6",
  "messages": [
    {
      "role": "user",
      "content": "Create a short release note."
    }
  ],
  "tools": "no-tools",
  "stream": false
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.tess.im/llms.txt

Use this file to discover all available pages before exploring further.

​
Code Examples

See the OpenAI SDK documentation for more info. At the moment, our API only support the temperature 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. 
curl --request POST \
  --url 'https://api.tess.im/agents/{id}/openai/chat/completions' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "temperature": "1",
    "model": "tess-5",
    "messages": [{ "role": "user", "content": "hello there!" }],
    "tools": "no-tools",
    "stream": true
  }'

​
Headers

ParameterTypeRequiredDescription
x-workspace-idintegerNoID of the workspace. If not provided, the user’s selected workspace will be used. Will be required in a future release.

​
Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe agent ID.

​
Request Body

See the OpenAI API documentation for the full parameter reference. At the moment, our API only supports the temperature 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

​
Authorization
string
header
required

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

Headers

​
x-workspace-id
integer

ID of the workspace. If not provided, the user's selected workspace will be used. This field will be required in a future release.

Path Parameters

​
id
integer
required

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.