Skip to main content
POST
Run agent

Authorizations

x-teamai-api-key
string
header
required

Secret API key created in Workspace Settings → API Keys (workspace keys) or Organization Admin → API Keys (organization keys).

Path Parameters

agentId
string
required

Agent to run.

Body

application/json
message
string
required

User message text.

Minimum string length: 1
chatId
string

Existing chat to continue.

projectId
string

Project context to include.

variables
object
systemVariables
object
temperature
number
Required range: 0 <= x <= 2
model
string

Response

Completed agent run.

data
object