Get a list of all agents

get/agents

Returns a list of the agents.

Request Samples

Response Samples

1{
2 "count": 1,
3 "items": [
4 {
5 "description": "An agent providing weather data.",
6 "id": "079b46b9-fbc4-44ce-8cb1-163330e4d812",
7 "name": "Weather Agent"
8 }
9 ],
10 "limit": 50,
11 "name": "agents",
12 "start": 0
13}

Query Parameters

NameTypeRequiredDescription
filter
string or null
false

The criteria for filtering. Supported attributes include id and name. Additional attributes might be added in future releases.

limit
integer
false

The maximum number of records to be returned. >= 1 or <= 100

Default:
50
start
integer
false

The zero-based offset of the first record to be returned. >= 0

Default:
0

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
401Unauthorized

The user was not authenticated.

Schema
422Unprocessable Entity

The server understands the request but was unable to process the contained instructions.

Schema