API Reference
Libraries
API Overview
Projects
List Projects
GET/api/v1/projects
Get Project
GET/api/v1/projects/{project_id}
Data Sinks
List Data Sinks
GET/api/v1/data-sinks
Create Data Sink
POST/api/v1/data-sinks
Get Data Sink
GET/api/v1/data-sinks/{data_sink_id}
Update Data Sink
PUT/api/v1/data-sinks/{data_sink_id}
Delete Data Sink
DELETE/api/v1/data-sinks/{data_sink_id}
Data Sources
List Data Sources
GET/api/v1/data-sources
Create Data Source
POST/api/v1/data-sources
Get Data Source
GET/api/v1/data-sources/{data_source_id}
Update Data Source
PUT/api/v1/data-sources/{data_source_id}
Delete Data Source
DELETE/api/v1/data-sources/{data_source_id}
Files
Upload File
POST/api/v1/beta/files
List Files
GET/api/v1/beta/files
Delete File
DELETE/api/v1/beta/files/{file_id}
Read File Content
GET/api/v1/beta/files/{file_id}/content
Pipelines
Search Pipelines
GET/api/v1/pipelines
Create Pipeline
POST/api/v1/pipelines
Get Pipeline
GET/api/v1/pipelines/{pipeline_id}
Update Existing Pipeline
PUT/api/v1/pipelines/{pipeline_id}
Delete Pipeline
DELETE/api/v1/pipelines/{pipeline_id}
Get Pipeline Status
GET/api/v1/pipelines/{pipeline_id}/status
Upsert Pipeline
PUT/api/v1/pipelines
Run Search
POST/api/v1/pipelines/{pipeline_id}/retrieve
PipelinesSync
Sync Pipeline
POST/api/v1/pipelines/{pipeline_id}/sync
Cancel Pipeline Sync
POST/api/v1/pipelines/{pipeline_id}/sync/cancel
PipelinesData Sources
List Pipeline Data Sources
GET/api/v1/pipelines/{pipeline_id}/data-sources
Add Data Sources To Pipeline
PUT/api/v1/pipelines/{pipeline_id}/data-sources
Update Pipeline Data Source
PUT/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}
Get Pipeline Data Source Status
GET/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status
Sync Pipeline Data Source
POST/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync
PipelinesImages
List File Page Screenshots
GET/api/v1/files/{id}/page_screenshots
Get File Page Screenshot
GET/api/v1/files/{id}/page_screenshots/{page_index}
Get File Page Figure
GET/api/v1/files/{id}/page-figures/{page_index}/{figure_name}
List File Pages Figures
GET/api/v1/files/{id}/page-figures
PipelinesFiles
Get Pipeline File Status Counts
GET/api/v1/pipelines/{pipeline_id}/files/status-counts
Get Pipeline File Status
GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status
Add Files To Pipeline Api
PUT/api/v1/pipelines/{pipeline_id}/files
Update Pipeline File
PUT/api/v1/pipelines/{pipeline_id}/files/{file_id}
Delete Pipeline File
DELETE/api/v1/pipelines/{pipeline_id}/files/{file_id}
PipelinesMetadata
Import Pipeline Metadata
PUT/api/v1/pipelines/{pipeline_id}/metadata
Delete Pipeline Files Metadata
DELETE/api/v1/pipelines/{pipeline_id}/metadata
PipelinesDocuments
Create Batch Pipeline Documents
POST/api/v1/pipelines/{pipeline_id}/documents
Paginated List Pipeline Documents
GET/api/v1/pipelines/{pipeline_id}/documents/paginated
Get Pipeline Document
GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}
Delete Pipeline Document
DELETE/api/v1/pipelines/{pipeline_id}/documents/{document_id}
Get Pipeline Document Status
GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status
Sync Pipeline Document
POST/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync
List Pipeline Document Chunks
GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks
Upsert Batch Pipeline Documents
PUT/api/v1/pipelines/{pipeline_id}/documents
Retrievers
Create Retriever
POST/api/v1/retrievers
Upsert Retriever
PUT/api/v1/retrievers
List Retrievers
GET/api/v1/retrievers
Get Retriever
GET/api/v1/retrievers/{retriever_id}
Update Retriever
PUT/api/v1/retrievers/{retriever_id}
Delete Retriever
DELETE/api/v1/retrievers/{retriever_id}
Direct Retrieve
POST/api/v1/retrievers/retrieve
RetrieversRetriever
Retrieve
POST/api/v1/retrievers/{retriever_id}/retrieve
Parsing
Classifier
ClassifierJobs
Create Classify Job
POST/api/v1/classifier/jobs
List Classify Jobs
GET/api/v1/classifier/jobs
Get Classify Job
GET/api/v1/classifier/jobs/{classify_job_id}
Get Classification Job Results
GET/api/v1/classifier/jobs/{classify_job_id}/results
Extraction
Extract Stateless
POST/api/v1/extraction/run
ExtractionJobs
List Jobs
GET/api/v1/extraction/jobs
Run Job
POST/api/v1/extraction/jobs
Get Job
GET/api/v1/extraction/jobs/{job_id}
Run Job On File
POST/api/v1/extraction/jobs/file
Get Job Result
GET/api/v1/extraction/jobs/{job_id}/result
ExtractionRuns
List Extract Runs
GET/api/v1/extraction/runs
Get Run
GET/api/v1/extraction/runs/{run_id}
Delete Extraction Run
DELETE/api/v1/extraction/runs/{run_id}
Get Run By Job Id
GET/api/v1/extraction/runs/by-job/{job_id}
ExtractionExtraction Agents
Create Extraction Agent
POST/api/v1/extraction/extraction-agents
List Extraction Agents
GET/api/v1/extraction/extraction-agents
Get Extraction Agent
GET/api/v1/extraction/extraction-agents/{extraction_agent_id}
Delete Extraction Agent
DELETE/api/v1/extraction/extraction-agents/{extraction_agent_id}
Update Extraction Agent
PUT/api/v1/extraction/extraction-agents/{extraction_agent_id}
ExtractionExtraction AgentsSchema
Validate Extraction Schema
POST/api/v1/extraction/extraction-agents/schema/validation
Generate Extraction Schema
POST/api/v1/extraction/extraction-agents/schema/generate
Beta
BetaAgent Data
Get Agent Data
GET/api/v1/beta/agent-data/{item_id}
Update Agent Data
PUT/api/v1/beta/agent-data/{item_id}
Delete Agent Data
DELETE/api/v1/beta/agent-data/{item_id}
Create Agent Data
POST/api/v1/beta/agent-data
Search Agent Data
POST/api/v1/beta/agent-data/:search
Aggregate Agent Data
POST/api/v1/beta/agent-data/:aggregate
Delete Agent Data By Query
POST/api/v1/beta/agent-data/:delete
BetaParse Configurations
Create Parse Configuration
POST/api/v1/beta/parse-configurations
List Parse Configurations
GET/api/v1/beta/parse-configurations
Get Parse Configuration
GET/api/v1/beta/parse-configurations/{config_id}
Update Parse Configuration
PUT/api/v1/beta/parse-configurations/{config_id}
Delete Parse Configuration
DELETE/api/v1/beta/parse-configurations/{config_id}
BetaSheets
Create Spreadsheet Job
POST/api/v1/beta/sheets/jobs
List Spreadsheet Jobs
GET/api/v1/beta/sheets/jobs
Get Spreadsheet Job
GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}
Get Result Region
GET/api/v1/beta/sheets/jobs/{spreadsheet_job_id}/regions/{region_id}/result/{region_type}
Delete Spreadsheet Job
DELETE/api/v1/beta/sheets/jobs/{spreadsheet_job_id}
BetaDirectories
Create Directory
POST/api/v1/beta/directories
List Directories
GET/api/v1/beta/directories
Get Directory
GET/api/v1/beta/directories/{directory_id}
Update Directory
PATCH/api/v1/beta/directories/{directory_id}
Delete Directory
DELETE/api/v1/beta/directories/{directory_id}
BetaDirectoriesFiles
Add Directory File
POST/api/v1/beta/directories/{directory_id}/files
List Directory Files
GET/api/v1/beta/directories/{directory_id}/files
Get Directory File
GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Update Directory File
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Delete Directory File
DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Upload File To Directory
POST/api/v1/beta/directories/{directory_id}/files/upload
BetaBatch
Create Batch Job
POST/api/v1/beta/batch-processing
List Batch Jobs
GET/api/v1/beta/batch-processing
Get Batch Job Status
GET/api/v1/beta/batch-processing/{job_id}
Cancel Batch Job
POST/api/v1/beta/batch-processing/{job_id}/cancel
BetaBatchJob Items
List Batch Job Items
GET/api/v1/beta/batch-processing/{job_id}/items
Get Item Processing Results
GET/api/v1/beta/batch-processing/items/{item_id}/processing-results
BetaSplit
Create Split Job
POST/api/v1/beta/split/jobs
List Split Jobs
GET/api/v1/beta/split/jobs
Get Split Job
GET/api/v1/beta/split/jobs/{split_job_id}