Saltar al contenido principal
GET
/
api
/
v1
/
agents
/
{agent_id}
Python (SDK)
from openapi import SDK, models


with SDK() as sdk:

    res = sdk.agents.get_agent(security=models.GetAgentSecurity(
        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
    ), agent_id="<id>")

    # Handle response
    print(res)
{
  "object": "agent",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "model": "functionary-pt",
  "instructions": "<string>",
  "tools": [
    {
      "type": "web_search",
      "search_context_size": "low",
      "user_location": {
        "type": "approximate",
        "city": "<string>",
        "country": "<string>",
        "region": "<string>",
        "timezone": "<string>"
      },
      "filters": {
        "allowed_domains": [
          "<string>"
        ]
      }
    }
  ],
  "tool_choice": "<string>",
  "parallel_tool_calls": true,
  "max_tool_calls": 123,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "reasoning": {
    "effort": "low"
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parámetros de ruta

agent_id
string
requerido

Respuesta

Agente encontrado.

object
enum<string>
requerido
Opciones disponibles:
agent
id
string
requerido
name
string
requerido
description
string | null
requerido
model
string
requerido
Ejemplo:

"functionary-pt"

instructions
string | null
requerido
tools
object[]
requerido
tool_choice
requerido
parallel_tool_calls
boolean
requerido
max_tool_calls
integer | null
requerido
text
object
requerido
reasoning
object
requerido
metadata
object
requerido
created_at
string<date-time>
requerido
updated_at
string<date-time>
requerido
deleted_at
string<date-time> | null
requerido