Skip to main content
GET
/
knowledge-bases
List Knowledge Bases
curl --request GET \
  --url https://api.example.com/knowledge-bases

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://gateway.orkeia.ai/knowledge-bases Authentication
Requires header authorization: <your_token>.

​
Headers

authorization: <your_token>

​
Example (cURL)

curl -X GET "https://gateway.orkeia.ai/knowledge-bases" \
  -H "authorization:  <your_token>"

​
Responses

​
Response - Success

response
{
  "status": "OK",
  "data": [
    {
      "id": "KB_123456",
      "name": "Base A",
      "description": "Description of the base",
      "enabled": true,
      "sectors": ["hr"],
      "content": "https://storage.orkeia.ai/kb/base-a.pdf",
      "type": "file",
      "multimodal": false,
      "tags": ["tag1","tag2"]
    }
  ]
}

​
500 — Server Error

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}

​
Fields

NameTypeDescription
idstringUnique identifier of the knowledge base.
namestringName of the knowledge base.
descriptionstringBrief description of the content/usage.
enabledbooleanIndicates whether the base is active in the environment.
sectorsstring[]Sectors that can consume this base (access governance).
contentstringSource of the content: file path/URL, external link, or literal text (according to type).
type”file” | “url” | “text”Type of the content.
multimodalbooleanWhether the base contains modalities beyond text (images/audio/video).
tagsstring[]Metadata/labels for search and organization.