SUsurrealdb

GET /api/v1/{context_id}/documents/{id}

Changed on

Gets a Layer 0 knowledge document by id

Request

Path parameters

context_idstring required

Spectron context id

idstring required

Document id fragment

Response

Document

contentHashstring required
createdAtstring date-time required
errorstring nullable
idstring required
mimeTypestring required
observedAtstring date-time nullable

Known/observed time of the content (explicit or front-matter-detected at upload); facts extracted from the document carry it as their known-time.

processingCompletedAtstring date-time nullable
processingStartedAtstring date-time nullable
sizeBytesinteger required
sourcestring required
status'queued' | 'extracting' | 'chunking' | 'embedding' | 'keywording' | 'extracting_nodes' | 'ready' | 'failed' required

Lifecycle state of a [Document] in the ingestion pipeline.

Matches the SurrealQL ASSERT $value IN [...] on document.status in V1__schema.surql. The Keywording state is reserved for Phase C; in Phase A the pipeline transitions straight from Embedding to Ready.

titlestring required
updatedAtstring date-time required
versioninteger required

Changes

  • 9f1598713067Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 52b41ab517b6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status