documents
List Documents Handler
List documents in a folder.
Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
GET
/
v1
/
documents
List Documents Handler
curl --request GET \
--url http://localhost:8000/v1/documentsimport requests
url = "http://localhost:8000/v1/documents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/v1/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v1/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v1/documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/v1/documents")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/documents")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Query Parameters
Parent PathPart ID (defaults to root)
Sort order for results (default: LOGICAL)
Available options:
LOGICAL, NAME, UPDATED_AT, CREATED_AT Include tags in the response (default: false)
Number of items per page
Required range:
1 <= x <= 100Number of items to skip
Required range:
x >= 0Cookies
Response
Successful Response
⌘I
List Documents Handler
curl --request GET \
--url http://localhost:8000/v1/documentsimport requests
url = "http://localhost:8000/v1/documents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/v1/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v1/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v1/documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/v1/documents")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/documents")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}