documents

Get a knowledge document

Read a knowledge document’s metadata and state.

get/api/v1/documents/{document_id}

Request

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

Path parameters

document_idstring uuid required

Response

Get one 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.