H2h2o
Extractors

Create a job to run an extractor on a collection or document

Creates a job to execute the specified extractor by running it on all documents in a collection, or on a single document when document_id is specified. This endpoint is designed for long-running extractions.

The endpoint immediately returns a 201 Created response with job details.

Exactly one of collection_id or document_id must be provided.

post/extractors/{extractor_id}/job

Request

Path parameters

extractor_idstring required

ID of the extractor to run

Query parameters

collection_idstring

ID of the collection to run the extractor on. Exactly one of collection_id or document_id must be provided.

document_idstring

ID of the single document to run the extractor on. Exactly one of collection_id or document_id must be provided.

timeoutnumber double

Timeout in seconds

Response

Job created successfully. The job has been accepted and is being processed. Use GET /jobs/{job_id} to check progress. Once completed, retrieve results using /extractors/{extractor_id}/results?job_id={job_id}.

idstring required
namestring required
overall_status'in progress' | 'completed' | 'failed' | 'canceled' required
statusstring
passed_percentagenumber double required
failed_percentagenumber double required
progressnumber double required
created_atstring date-time required
updated_atstring date-time required
kindstring required
errorsstring[] required
durationstring required
duration_secondsnumber double required
canceled_bystring
cancel_reasonstring
timeoutnumber double
start_timenumber double
files_totalinteger
files_failedinteger

Changes

No recorded changes to this operation across all 1 revision of this API.