Extract doc at a Sensible URL using specified config

post

https://api.sensible.so/v0/generate_upload_url/{document_type}/{config_name}

This endpoint's behavior is identical to the Extract doc at a Sensible URL endpoint's behavior, except that Sensible uses the specified config to extract data from the document instead of automatically choosing the best-scoring extraction in the document type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

document_type

string

required

Type of document to extract from. Create your custom type in the Sensible app (for example, rate_confirmation, certificate_of_insurance, or home_inspection_report). To quickly test this endpoint using the Try It button in this interactive explorer, use the senseml_basics tutorial document type with this example document. As a convenience, Sensible automatically detects the best-fit extraction from among the extraction queries ("configs") in the document type. For example, if you create an auto_insurance_quotes document type, you can add carrier 1, carrier 2, and carrier 3 configs to the document type in the Sensible app. Sensible then automatically classifies each document you upload by its carrier, so you can use the same document type for each carrier without specifying the carrier in the extraction request.

config_name

string

required

User-friendly name of the config to use to extract data from the document.

Query Params

environment

string

enum

Defaults to production

If you specify development, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists.

Allowed:

document_name

string

If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response.

Body Params

webhook

object

Pushes extraction results to the specified webhook under the following circumstances, so you don't have to poll for results status:

When Sensible sets "status": "COMPLETE" or "status": "FAILED"
When the value for reviewStatus (for portfolio extractions) or reviewStatus (for single-document extractions) changes.

content_type

string

enum

Content type of the document being presented for extraction. Required for the CSV file type.

Allowed:

extra_data

object

Extra data in the form of flat key/value pairs you attach to an asynchronous extraction endpoint request, for example, {"applicant_id": "A-123", "expected_premium": 1250.00}. Use this parameter to bring request-time context into a config's output so validations, postprocessors, and computed field methods can read it. For example, use it to validate extraction data against a dynamic external record. Has the following constraints:

Doesn't support synchronous extractions
Doesn't support nested objects and arrays
Values must be strings, numbers, booleans, or null
Extra data has a maximum size of 16 kB
Extra data isn't subject to custom data retention policies. Don't include sensitive information in it.

Sensible persists the extra data and echoes it in responses and webhook deliveries. When you submit a portfolio extraction with extra data, Sensible passes the same object to every document extracted from the portfolio. For more information, see the Extra Data method.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Returns the upload_url at which to PUT the document for extraction

400Bad Request

401Not authorized

415Unsupported Media Type

429Too Many Requests

500Internal Server Error