Listar y buscar agentes activos de la company.
GET /v1/agents
List the active agents in your project. Filterable by name and paginated.
GET
Listar y buscar agentes activos de la company.
Returns the active agents in your project. This is the index: start here to find the
id every other endpoint in this tab needs, and the one POST /v1/knowledge/assignments takes as agent_id.
The listing carries basic metadata only. To see how an agent is actually configured — its goal, its sections and their text — follow it with GET /v1/agents/{id}.
Endpoint
Required scope
agents:read
Headers
Query parameters
Example request
Response
200 OK
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theagents:read scope.
502 Bad Gateway
The agent service is unreachable.Operational notes
- This endpoint uses a different envelope from the rest of the API. It returns
itemswith a 1-basedpageand anidfield, where everything else paginated returnsdatawithoffsetand_id. It predates that convention and is deliberately left alone so existing integrations keep working — the other endpoints in this tab use the current shape. - Only active agents appear. There is no parameter to include inactive ones. Fetch a known id with
GET /v1/agents/:id, which returns it either way and includesis_active. - Scoped to the token’s project, not the whole company. A token issued against another project sees another list. Tools do not: they belong to the company.
voice_response_enabledis a flag, not the configuration. The underlying provider settings, including voice ids, are not exposed.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Query Parameters
Filtro por nombre (búsqueda parcial, case-insensitive).
Required range:
x >= 1Required range:
1 <= x <= 100