Skip to main content
GET
/
v1
/
documents
List Documents Handler
curl --request GET \
  --url http://localhost:8000/v1/documents
{
  "items": [
    {
      "part_type": "DOCUMENT",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "parent_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active_version": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": 123,
        "name": "<string>",
        "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "materialized_path": "<string>",
        "system_managed": true,
        "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "asset_s3_url": "<string>",
        "fast_plaintext_url": "<string>",
        "system_metadata": {
          "source_s3": "<string>",
          "cleaned_source_s3": "<string>",
          "fast_plaintext_s3": "<string>",
          "hash": "<string>",
          "pipeline_state": {
            "last_run_timestamp": "2023-11-07T05:31:56Z",
            "last_state_update_timestamp": "2023-11-07T05:31:56Z",
            "last_activity": "<string>",
            "error": "<string>",
            "temporal_workflow_id": "<string>",
            "chunks_processed": 123,
            "page_dpi": 123
          },
          "total_pages": 123,
          "total_sections": 123,
          "total_chunks": 123,
          "total_formulas": 123,
          "xlsx_parse_result_s3": "<string>",
          "xlsx_named_ranges": [
            {}
          ],
          "xlsx_kpi_catalog": [
            {}
          ],
          "information_statistics": {
            "num_chunks_by_type": {},
            "total_tokens": 0,
            "num_direct_children": 0,
            "children_depth": 0
          }
        }
      },
      "materialized_path": "<string>",
      "system_managed": true,
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>",
          "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

​
authorization
string | null

Query Parameters

​
parent_path_part_id
string<uuid> | null

Parent PathPart ID (defaults to root)

​
sort_order
enum<string>
default:LOGICAL

Sort order for results (default: LOGICAL)

Available options:
LOGICAL,
NAME,
UPDATED_AT,
CREATED_AT
​
with_tags
boolean
default:false

Include tags in the response (default: false)

​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Cookies

​
ks_uat
string | null

Response

Successful Response

​
items
DocumentResponse · object[]
required

List of items

​
total
integer
required

Total number of items

Required range: x >= 0
​
limit
integer
required

Number of items per page

Required range: x >= 1
​
offset
integer
required

Number of items to skip

Required range: x >= 0