border.bot
Docs menu

API reference

API reference

Classification modes

GET https://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 after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
  • 500: Unexpected error (internal). (Error)

Example#

bash
curl -X GET 'https://api.border.bot/v1/classify/modes'