GET
/
api
/
extractors
[
  {
    "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

​
Authorization
string
header
required

Value for the http bearer parameter.

Query Parameters

​
page
integer
default:1

The collection page number

​
model
string

SavedExtractor model

​
output_instructions
string

SavedExtractor output_instructions

Response

200
application/json
SavedExtractor collection
​
id
string
​
deletedAt
string | null
​
createdAt
string | null
​
updatedAt
string | null
​
strategy
string
​
label
string | null
​
jsonSchema
string
​
outputInstructions
string | null
​
pageTitle
string | null
​
introductionViewHeading
string | null
​
introductionViewDescription
string | null
​
introductionViewNextButtonLabel
string | null
​
bucketViewHeading
string | null
​
bucketViewDescription
string | null
​
bucketViewBackButtonLabel
string | null
​
bucketViewContinueButtonLabel
string | null
​
bucketViewBeginButtonLabel
string | null
​
extractionViewHeading
string | null
​
extractionViewDescription
string | null
​
extractionViewBackButtonLabel
string | null
​
extractionViewContinueButtonLabel
string | null
​
extractionViewRestartButtonLabel
string | null
​
extractionViewStartButtonLabel
string | null
​
extractionViewCancelButtonLabel
string | null
​
extractionViewPauseButtonLabel
string | null
​
resultsViewHeading
string | null
​
resultsViewDescription
string | null
​
resultsViewBackButtonLabel
string | null
​
resultsViewSubmitButtonLabel
string | null
​
allowDownload
boolean
​
enableWebhook
boolean
​
webhookUrl
string | null
​
redirectUrl
string | null
​
model
string | null
​
includeText
boolean
​
includeEmbeddedImages
boolean
​
markEmbeddedImages
boolean
​
includePageImages
boolean
​
markPageImages
boolean
​
chunkSize
integer | null
​
lastRanAt
string | null
​
typedSchema
string | null
​
embeddedUrl
string | null
​
fullPageUrl
string | null
​
runs
string[]