border.bot
Docs menu

API reference

API reference

Who am I

GET https://api.border.bot/v1/me

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

The workspace and API key behind this request, with the current credit balance.

Any API key may call this.

Responses#

  • 200: The calling workspace. (MeResponse)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (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/me' \
  -H 'Authorization: Bearer bb_live_...'