Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url http://localhost:3000/v2/file_uploads \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/file_uploads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/file_uploads', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/file_uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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:3000/v2/file_uploads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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:3000/v2/file_uploads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/file_uploads")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"status": "uploaded",
"filename": "report.pdf",
"content_type": "application/pdf",
"size_bytes": 1048576,
"metadata": {
"page_count": 12
},
"uploaded_time": "2024-11-14T10:31:23.456Z",
"expires_at": "2024-11-14T11:30:00.000Z",
"public": false,
"classification": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"document_type": "balance_sheet",
"confidence": 0.98
},
"parse": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"jobId": "<string>"
},
"index": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe"
},
"insights": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"facts": [
{
"id": "<string>",
"entity_indexes": [
123
],
"statement": "<string>",
"references": [
{
"page_number": 123
}
],
"method": "verbatim",
"confidence": 123,
"source_id": "<string>",
"entities": [
{
"type": "company",
"name": "<string>",
"document": "<string>"
}
]
}
],
"claims": [
{
"id": "cl_abc123",
"statement": "Company revenue increased 15% YoY",
"confidence": 0.92,
"supporting_facts": [
"f_xyz789"
],
"category": "financial"
}
],
"issues": [
{
"id": "iss_abc123",
"type": "missing_data",
"description": "Required field \"date\" is missing",
"severity": "warning",
"fact_id": "f_xyz789"
}
],
"checks": [
{
"id": "chk_abc123",
"name": "total_assets_validation",
"passed": true,
"message": "Total assets matches sum of components",
"severity": "info"
}
]
},
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"reused": false,
"upload_url": "https://s3.amazonaws.com/bucket/key?X-Amz-Signature=...",
"upload_headers": {},
"url": "https://files.base39.cloud/uploads/org_abc/fl_abc123/report.pdf",
"preview_url": "https://files.base39.cloud/uploads/org_abc/fl_abc123/preview/page-01.png",
"download_url": "https://s3.amazonaws.com/bucket/key?X-Amz-Signature=...",
"page_id": "page_abc123",
"purpose": "agent",
"public_url": "https://files.base39.com.br/uploads/org_abc/fl_abc123/report.pdf",
"resources": [
{}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}List all file uploads for current organization (paginated)
curl --request GET \
--url http://localhost:3000/v2/file_uploads \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/file_uploads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/file_uploads', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/file_uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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:3000/v2/file_uploads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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:3000/v2/file_uploads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/file_uploads")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"status": "uploaded",
"filename": "report.pdf",
"content_type": "application/pdf",
"size_bytes": 1048576,
"metadata": {
"page_count": 12
},
"uploaded_time": "2024-11-14T10:31:23.456Z",
"expires_at": "2024-11-14T11:30:00.000Z",
"public": false,
"classification": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"document_type": "balance_sheet",
"confidence": 0.98
},
"parse": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"jobId": "<string>"
},
"index": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe"
},
"insights": {
"status": "completed",
"started_at": "2024-12-07T11:01:00.000Z",
"completed_at": "2024-12-07T11:02:30.000Z",
"error": "Unsupported file type for parsing: arquivo.exe",
"facts": [
{
"id": "<string>",
"entity_indexes": [
123
],
"statement": "<string>",
"references": [
{
"page_number": 123
}
],
"method": "verbatim",
"confidence": 123,
"source_id": "<string>",
"entities": [
{
"type": "company",
"name": "<string>",
"document": "<string>"
}
]
}
],
"claims": [
{
"id": "cl_abc123",
"statement": "Company revenue increased 15% YoY",
"confidence": 0.92,
"supporting_facts": [
"f_xyz789"
],
"category": "financial"
}
],
"issues": [
{
"id": "iss_abc123",
"type": "missing_data",
"description": "Required field \"date\" is missing",
"severity": "warning",
"fact_id": "f_xyz789"
}
],
"checks": [
{
"id": "chk_abc123",
"name": "total_assets_validation",
"passed": true,
"message": "Total assets matches sum of components",
"severity": "info"
}
]
},
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"reused": false,
"upload_url": "https://s3.amazonaws.com/bucket/key?X-Amz-Signature=...",
"upload_headers": {},
"url": "https://files.base39.cloud/uploads/org_abc/fl_abc123/report.pdf",
"preview_url": "https://files.base39.cloud/uploads/org_abc/fl_abc123/preview/page-01.png",
"download_url": "https://s3.amazonaws.com/bucket/key?X-Amz-Signature=...",
"page_id": "page_abc123",
"purpose": "agent",
"public_url": "https://files.base39.com.br/uploads/org_abc/fl_abc123/report.pdf",
"resources": [
{}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
Comma-separated fields to expand. Supports selection with brackets (e.g., "createdBy,updatedBy" or "targets.company[icon,tradeName]").
"createdBy"
Number of items to return per page
1 <= x <= 100100
Opaque cursor for pagination. Use the next_cursor from previous response.
"eyJjcmVhdGVkX3RpbWUiOiIyMDI0LTExLTE1VDEwOjAwOjAwLjAwMFoiLCJpZCI6InBhZ2VfYWJjMTIzIn0="
Stripe-like search query filter.
Syntax:
field:"value"field:"prefix*", field:"*suffix", field:"*contains*"field>100, field>=100field:null-field:"value"field1:"a" AND field2:"b"Examples:
status:"uploaded" - Filter by statusfilename:"*2024*.pdf" - Filter by filename with wildcardstatus:"uploaded" AND classification.status:"completed" - Combined filter"status:\"uploaded\""
Optional comma-separated list of extra fields to include. Supported values: "patterns.data", "extract.data", "insights.facts".
"patterns.data"