Create Extractor
Create a new extractor.
You can optionally provide a generate object to automatically generate an extraction schema from sample documents using AI. generate is mutually exclusive with config and cloneExtractorId.
Create a new extractor.
You can optionally provide a generate object to automatically generate an extraction schema from sample documents using AI. generate is mutually exclusive with config and cloneExtractorId.
Bearer authentication of the form Bearer <token>, where token is your auth token.
The ID of an existing extractor to clone. If provided, the new extractor will be created with the same config as the extractor with this ID. Cannot be provided together with config or generate.
Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"
The configuration for the extractor. Cannot be provided together with cloneExtractorId or generate.
If provided, an extraction schema is automatically generated from the supplied sample documents and applied to the extractor’s draft. The response includes the extractor with the generated schema already in place.
Cannot be provided together with config or cloneExtractorId.
The type of object. Will always be "extractor".
The ID of the extractor.
Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"
The name of the extractor.
Example: "Invoice Extractor"
The time (in UTC) at which the object was created. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.
Example: "2024-03-21T16:45:00Z"
API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.