Sign in

Replaces a Layer 0 knowledge document and re-runs its pipeline

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

Path parameters

context_idstring required

Spectron context id

idstring required

Document id fragment

Response

Upload accepted

contentHashstring required
deduplicatedboolean required
idstring required
observedAtstring date-time nullable

The known/observed time stamped onto the document: the request's explicit observedAt or the value detected via observedAtHeader. Absent when neither applied, so facts will date to ingest time. On a dedup hit this is the matched document's known-time, which this upload fills only when that row has none and its first ingest has not published.

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.

Changes

Changed in 4 of the 5 revisions of this API.24

  • 9f15987130673See the full diff
    • ○

      added the new optional request property metadata/observedAtHeader

      new-optional-request-property

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property observedAt to the response with the 202 status

      response-optional-property-added

  • 52b41ab517b61See the full diff
    • ○

      added the new optional request property metadata/observedAt

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6ad06b1fefc41See the full diff
    • ▲

      added required request body

      request-body-added-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 741d58b9ef891See the full diff
    • ▲

      removed the request body

      request-body-removed

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog