Skip to main content
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 the agents: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 items with a 1-based page and an id field, where everything else paginated returns data with offset and _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 includes is_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_enabled is a flag, not the configuration. The underlying provider settings, including voice ids, are not exposed.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

q
string

Filtro por nombre (búsqueda parcial, case-insensitive).

page
number
default:1
Required range: x >= 1
limit
number
default:25
Required range: 1 <= x <= 100

Response

200 - application/json
items
object[]
required
page
number
required
limit
number
required
total
number
required