@speakeasy-sdks/sensible

The Document Orchestration Platform for Developers. Onboard documents in minutes with a single sample. Extract accurate data in seconds.

SDK Installation

NPM

npm add @speakeasy-sdks/sensible

Yarn

yarn add @speakeasy-sdks/sensible

Authentication:

Sensible uses API keys to authenticate requests. Find your API key on your Account page in the Sensible app. If you're having trouble with your current key, please reach out to support@sensible.so. 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, for example:

curl --request POST \
       --url "https://api.sensible.so/v0/extract/<TYPE>" \
       --header "Authorization: Bearer <YOUR_API_KEY>" \
       --header "Content-Type: application/pdf" \
       --data-binary "@your_doc.pdf" \

SDK Example Usage

import { Sensible } from "@speakeasy-sdks/sensible";
import { ExtractDataJsonResponse } from "@speakeasy-sdks/sensible/dist/sdk/models/operations";
import { Environment, ExtractionStatus, ValidationSeverity } from "@speakeasy-sdks/sensible/dist/sdk/models/shared";

const sdk = new Sensible({
  security: {
    bearerAuth: "YOUR_BEARER_TOKEN_HERE",
  },
});

sdk.document.extractDataJson("corrupti", {
  document: "provident",
}, Environment.Development).then((res: ExtractDataJsonResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

document

extractDataJson - Extract data from a document
extractDataRaw - Extract data from a document
generateUploadUrl - Extract doc at a Sensible URL
provideDownloadUrl - Extract doc at your URL

pdf

getCsvExtraction - Get CSV extraction
getExcelExtraction - Get Excel extraction

portfolio

generateSensiblePortfolioUrl - Extract portfolio at a Sensible URL
generateYourPortfolioUrl - Extract portfolio at your URL

results

retrieve - Retrieve extraction