Skip to main content
GET
/
v2
/
orchestrate
/
agents
List Registered Agents.
curl --request GET \
  --url https://{api_endpoint}/api/v2/orchestrate/agents \
  --header 'Authorization: Bearer <token>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
include_hidden
boolean
default:false
​
show_bundled
boolean
default:false
​
ids
string<uuid>[] | null
​
names
string[] | null
​
query
string | null

Search by name and description

​
limit
integer | null

Limit the number of results returned

Required range: x >= 1
​
offset
integer | null

Skip the first N results

Required range: x >= 0
​
sort
enum<string> | null
default:asc

Sort by name and recently added (recent/asc/desc)

Available options:
asc,
desc,
recent

Response

Successful Response