border.bot
Docs menu

API reference

API reference

Say whether a classification was right

POST https://api.border.bot/v1/classify/feedback

Requires an API key (Authorization: Bearer bb_live_…).

Tell border.bot a code was right, or what it should have been. Corrections are reviewed and become test cases the classifier must pass. With the classification’s usageId, sending again replaces your earlier verdict until it is reviewed. Free; up to 1,000 a day.

API key scope: classify.

Request body (JSON)#

Name Type Required Description
usageId string no
destinationCountry string yes
description string yes
predictedCode string yes
verdict "right" | "wrong" yes
correctCode string no
reason string no
mode string no
productUrl string (uri) no

Responses#

  • 200: The feedback was recorded. (ClassifyFeedbackResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the classify scope (forbidden, details.reason: "missing_scope"). (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 POST 'https://api.border.bot/v1/classify/feedback' \
  -H 'Authorization: Bearer bb_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"usageId":"use_01J9ZK8Q7X4N2M","destinationCountry":"US","description":"Yoga mat, 6 mm, TPE","predictedCode":"3926909985","verdict":"wrong","correctCode":"9506910030","reason":"Exercise equipment, not an article of plastics"}'