Hypatos API v2 documentation (1.1.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Cloud authentication

Obtain API access token

access_token is used as Authorization Bearer token in header for cloud extractions requests.

Request Body schema: application/x-www-form-urlencoded
client_id
required
string
Value: "extractionapi"
username
required
string
password
required
string
grant_type
required
string
Value: "password"

Responses

200

Returns access token with additional informations

401

Unauthorized

500

Internal Server Error

post /auth/realms/hypatos/protocol/openid-connect/token
https://customers.hypatos.ai/auth/realms/hypatos/protocol/openid-connect/token

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "access_token": "string",
  • "scope": "string",
  • "session_state": "string",
  • "token_type": "string"
}

Cloud extractions

Community Edition - German invoice extraction

Extract PDF invoice file using Community Edition. For software projects requiring basic document data capturing AI.

Authorizations:
query Parameters
probabilities
boolean
Default: false

will output confidence score of each extracted entity

regions
boolean
Default: false

will output entity regions

ocr
boolean
Default: false

will output ocr results, in json format or xml (ocrFormat)

dpi
integer
Default: 200

DPI configuration. Higher the resolution, slower the API response

ocrFormat
string
Default: "xml"
Enum: "json" "xml"

OCR format

Request Body schema:
string <binary>

Responses

200

Extracted invoice data

400

Bad Request

401

Unauthorized (invalid Authorization Bearer token)

429

Too Many Requests (when request limits are reached)

500

Internal Server Error

post /community/invoices
https://api.hypatos.ai/v2/community/invoices

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "entities":
    {
    },
  • "infos":
    {
    },
  • "others":
    {
    },
  • "probabilities":
    {
    },
  • "regions":
    {