Retrieve extraction by ID

Use this endpoint in conjunction with asynchronous extraction requests to retrieve your results. You can also use this endpoint to retrieve the results for documents extractions from the synchronous /extract endpoint. To poll extraction status, check the status field in this endpoint’s response. When the extraction completes, the returned status is COMPLETE and the response includes results in the parsed_document field. For fields in the extraction for which Sensible couldn’t find a value, Sensible returns null.

Authorizations

Authorization

string

headerrequired

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Path Parameters

id

string

required

Unique ID for the extraction, used to retrieve the extraction.

Response

200 - application/json

• Option 1
• Option 2

id

string

Unique ID for the extraction, used to retrieve the extraction

created

string

Date and time Sensible created the initial empty extraction and set its status to WAITING.

type

string

Unique user-friendly name for a document type

status

enum<string>

Status of the extraction:

• WAITING: Sensible created an initial empty extraction and is waiting for the document.
• PROCESSING: Sensible received the document and is extracting data.
• FAILED: The extraction failed.
• COMPLETE: The extraction is complete.

Available options:

WAITING,

PROCESSING,

COMPLETE,

FAILED

configuration

string

Name of the "configuration", a collection of SenseML queries for extracting document data.

parsed_document

object

Data extracted from the document, structured as an array of fields. Configure the verbosity parameter in the SenseML configuration to return extraction metadata, such as:

• page numbers
• the bounding polygons that define line coordinates
• for text that Sensible OCR'd, confidence scores. For more information, see Verbosity.

validations

object[]

Which extracted fields failed validation rules you write in the Sensible app

Show child attributes

file_metadata

object

Metadata about the PDF file, for example author, authoring tool, and modified date.

Show child attributes

validation_summary

object

Summary of the extracted fields that fail validation rules you write in the Sensible app.

Show child attributes

errors

object[]

Extraction error messages.

Show child attributes

completed

string

Date and time Sensible set the extraction's status to COMPLETED

classification_summary

object[]

Metadata about how Sensible scores configs against the document to extract from. By default, Sensible compares all configs in the document type, then chooses the best extraction using fingerprints, scores, or a combination of the two. When two extractions tie by score and fingerprints, Sensible chooses the first configuration in alphabetic order. For more information, see fingerprints.

Show child attributes

page_count

integer

Total number of pages in the document.

environment

string

Name of the environment to which the configuration used by this extraction was published.

document_name

string

If you specify the filename of the document using the document_name parameter, then Sensible displays the name in extraction history in the Sensible app and returns the name in the extraction response.

coverage

number

The coverage score measures how fully an extraction captured all your target data in the document. It's a percentage comparing non-null, validated fields to total fields returned by a config for a document. For example, a coverage score of 70% for an extraction with no validation errors means that 30% of fields were null. For more information about scoring, see Monitoring extractions.

download_url

string

URL of the document extraction