A bulk run’s progress | border.bot API docs

GET https://api.border.bot/v1/bulk/status

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

How far a run has got: items done, succeeded and failed, and the credits charged so far.

API key scope: bulk.

Parameters#

Name	Type	Required	Description
`id`	string	yes

200: The run. (BulkRunResponse)
400: Invalid input (invalid_input). (Error)
401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
403: The API key doesn’t have the bulk 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)

bash

curl -X GET 'https://api.border.bot/v1/bulk/status' \
  -H 'Authorization: Bearer bb_live_...'