Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Collection Documents

Get direct downstream documents (depth=1 children).

Return direct downstream documents (depth=1) — every document whose _internal.lineage.source_document_id equals this document's ID.

Capped at 100 children per request. Equivalent to GET /documents/{id}?expand=children but returns just the children.

Deeper traversal (descendants beyond depth=1) is not yet supported in a single call — walk recursively client-side or filter the namespace by from_object and post-process.

get/v1/collections/{collection_identifier}/documents/{document_id}/descendants

Path parameters

collection_identifierstring required

The ID or name of the collection.

The ID or name of the collection.

document_idstring required

The ID of the document.

The ID of the document.

Response

Successful Response

document_idstring required

REQUIRED. Unique identifier for the document. Format: 'doc_' prefix + alphanumeric characters. Use for: API queries, references, filtering.

collection_idstring required

REQUIRED. ID of the collection this document belongs to. Format: 'col_' prefix + alphanumeric characters. Use for: Collection-scoped queries, filtering.

Example response

[
  {
    "_internal": {
      "collection_id": "col_articles",
      "created_at": "2025-10-31T10:00:00Z",
      "document_id": "doc_f8966ff29c18e20c6b45e053",
      "internal_id": "org_abc123",
      "lineage": {
        "chain": [
          {
            "collection_id": "col_articles",
            "feature_extractor_id": "text_extractor_v1",
            "timestamp": "2025-10-31T10:00:00Z"
          }
        ],
        "path": "bkt_content/col_articles",
        "root_bucket_id": "bkt_content",
        "root_object_id": "obj_article_001",
        "source_object_id": "obj_article_001",
        "source_type": "bucket"
      },
      "metadata": {
        "ingestion_status": "COMPLETED"
      },
      "modality": "text",
      "namespace_id": "ns_xyz789",
      "source_blobs": [
        {
          "blob_id": "blob_text_001",
          "blob_property": "content",
          "blob_type": "text"
        }
      ],
      "updated_at": "2025-10-31T10:00:00Z"
    },
    "author": "Dr. Smith",
    "collection_id": "col_articles",
    "description": "Text document with _internal structure",
    "document_id": "doc_f8966ff29c18e20c6b45e053",
    "title": "AI in Healthcare"
  }
]