Skip to main content

Data Curation API Endpoints

The Data Curation API exposes the following endpoints, organized by functional area:

Pipeline Endpoints

Core endpoints for document processing and job management.

MethodEndpointDescription
POST/presignGenerate presigned S3 URLs to upload a file and retrieve job results.
GET/status/{job_id}Retrieve the processing status for a submitted job.
GET/modelsList available embedding models and their configurations.

Configuration Endpoints

Endpoints for managing environment-level configuration and rules.

MethodEndpointDescription
GET/config/optionsRetrieve environment configuration.
POST/config/optionsInitialize environment configuration.
GET/config/options/defaultsRetrieve environment default settings.
PUT/config/options/defaultsUpdate environment default settings.
DELETE/config/options/defaultsReset environment default settings to system defaults.
GET/config/options/rulesList all conditional configuration rules.
POST/config/options/rulesCreate a new conditional configuration rule.
GET/config/options/rules/{rule_id}Retrieve a specific rule by ID.
PUT/config/options/rules/{rule_id}Update a specific rule.
DELETE/config/options/rules/{rule_id}Delete a specific rule.
POST/config/options/rules/testTest rule matching without applying changes.

Health Endpoints

Endpoints for service health monitoring.

MethodEndpointDescription
GET/healthBasic health check probe (no authentication required).
GET/health/detailsDetailed health status with system stats (authenticated).

API Documentation

For detailed information about each endpoint, including request/response schemas, authentication requirements, and example usage, see the individual endpoint documentation pages in this section.

You can also access the OpenAPI specification directly to use with tools such as Swagger or Postman to explore available endpoints and test requests.