Skip to navigation

Upsert a Knowledge API document

Knowledge API sources only. Send complete JSON content with the source article ID in meta.description.id, id or externalId. Imported metadata article IDs match linked documents in this source; _id is used only if no source ID is supplied. Unknown IDs create documents. Returns a queue receipt; the worker processes and publishes according to source policy.

Authentication

AuthorizationBearer

Source-specific webhook token shown when configuring the knowledge source; activated only after deployment.

Path parameters

workspaceIdstringRequired
environmentstringRequired
sourceKeystringRequired

Headers

Idempotency-KeystringOptional<=200 characters

Request

This endpoint expects a map from strings to any.

Response

Event persisted; may already have been accepted

acceptedbooleanOptional
idstringOptional
duplicatebooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
503
Service Unavailable Error