H2h2o
Extractors

Run an extractor on a collection, document, or uploaded files (synchronous)

Executes the specified extractor synchronously and returns results with a 200 OK response.

Exactly one of the following must be provided:

  • collection_id — run on all documents in a collection
  • document_id — run on a single document in a collection
  • files — one or more files uploaded directly in the request body (multipart/form-data) without adding them to a collection

This endpoint blocks and waits for the extraction to complete, then returns the results.

This endpoint is primarily intended for short-running extractions where immediate results are desired.

For very long running extractions use the async endpoint /extractors/{extractor_id}/job instead.

post/extractors/{extractor_id}/run

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

Request body multipart/form-data

filesstring[]

One or more files to run the extractor on directly, without adding them to a collection. Mutually exclusive with collection_id and document_id.

Response

Extraction completed successfully. Returns an array of extraction results, one for each document processed.

idstring required

ID of the document extraction result

document_idstring nullable

ID of the document that was processed. Null when the extraction was run on uploaded files without a collection.

document_namestring required

Name of the document that was processed

contentunknown required
errorstring required

Contains error in case extraction failed for this document. Otherwise empty.

Changes

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