Skip to main content
GET
List AI agents
Call this endpoint on the AI service: https://ai.pingmee.co.il with flat=true. Returns up to 25 agents per page (override with limit). Use lastEvaluatedKey as exclusiveStartKey for the next page. Pass getFiles=true only when you need vector store files for each agent.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Query Parameters

flat
enum<string>
required

Must be true to return a flat agent list (no folders).

Available options:
true
getFiles
enum<string>

When true, loads vector store files for each agent. Defaults to omitting file contents.

Available options:
true
limit
integer
default:25

Page size. Defaults to 25.

Required range: x >= 1
exclusiveStartKey
string

URI-encoded JSON pagination cursor from a previous response lastEvaluatedKey.

Response

Flat AI agents page

agents
object[]
required

Flat list of AI agents for this page

hasMoreItemsToFetch
boolean
required

Whether more agents are available

lastEvaluatedKey
object

Pagination cursor for the next page. Pass URI-encoded as exclusiveStartKey.