Extract data from file

post https://developers.typless.com/api/extract-data

Extract data using selected document type format from provided file.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

extracted_fields

array of objects

required

length ≥ 1

extracted_fields*

object

data_type

string

length ≥ 1

Data type of the field

STRING DATE NUMBER VAT_ID

name

string

length ≥ 1

Name of the field

values

array of objects

length ≥ 1

values

object

confidence_score

number

Model confidence of the value correctness. Range from 0 to 1

height

number

Height of the recognized block of the value

page_number

number

Page number of the recognized block

value

string

length ≥ 1

Value of the block

width

number

Width of the recognized block of the value

number

X position of the recognized block on the provided page_number

number

Y position of the recognized block on the provided page_number

line_items

array of arrays of objects

required

line_items*

array of objects

object

data_type

string

length ≥ 1

Data type of the field

STRING DATE NUMBER VAT_ID

name

string

length ≥ 1

Name of the field

values

array of objects

length ≥ 1

values

object

confidence_score

number

Model confidence of the value correctness. Range from 0 to 1

height

number

Height of the recognized block of the value

page_number

number

Page number of the recognized block

value

string

length ≥ 1

Value of the block

width

number

Width of the recognized block of the value

number

X position of the recognized block on the provided page_number

number

Y position of the recognized block on the provided page_number

object_id

string

required

length ≥ 1

customer

string

required

length ≥ 1

file_name

string

required

length ≥ 1

vat_rates

array of arrays of objects

required

vat_rates*

array of objects

object

data_type

string

length ≥ 1

Data type of the field

STRING DATE NUMBER VAT_ID

name

string

length ≥ 1

Name of the field

values

array of objects

length ≥ 1

values

object

confidence_score

number

Model confidence of the value correctness. Range from 0 to 1

height

number

Height of the recognized block of the value

page_number

number

Page number of the recognized block

value

string

length ≥ 1

Value of the block

width

number

Width of the recognized block of the value

number

X position of the recognized block on the provided page_number

number

Y position of the recognized block on the provided page_number

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://developers.typless.com/api/extract-data \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Extracted data from input file

400Bad request and validation errors code 400 response

401Authorization errors for 401 code UNAUTHORIZED requests

403Forbidden errors for 403 code FORBIDDEN requests

405Method not allowed error 405 code response

500InternalServerError code 500 response