documents

Upload a knowledge document

Upload a source document for knowledge retrieval. Check indexing readiness before using it in an agent.

post/api/v1/documents

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/documents
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Request body

titlestring required
source_namestring required
media_type'text/plain' | 'text/markdown' | 'text/html' | 'application/pdf' required

Response

Upload a knowledge document

document_idstring uuid required
titlestring required
source_namestring required
media_type'text/plain' | 'text/markdown' | 'text/html' | 'application/pdf' required
byte_sizeinteger required
sha256string required
state'uploaded' | 'indexing' | 'ready' | 'failed' | 'deleting' required
created_atstring date-time required
expires_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.