Skip to content

Get Agents

Request

List agents for the authenticated company.

A summary projection by default: prompt, configuration, systemPrompt, outputFormat and toolIds are null, meaning "not loaded" rather than empty. Pass full=true to load all five on every row — including the namesAndVersions lookup, which returns whole agents but resolves tool assignments only when asked. Version history is never part of a list; retrieve an agent by id for it.

Security
OAuth2(Required scopes: agents.read)
Query
namesAndVersionsstring or null(Namesandversions)

Comma separated list of names and versions, eg agent1:v1,agent2:v2. At most 50 entries.

limitinteger(Limit)

Maximum number of agents to return. Capped at 50; ignored when namesAndVersions is set.

Default:20
offsetinteger, >= 0(Offset)

Number of agents to skip. Ignored when namesAndVersions is set.

Default:0
editorstring or null, non-empty(Editor)

Return only agents whose editors contain this value. Cannot be combined with namesAndVersions.

fullboolean(Full)

Load the whole agent. In the paged list, prompt, configuration, systemPrompt, outputFormat and toolIds are null on every row by default, meaning 'not loaded' rather than empty. The namesAndVersions lookup always returns whole agents; there this flag only adds toolIds.

Default:false
curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/agents?namesAndVersions=string&limit=20&offset=0&editor=string&full=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
dataArray of objects(Data)required

The page of results.

limitinteger(Limit)required

The limit applied to this page. Equal to the limit query parameter unless it exceeded the maximum allowed value, in which case it is that maximum.

Example:20
offsetinteger(Offset)required

The offset applied to this page (echoes the offset query parameter).

Example:0
totalCountinteger(Totalcount)required

The total number of elements across all pages.

Example:137
Response
{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "totalCount": 137
}