Skip to main content
GET
/
v1
/
assistants
Listar y buscar asistentes activos de la company.
curl --request GET \
  --url https://api.keebai.com/v1/assistants \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "model": "<string>",
      "voice_response_enabled": true,
      "description": "<string>",
      "avatar_url": "<string>",
      "created_at": "<string>"
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123
}
Returns the active assistants in your company. Mainly useful to discover the assistant_id values you’ll later use in POST /v1/knowledge/assignments. The listing only exposes basic metadata — to configure prompts, tools, or personality, keep using the portal.

​
Endpoint

GET https://api.keebai.com/v1/assistants

​
Required scope

assistants:read

​
Headers

HeaderRequiredValue
AuthorizationYesBearer kbai_pk_<token>

​
Query params

ParamTypeDefaultDescription
qstring—Filter by name. Partial, case-insensitive search.
pagenumber1Page, 1-based.
limitnumber25Items per page, max 100.

​
Example request

curl "https://api.keebai.com/v1/assistants?q=ventas&limit=10" \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

​
Response

​
200 OK

{
  "items": [
    {
      "id": "65f3a1b2c3d4e5f6a7b8c9aa",
      "name": "Ventas",
      "description": "Califica leads y agenda demos.",
      "avatar_url": "https://cdn.keebai.com/assistants/ventas.png",
      "model": "gpt-4o-mini",
      "voice_response_enabled": false,
      "created_at": "2026-03-12T10:15:00.000Z"
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 1
}
FieldTypeDescription
items[].idstringObjectId of the assistant. This is what you use as assistant_id in other endpoints.
items[].namestringName.
items[].descriptionstringShort description shown in the portal.
items[].avatar_urlstringPublic URL of the avatar, if uploaded.
items[].modelstringConfigured model (e.g. gpt-4o-mini).
items[].voice_response_enabledbooleanWhether voice responses are enabled.
page / limit / totalnumberStandard pagination.

​
401 / 403 / 429

  • 403 FORBIDDEN with code: INSUFFICIENT_SCOPE: the PAT doesn’t have assistants:read.

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