GET /v1/agents/knowledge/collections

The account’s knowledge collections, with how many sources each holds.

Collections group knowledge sources by topic. An agent can be limited to some of them with its knowledge_collections; every account has General, where sources go when no collection is given.

Needs the agents.knowledge:read scope.

Request

cURL

curl "https://api.fireflo.au/v1/agents/knowledge/collections" \
  -H "Authorization: Bearer $OMNI_API_KEY"

Response

200 OK — data holds every collection, by name, with how many sources it holds. The list isn’t paged.

{
  "data": [
    {
      "id": 1,
      "name": "General",
      "description": "",
      "sources": 14
    },
    {
      "id": 3,
      "name": "Returns & warranty",
      "description": "Refunds, replacements and warranty claims",
      "sources": 9
    }
  ]
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
404	module_off	The account doesn’t have AI agents on: they aren’t in its plan, or are switched off for it.
403	scope_missing	The key doesn’t have the agents.knowledge:read scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.