Skip to main content

Start an asynchronous export (original files and metadata JSON in one zip)

POST 

/v1/knowledge_bases/:kb_id/exports

Free of charge. Allowed while the knowledge base is frozen or suspended, during a payment suspension and while knowledge bases are switched off on the platform — export is how your data leaves. When ready, download_url is a signed link valid for 24 h, a knowledge.export.ready webhook is sent and the requester gets an email. Zip layout: documents/<document_id>/<original name> plus metadata.json (an array of Document objects without failure details).

Access: API key scope knowledge:write; portal users: organization admins and owners; the knowledge base in the path must be on the key's access list; refused with 503 maintenance_mode during maintenance.

Request​

Responses​

Export queued.