Skip to main content
PUT
/
knowledge-bases
/
:id
Update Knowledge Base
curl --request PUT \
  --url https://api.example.com/knowledge-bases/:id

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

PUT https://gateway.orkeia.ai/knowledge-bases/{id} Authentication
Requires header authorization: <your_token>.

​
Path Parameters

NameTypeRequiredDescriptionExample
idstringYesIdentifier of the knowledge base.KB_123456

​
Request Body (JSON)

{
  "knowledgeBase": {
    "name": "New name",
    "description": "New description",
    "enabled": true,
    "sectors": ["hr"],
    "content": "https://storage.orkeia.ai/kb/new-policies.pdf",
    "type": "file",
    "multimodal": false,
    "tags": ["updated"]
  },
  "filename": "new-policies.pdf"
}
Notes
  • The wrapper is the same as used in creation, containing knowledgeBase and filename.
  • For type: "file", send the corresponding filename for the new file (if any).

​
Example (cURL)

curl -X PUT "https://gateway.orkeia.ai/knowledge-bases/KB_123456" \
  -H "authorization:  <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "knowledgeBase": {
      "name": "New name",
      "description": "New description",
      "enabled": true,
      "sectors": ["hr"],
      "content": "https://storage.orkeia.ai/kb/new-policies.pdf",
      "type": "file",
      "multimodal": false,
      "tags": ["updated"]
    },
    "filename": "new-policies.pdf"
  }'

​
Responses

​
Response - Success

response
{
  "status": "OK",
  "data": {
    "id": "KB_123456",
    "name": "New name",
    "description": "New description",
    "enabled": true,
    "sectors": ["hr"],
    "content": "https://storage.orkeia.ai/kb/new-policies.pdf",
    "type": "file",
    "multimodal": false,
    "tags": ["updated"]
  }
}

​
500 — Server Error

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

​
400 — Client Error

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