AI Engine API
The EasyDogana AI Engine classifies products into TARIC customs codes, resolves applicable duties and normalizes raw product data. This reference is generated from the engine's OpenAPI specification.
Send every request over HTTPS to the production host below.
Base URL
https://ai-engine.parcelabs.comAI Engine release v1.4.0 (52e527e)
The AI Engine uses OAuth 2.0 client credentials. Ask ParceLabs for a client ID and secret with the scopes you need, request an access token from the token endpoint, then send it as Authorization: Bearer <access_token> on every call. Request a new token when it expires. Keep the client secret on your server: never put it in a browser or mobile app.
Request an access token
curl -X POST "https://auth.parcelabs.com/oauth/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d grant_type=client_credentials \
-d client_id="$CLIENT_ID" \
-d client_secret="$CLIENT_SECRET" \
-d scope="ai-engine:easydogana:catalogue:parse"The API version is chosen with a request header, not with the path. Paths carry no version, for example /easydogana/classify.
-
Send the optional header
ParceLabs-Version: 2026-10-23to choose a version. The value is a date. Without the header you get the oldest supported version, which today is2026-10-23. A request never moves to a newer version on its own. -
Every response echoes the resolved version in the
ParceLabs-Versionheader. -
An unknown version is answered with
400and the codeUNSUPPORTED_VERSION. A retired version is answered with410and the codeVERSION_RETIRED. -
A version being phased out answers with
DeprecationandSunsetheaders. Read them to plan your move. - An older version stays supported for at least 12 months after a newer one is released.
Every operation needs one scope in the access token. Request only the scopes your integration uses.
ai-engine:easydogana:catalogue:parseParse CSV, XLSX or JSON product catalogues, with optional description translation and no storage or classification.
Used by: Parse a catalogue file without classification or storage
ai-engine:easydogana:classify:readClassify products, refine a classification, look up HS codes and search the nomenclature by free text.
Used by: Classify a product, Classify up to 100 products, Refine a previous classification, Look up an HS code, Search the TARIC nomenclature by free text
ai-engine:easydogana:normalize:readNormalize product payloads into TARIC-ready text bundles.
Used by: Normalize a product payload, Normalize up to 100 product payloads
Errors use standard HTTP status codes. The body is an ErrorDetail object, except when the request fails schema validation: then the status is 422 and detail holds a list of ValidationError objects.
ErrorDetail
Body of every error returned through FastAPI's `HTTPException`.
- Name
detail- Type
- string
- required
- Description
Human-readable reason. Not a stable machine code.
HTTPValidationError
- Name
detail- Type
- array of ValidationError
- Description
ValidationError
- Name
ctx- Type
- object
- Description
- Name
input- Type
- any
- Description
- Name
loc- Type
- array of string | integer
- required
- Description
- Name
msg- Type
- string
- required
- Description
- Name
type- Type
- string
- required
- Description
Module heartbeat
Module heartbeat.
A lightweight liveness probe. Deep TARIC index diagnostics live at the top-level `/health/indices` endpoint.
No authentication required.
Parameters
- Name
ParceLabs-Version- Type
- string
- Description
API version as a date (
YYYY-MM-DD). Omit it to get the oldest supported version; it never moves to a newer one on its own. An unknown value is answered with 400UNSUPPORTED_VERSION, a retired one with 410VERSION_RETIRED. Every response echoes the resolved version in the same header.Allowed values:
2026-10-23. Default:2026-10-23.
Responses
200Successful Responsemap of string
Request
Loading...
Response 200
{}Example generated from the schema.