Docs menu
Get started
API reference
Classification
Landed cost
Products
Compliance
Reference
Origin
Shipping documents
Bulk
Catalogue
- GETList products
- POSTCreate a product
- GETGet a product
- PATCHUpdate a product
- POSTArchive a product
- GETA product’s history
- GETA product’s codes
- POSTAdd a code
- POSTSuggest codes
- POSTApprove a code
- POSTReject a code
- POSTClassify many products
- GETYour imports
- POSTImport a CSV file
- GETAn import
- GETExport as CSV
- POSTSync records from a source
- GETApproved codes to write back
- GETCatalogue vocabularies
- GETSource kinds
- GETDefault target markets
- POSTSet default target markets
API reference
Classification modes
GET https://staging-api.border.bot/v1/classify/modes
Public: no API key needed.
The classification modes you can use (admin configures them: today mini, pro and max), with what each costs and reads, in general or for one destination: whether it reads a product photo, and a photo sent inline, and which mode runs when a request names none. A product page URL works in every mode. No API key needed.
Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | no | ISO-2 destination: what each mode offers there (photos sent inline need border.bot’s own classifier). |
Responses#
200: The modes. (ClassifyModesResponse)400: Invalid input (invalid_input). (Error)429: Rate limited (rate_limited). Retry afterRetry-Afterseconds;RateLimitsays which limit was hit (r=0,tseconds until its window ends) andRateLimit-Policyits quota. (Error)500: Unexpected error (internal). (Error)
Example#
curl -X GET 'https://staging-api.border.bot/v1/classify/modes'