ExtractionRun
SavedExtractor
Create a new extractor
Creates a SavedExtractor resource.
POST
/
api
/
extractors
curl --request POST \
--url https://data-wizard.ai/api/extractors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"strategy": "<string>",
"label": "<string>",
"jsonSchema": "<string>",
"outputInstructions": "<string>",
"pageTitle": "<string>",
"introductionViewHeading": "<string>",
"introductionViewDescription": "<string>",
"introductionViewNextButtonLabel": "<string>",
"bucketViewHeading": "<string>",
"bucketViewDescription": "<string>",
"bucketViewBackButtonLabel": "<string>",
"bucketViewContinueButtonLabel": "<string>",
"bucketViewBeginButtonLabel": "<string>",
"extractionViewHeading": "<string>",
"extractionViewDescription": "<string>",
"extractionViewBackButtonLabel": "<string>",
"extractionViewContinueButtonLabel": "<string>",
"extractionViewRestartButtonLabel": "<string>",
"extractionViewStartButtonLabel": "<string>",
"extractionViewCancelButtonLabel": "<string>",
"extractionViewPauseButtonLabel": "<string>",
"resultsViewHeading": "<string>",
"resultsViewDescription": "<string>",
"resultsViewBackButtonLabel": "<string>",
"resultsViewSubmitButtonLabel": "<string>",
"allowDownload": true,
"enableWebhook": true,
"webhookUrl": "<string>",
"redirectUrl": "<string>",
"model": "<string>",
"includeText": true,
"includeEmbeddedImages": true,
"markEmbeddedImages": true,
"includePageImages": true,
"markPageImages": true,
"chunkSize": 123,
"runs": [
"https://example.com/"
]
}'
{
"id": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"strategy": "<string>",
"label": "<string>",
"jsonSchema": "<string>",
"outputInstructions": "<string>",
"pageTitle": "<string>",
"introductionViewHeading": "<string>",
"introductionViewDescription": "<string>",
"introductionViewNextButtonLabel": "<string>",
"bucketViewHeading": "<string>",
"bucketViewDescription": "<string>",
"bucketViewBackButtonLabel": "<string>",
"bucketViewContinueButtonLabel": "<string>",
"bucketViewBeginButtonLabel": "<string>",
"extractionViewHeading": "<string>",
"extractionViewDescription": "<string>",
"extractionViewBackButtonLabel": "<string>",
"extractionViewContinueButtonLabel": "<string>",
"extractionViewRestartButtonLabel": "<string>",
"extractionViewStartButtonLabel": "<string>",
"extractionViewCancelButtonLabel": "<string>",
"extractionViewPauseButtonLabel": "<string>",
"resultsViewHeading": "<string>",
"resultsViewDescription": "<string>",
"resultsViewBackButtonLabel": "<string>",
"resultsViewSubmitButtonLabel": "<string>",
"allowDownload": true,
"enableWebhook": true,
"webhookUrl": "<string>",
"redirectUrl": "<string>",
"model": "<string>",
"includeText": true,
"includeEmbeddedImages": true,
"markEmbeddedImages": true,
"includePageImages": true,
"markPageImages": true,
"chunkSize": 123,
"lastRanAt": "<string>",
"typedSchema": "<string>",
"embeddedUrl": "<string>",
"fullPageUrl": "<string>",
"runs": [
"https://example.com/"
]
}
Authorizations
Value for the http bearer parameter.
Query Parameters
SavedExtractor model
SavedExtractor output_instructions
Body
The new SavedExtractor resource
Response
201
application/json
SavedExtractor resource created
curl --request POST \
--url https://data-wizard.ai/api/extractors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"strategy": "<string>",
"label": "<string>",
"jsonSchema": "<string>",
"outputInstructions": "<string>",
"pageTitle": "<string>",
"introductionViewHeading": "<string>",
"introductionViewDescription": "<string>",
"introductionViewNextButtonLabel": "<string>",
"bucketViewHeading": "<string>",
"bucketViewDescription": "<string>",
"bucketViewBackButtonLabel": "<string>",
"bucketViewContinueButtonLabel": "<string>",
"bucketViewBeginButtonLabel": "<string>",
"extractionViewHeading": "<string>",
"extractionViewDescription": "<string>",
"extractionViewBackButtonLabel": "<string>",
"extractionViewContinueButtonLabel": "<string>",
"extractionViewRestartButtonLabel": "<string>",
"extractionViewStartButtonLabel": "<string>",
"extractionViewCancelButtonLabel": "<string>",
"extractionViewPauseButtonLabel": "<string>",
"resultsViewHeading": "<string>",
"resultsViewDescription": "<string>",
"resultsViewBackButtonLabel": "<string>",
"resultsViewSubmitButtonLabel": "<string>",
"allowDownload": true,
"enableWebhook": true,
"webhookUrl": "<string>",
"redirectUrl": "<string>",
"model": "<string>",
"includeText": true,
"includeEmbeddedImages": true,
"markEmbeddedImages": true,
"includePageImages": true,
"markPageImages": true,
"chunkSize": 123,
"runs": [
"https://example.com/"
]
}'
{
"id": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"strategy": "<string>",
"label": "<string>",
"jsonSchema": "<string>",
"outputInstructions": "<string>",
"pageTitle": "<string>",
"introductionViewHeading": "<string>",
"introductionViewDescription": "<string>",
"introductionViewNextButtonLabel": "<string>",
"bucketViewHeading": "<string>",
"bucketViewDescription": "<string>",
"bucketViewBackButtonLabel": "<string>",
"bucketViewContinueButtonLabel": "<string>",
"bucketViewBeginButtonLabel": "<string>",
"extractionViewHeading": "<string>",
"extractionViewDescription": "<string>",
"extractionViewBackButtonLabel": "<string>",
"extractionViewContinueButtonLabel": "<string>",
"extractionViewRestartButtonLabel": "<string>",
"extractionViewStartButtonLabel": "<string>",
"extractionViewCancelButtonLabel": "<string>",
"extractionViewPauseButtonLabel": "<string>",
"resultsViewHeading": "<string>",
"resultsViewDescription": "<string>",
"resultsViewBackButtonLabel": "<string>",
"resultsViewSubmitButtonLabel": "<string>",
"allowDownload": true,
"enableWebhook": true,
"webhookUrl": "<string>",
"redirectUrl": "<string>",
"model": "<string>",
"includeText": true,
"includeEmbeddedImages": true,
"markEmbeddedImages": true,
"includePageImages": true,
"markPageImages": true,
"chunkSize": 123,
"lastRanAt": "<string>",
"typedSchema": "<string>",
"embeddedUrl": "<string>",
"fullPageUrl": "<string>",
"runs": [
"https://example.com/"
]
}
Assistant
Responses are generated using AI and may contain mistakes.