Public APIKnowledge items
Update a knowledge item
Every update currently re-indexes the item, including changes limited
to name, group_id, or active. sync_status.state resets to
pending and follows the same lifecycle as a fresh create:
pending → syncing → synced (success) or failed (terminal).
Use a client-side polling timeout because a queueing failure can leave the item pending.
Authorization
bearerAuth AuthorizationBearer <token>
API key in the Authorization: Bearer <key> header.
Keys are created in the SMAO dashboard (Settings → API Keys).
In: header
Path Parameters
knowledge_item_id*string
Match
^[a-f0-9]{24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Properties
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/knowledge-items/65f8fa6f1a9d8e0012ab34cd" \ -H "Content-Type: application/json" \ -d '{ "name": "International Shipping Policy" }'{ "data": { "id": "string", "group_id": "string", "name": "string", "active": true, "text_length": 5000000, "sync_status": { "state": "pending", "synced_at": "2019-08-24T14:15:22Z", "total_chunks": 0, "estimated_duration_ms": 0, "error": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}