API ReferenceKnowledge base sync

Manual Knowledge Base synchronization

POST
/api/knowledge-bases/{id}/sync

Triggers manual synchronization of a Knowledge Base. Can regenerate embeddings for all documents or sync with external sources.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Bearer token for API authentication

In: header

Path Parameters

id*string

Unique ID of the Knowledge Base

Request Body

application/json

force?boolean

Force regeneration of all embeddings

Defaultfalse
regenerateEmbeddings?boolean

Regenerate existing embeddings

Defaultfalse
syncExternalSources?boolean

Sync with configured external sources

Defaulttrue

Response Body

application/json

curl -X POST "https://app.docutray.com/api/knowledge-bases/string/sync" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "syncId": "string",
    "status": "completed",
    "documentsProcessed": 0,
    "embeddingsGenerated": 0,
    "errors": [
      "string"
    ],
    "startedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty
Empty
Empty
Empty
Empty