Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

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

Headers

X-Project-ID
string
required

Project ID

Body

application/json

Request to register an agent definition

id
string
required

Agent ID

model
string
required

Model name (e.g., "gpt-4", "claude-3")

provider
string
required

LLM provider (e.g., "openai", "anthropic")

config
any

Additional configuration

deployment_id
string | null

Deployment ID (optional, uses latest if not provided)

max_output_tokens
integer<int32> | null

Maximum output tokens

metadata
any

Agent metadata

system_prompt
string | null

System prompt for the agent

temperature
number<double> | null

Temperature for LLM generation

tools
any

Tools available to the agent

Response

Agent registered successfully

Response for agent registration

success
boolean
required

Whether registration was successful