How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

sensible-so Retrieve extractions API

Retrieve data extracted asynchronously from documents

sensible-so Retrieve extractions API is one of 7 APIs that Sensible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Retrieve extractions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, https://api.sensible.so/v0.

3 operations 3 paths 46 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Server
https://api.sensible.so/v0
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

sensible-so Retrieve extractions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token using a Sensible API key. Create keys at https://app.sensible.so/account/.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Retrieve extractions 3

Retrieve data extracted asynchronously from documents

GET
/extractions/statistics
Get extraction statistics
statistics 3 params → 200400401415500
GET
/documents/{id}
Retrieve extraction by ID
retrieving-results 1 param → 200400401415500
GET
/extractions
List extractions
list-extractions 11 params → 200400401415500

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ExtractionSyncResponse (21 properties), ExtractionPortfolioRetrievalResponse (16 properties), ExtractionSummaryBase (11 properties), DocumentInPortfolio (6 properties). Each schema is shown below with its type and property counts.

ConfigurationId
string
ID of the "configuration", a collection of SenseML queries for extracting document data.
FileMetadata
object
Metadata about the PDF file, for example author, authoring tool, and modified date.
3 properties
Errors
array
Extraction error messages.
MultiExtractionSummaryDocument
object
5 properties
ExtractionSyncResponse
object
21 properties
DocumentInPortfolio
object
6 properties
ValidationsSummary
object
Summary of the extracted fields that fail validation rules you write in the Sensible app.
5 properties
ContentTypeResponse
string
The content type of the document.
ExtractionPortfolioRetrievalResponse
object
16 properties
DocumentTypeId
string
Unique user-friendly name for a document type
ClassificationSummary
array
Metadata about how Sensible scores configs against the document to extract from. By default, Sensible compares all configs in the document type, then chooses t…
ExtractionCreated
string
Date and time Sensible created the initial empty extraction and set its status to WAITING.
Validations
array
Which extracted fields failed validation rules you write in the Sensible app
ConfigurationVersion
string
Version number for the configuration.
ExtractionId
string
Unique ID for the extraction, used to retrieve the extraction
Score
object
The score for the extraction, used to help choose the best extraction.
3 properties
ExtractionError
object
Extraction error message
3 properties
CoveragePortfolio
number
The overall coverage score for the portfolio is the weighted average of the coverage scores of its subdocuments. For example, if subdocA has 1 non-null field o…
DocName
string
If you specify the filename of the document using the documentname parameter, then Sensible displays the name in extraction history in the Sensible app and ret…
Validation
object
3 properties
PageCountPortfolio
integer
Total number of pages in the portfolio.
SingleExtractionSummaryResponse
object
4 properties
ClassificationSummaryPortfolio
array
Metadata about how Sensible chose the config to use for this extraction. The summary doesn't return fingerprints information for portfolio extractions.
ExtraDataRecord
object
Extra data in the form of flat key/value pairs you attach to an asynchronous extraction endpoint request, for example, {"applicantid": "A-123", "expectedpremiu…
PostprocessorOutput
object
A custom schema that you define using a [postprocessor](https://docs.sensible.so/docs/postprocessor). For example, define this output when your app consumes a…
ExtractionStatus
string
Status of the extraction: - WAITING: Sensible created an initial empty extraction and is waiting for the document. - PROCESSING: Sensible received the document…
DocumentTypeNames
array
Specifies the document types contained in the PDF portfolio.
ExtractionSingleRetrievalResponse
ValidationSummaryPortfolio
object
Summary for the whole portfolio file of the extracted fields that fail validation rules you write in the Sensible app.
5 properties
ReviewStatus
string
The extraction's review status. For more information, see [Human review](https://docs.sensible.so/docs/human-review). Specify a webhook in the extraction reque…
ReviewStatuses
stringnull
The review status for each document in the portfolio, in order of their page ranges in the portfolio. For more information, see [Human review](https://docs.sen…
DownloadUrlDocument
string
URL of the document extraction
Classification
object
4 properties
StatisticsResponse
object
1 property
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](https://do…
ClassificationPortfolio
object
2 properties
MultiExtractionSummaryResponse
object
2 properties
DocumentTypeName
string
Unique user-friendly name for a document type
Charged
integer
The number of extractions charged to your account for this extraction ID.
EnvironmentResponse
string
Name of the environment to which the configuration used by this extraction was published.
ExtractionSummaryBase
object
11 properties
ConfigStats
object
6 properties
ExtractionsResponseFiltered
object
2 properties
ParsedDocument
object
Data extracted from the document, structured as an array of fields. Configure the verbosity parameter in the SenseML configuration to return extraction metadat…
ExtractionCompleted
string
Date and time Sensible set the extraction's status to COMPLETED
ConfigurationName
string
Name of the "configuration", a collection of SenseML queries for extracting document data.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sensible-so-retrieve-extractions-api-openapi.yml Raw ↑

Other APIs Sensible publishes across the network.

sensible-so Configuration API
sensible-so Document API
sensible-so Document type API
sensible-so Get Excel from documents API
sensible-so Portfolio API
sensible-so Reference document API
Where this information came from

This is an independent, third-party profile of sensible-so Retrieve extractions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.