Get Agent

GET/v1/agents/{id}

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

id (path) *

tenantId (query)

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes
`tenantId`	query	`string`	No

Responses

200 Get agent by ID

Property	Type	Description
`agent`	`object`	AgentDefinition is the blueprint/config for an agent.

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X GET "http://localhost:8089/v1/agents/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/agents/{id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/agents/{id}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "agent": {
    "id": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "model": "string",
    "systemPrompt": "string",
    "tools": [
      "string"
    ],
    "maxTurns": 0,
    "maxToolCallsPerTurn": 0,
    "enabled": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "mode": "AGENT_MODE_UNSPECIFIED",
    "maxSteps": 0,
    "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
    "hidden": true,
    "color": "string",
    "workingDirectory": "string",
    "mentionAlias": "string",
    "executionPolicy": {
      "taskPermissionMode": "TASK_PERMISSION_MODE_UNSPECIFIED",
      "maxSteps": 0,
      "workingDirectory": "string"
    },
    "memoryConfig": {
      "enabled": true,
      "scope": "string",
      "autoRetrieve": true,
      "autoRetrieveTopK": 0,
      "autoExtract": true
    }
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}