List Agents

GET/v1/agents

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)

tenantId (query)

enabled (query)

limit (query)

offset (query)

includeHidden (query)

mode (query)

Parameters

Name	In	Type	Required
`tenantId`	query	`string`	No
`enabled`	query	`boolean`	No
`limit`	query	`integer`	No
`offset`	query	`integer`	No
`includeHidden`	query	`boolean`	No
`mode`	query	`"AGENT_MODE_UNSPECIFIED" \| "AGENT_MODE_PRIMARY" \| "AGENT_MODE_SUBAGENT"`	No

Responses

200 List all agents for tenant

Property	Type	Description
`agents`	`object[]`
`total`	`integer`

default An unexpected error response.

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

Request

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

const response = await fetch("http://localhost:8089/v1/agents", {
  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",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "agents": [
    {
      "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
      }
    }
  ],
  "total": 0
}

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