Skip to main content
GET
/
public-api
/
agents
Retrieve a paginated list of agents and their channels
curl --request GET \
  --url https://agents.nineteen58.co.za/public-api/agents \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "name": "<string>",
      "description": "<string>",
      "base_prompt": "<string>",
      "channels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "channel": "<string>"
        }
      ]
    }
  ],
  "totalCount": 123,
  "currentPage": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:10

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved agents

agents
object[]
totalCount
integer
currentPage
integer
pageSize
integer
totalPages
integer