API quickstart
Introduction
In this quickstart, use an example SenseML configuration and example document to get a quick "hello world" API response.
- To get started with extracting from your custom documents, see Getting Started.
Extract example document data
To run an API call and return extracted, structured data from a downloaded example document:
-
Get an account at sensible.so.
NOTE In the Sensible app, don't rename the default doc type (senseml_basics) or delete the 1_extract_your_first_data config, or this example fails.
-
Copy your API key from your account page.
-
Copy the following code example into a plain-text application and replace
*YOUR_API_KEY*
with your API key:
curl -L https://github.com/sensible-hq/sensible-docs/raw/main/readme-sync/assets/v0/pdfs/1_extract_your_first_data.pdf \
--output 1_extract_your_first_data.pdf && \
curl --request POST \
--url "https://api.sensible.so/v0/extract/senseml_basics" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/pdf" \
--data-binary "@1_extract_your_first_data.pdf"
curl -L https://github.com/sensible-hq/sensible-docs/raw/main/readme-sync/assets/v0/pdfs/1_extract_your_first_data.pdf ^
--output 1_extract_your_first_data.pdf && ^
curl --request POST ^
--url "https://api.sensible.so/v0/extract/senseml_basics" ^
--header "Authorization: Bearer YOUR_API_KEY" ^
--header "Content-Type: application/pdf" ^
--data-binary "@1_extract_your_first_data.pdf"
- Run the code sample in a command prompt. The code downloads an example document (
1_extract_your_first_data.pdf
) and runs it against an example document type (senseml_basics
). The following excerpt of the API response shows the extracted document text in theparsed_document
object:
{
"parsed_document":{
"your_first_extracted_field":{
"type":"string",
"value":"Welcome to your first document"
}
}
}
(Optional) See how it works in the Sensible app
To see this example in the Sensible app:
-
Log into the Sensible app.
-
Navigate to the first tutorial config.
-
Visually examine the example document (middle pane), config (left pane), and extracted data (right pane) to better understand the API call you just ran:
Next
- See the API reference and example code
- If you're new to APIs, see API tutorials
- To get started with authoring extraction configurations, or configs, for your custom documents, see Getting Started.
Updated 1 day ago