Document Lineage

Get document lineage

Changed on

Get the complete processing lineage for a document. Shows the full chain of transformations from the root bucket object through all collection processing stages.

get/v1/collections/{collection_id}/documents/{document_id}/lineage

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections/{collection_id}/documents/{document_id}/lineage
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

collection_idstring required

ID of the collection containing the document

document_idstring required

ID of the document to trace

Response

Document lineage information

document_idstring required

Document that was traced.

collection_idstring required

Collection it was traced in.

depthinteger

Processing steps between the root object and this document: 1 for a document made directly from a bucket object, 2 for one made from such a document, and so on. Equals total_steps unless an upstream document no longer exists, when it also counts the steps the chain cannot list. 0 only when the document has no lineage.

total_stepsinteger

Number of entries in lineage.lineage_chain. 0 only when the document has no lineage.

messagestring nullable

Present only when lineage is null, explaining the absence. Absent on a successful trace.

Example response

{
  "lineage": {
    "root_object_id": "obj_video123",
    "root_bucket_id": "bkt_marketing",
    "source_type": "collection",
    "source_row": {
      "pk": {
        "id": 42
      },
      "provider": "postgresql",
      "schema": "public",
      "table": "scenes",
      "vector_origin": {
        "embedding": {
          "dimensions": 3072,
          "mode": "carry",
          "model": "text-embedding-3-large"
        }
      }
    }
  },
  "message": "Document does not have lineage information (created before Phase 2)"
}

Changes

  • 56621f0ca533Revision changes
    • info

      added the optional property // to the response with the status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status