POST
/
agents

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

Agent name. If not provided, a fun name will be generated automatically.

description
string

Agent description.

modelName
string

LLM model to be used by the agent. Check the API for available model names.

temperature
number

Model temperature (min 0.0, max 1.0). Controls randomness. Model default if not specified.

systemPrompt
string

System prompt to guide the agent's behavior.

visibility
enum<string>
default: private

Agent visibility. public allows access without authentication (depending on other settings), private restricts access to the organization.

Available options:
public,
private
handle
string

A unique identifier (slug) for the agent. Used for friendly URLs.

interfaceConfig
object

Chat interface settings for this agent (colors, initial messages, etc.).

tools
object[]

Lista de ferramentas a serem associadas ao agente.

Response

200 - application/json
id
string
name
string
description
string | null
modelName
string

LLM - Model name.

temperature
number

Temperature of the model (min 0.0, max 1.0)

visibility
enum<string>
Available options:
public,
private
systemPrompt
string | null

Agent system prompt