LAS (Lucidtech AI Services) API documentation version v0

https://api.lucidtech.ai/{version}

version: required (v0)

High-Level API Overview

Scanning a document with Lucidtech AI Services consists of the following steps:

PUT on /documents to create a document handle. The request returns a pre-signed url and a document id.
PUT on pre-signed url to upload your document.
POST on /invoices or /receipts with document id to scan your document.

Optional

POST on /documents/{documentId} with document id to post a feedback to the API. Feedback data will be used to improve the APIs.

Please see below for a detailed description.

SDKs

List of SDKs:

Python SDK (Github) (Reference)

/invoices

/invoices post

post

Scan an invoice.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/invoices \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentId": "a50920e1-214b-4c46-9137-2c03f96aad56"}'

Scan an invoice.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/invoices \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentId": "a50920e1-214b-4c46-9137-2c03f96aad56"}'

Secured by x-api-key

Authentication by API key

Body

Media type: application/json

Type: object

Properties

documentId: required (string)
As returned by PUT on /documents
minConfidence: (number)

Example:

{
  "documentId": "a50920e1-214b-4c46-9137-2c03f96aad56",
  "minConfidence": "0.5"
}

HTTP status code 200

Body

Media type: application/json

Type: array of Field

Items: Field

label: required (string)
value: required (string)
confidence: required (number)

Example:

[
  {
    "label": "total_amount",
    "value": "50.23",
    "confidence": 0.9731
  },
  {
    "label": "payment_date",
    "value": "2018-07-25",
    "confidence": 0.9921
  }
]

Secured by x-api-key

Headers

x-api-key: required (string)

HTTP status code 401

Unauthorized

/receipts

/receipts post

post

Scan a receipt.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/receipts \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentId": "a50920e1-214b-4c46-9137-2c03f96aad56"}'

Scan a receipt.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/receipts \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentId": "a50920e1-214b-4c46-9137-2c03f96aad56"}'

Secured by x-api-key

Authentication by API key

Body

Media type: application/json

Type: object

Properties

documentId: required (string)
As returned by PUT on /documents
minConfidence: (number)

Example:

{
  "documentId": "a50920e1-214b-4c46-9137-2c03f96aad56",
  "minConfidence": "0.5"
}

HTTP status code 200

Body

Media type: application/json

Type: array of Field

Items: Field

label: required (string)
value: required (string)
confidence: required (number)

Example:

[
  {
    "label": "total",
    "value": "50.23",
    "confidence": 0.9731
  },
  {
    "label": "date",
    "value": "2018-07-25",
    "confidence": 0.9921
  }
]

Secured by x-api-key

Headers

x-api-key: required (string)

HTTP status code 401

Unauthorized

/documents

/documents put

put

Create a document handle and get a pre-signed upload url.

Example usage:

$ curl -X PUT https://api.lucidtech.ai/v0/documents \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentType": "image/jpeg", "region": "EU"}'

Upload binary document data to retrieved pre-signed url:

$ curl -X PUT https://eu.api.lucidtech.ai.s3.amazonaws.com/... \
  -H 'Content-Type: image/jpeg' \
  --data-binary @document.jpeg

Create a document handle and get a pre-signed upload url.

Example usage:

$ curl -X PUT https://api.lucidtech.ai/v0/documents \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"documentType": "image/jpeg", "region": "EU"}'

Upload binary document data to retrieved pre-signed url:

$ curl -X PUT https://eu.api.lucidtech.ai.s3.amazonaws.com/... \
  -H 'Content-Type: image/jpeg' \
  --data-binary @document.jpeg

Secured by x-api-key

Authentication by API key

Body

Media type: application/json

Type: object

Properties

documentType: required (one of image/jpeg, image/gif, image/png, image/bmp, application/pdf)
Mime type of the document to be uploaded
region: (EU - default: EU)
Specify a region for the document to be uploaded. Currently only EU is supported

Example:

{
  "documentType": "application/pdf",
  "region": "EU"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

uploadUrl: required (string)
A pre-signed url for a PUT operation.
Content-Type must match documentType provided in this request when PUT-ting to uploadUrl.
The request body should contain binary data.
We use Amazon s3 for fast, secure and reliable file transfer.
documentId: required (string)
A unique ephemeral document identifier. This documentId is used when scanning a document.

Example:

{
  "documentId": "a50920e1-214b-4c46-9137-2c03f96aad56",
  "uploadUrl": "https://eu.api.lucidtech.ai.s3.amazonaws.com/..."
}

Secured by x-api-key

Headers

x-api-key: required (string)

HTTP status code 401

Unauthorized

/documents/{documentId} post delete

post

Post feedback to the API for further improvement of the API.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/documents/<document id> \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"feedback": [{"label": "total_amount", "value": "140.50"}]}'

delete

Delete a document from our servers

Example usage:

$ curl -X DELETE https://api.lucidtech.ai/v0/documents/<document id> \
  -H 'x-api-key: <your api key>'

Post feedback to the API for further improvement of the API.

Example usage:

$ curl -X POST https://api.lucidtech.ai/v0/documents/<document id> \
  -H 'x-api-key: <your api key>' \
  -H 'Content-Type: application/json' \
  -d '{"feedback": [{"label": "total_amount", "value": "140.50"}]}'

Secured by x-api-key

Authentication by API key

URI Parameters

documentId: required (string)

Body

Media type: application/json

Type: object

Properties

feedback: required (array of FeedbackItem - minItems: 0)
Items: FeedbackItem
- label: required (string)
- value: required (string)

Example:

{
  "feedback": [
    {
      "label": "total_amount",
      "value": "140.50"
    },
    {
      "label": "due_date",
      "value": "2017-03-22"
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

Secured by x-api-key

Headers

x-api-key: required (string)

HTTP status code 401

Unauthorized

Delete a document from our servers

Example usage:

$ curl -X DELETE https://api.lucidtech.ai/v0/documents/<document id> \
  -H 'x-api-key: <your api key>'

Secured by x-api-key

Authentication by API key

URI Parameters

documentId: required (string)

Body

Media type: text/plain

Type: any

HTTP status code 200

Body

Media type: text/plain

Type: any

Secured by x-api-key

Headers

x-api-key: required (string)

HTTP status code 401

Unauthorized

LAS (Lucidtech AI Services) API documentation version v0

High-Level API Overview

SDKs

/invoices

/invoices post

Scan an invoice.

post /invoices

Scan an invoice.

Body

HTTP status code 200

Body

Secured by x-api-key

Headers

HTTP status code 401

/receipts

/receipts post

Scan a receipt.

post /receipts

Scan a receipt.

Body

HTTP status code 200

Body

Secured by x-api-key

Headers

HTTP status code 401

/documents

/documents put

Create a document handle and get a pre-signed upload url.

put /documents

Create a document handle and get a pre-signed upload url.

Body

HTTP status code 200

Body

Secured by x-api-key

Headers

HTTP status code 401

/documents/{documentId} post delete

Post feedback to the API for further improvement of the API.

Delete a document from our servers

post /documents/{documentId}

Post feedback to the API for further improvement of the API.

URI Parameters

Body

HTTP status code 200

Body

Secured by x-api-key

Headers

HTTP status code 401

delete /documents/{documentId}

Delete a document from our servers

URI Parameters

Body

HTTP status code 200

Body

Secured by x-api-key

Headers

HTTP status code 401