find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bol-ai:bol-ai-usage-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bol.ai Usage API
  version: 1.0.0
  description: Freight-document data extraction. Upload a Bill of Lading, commercial invoice, packing list or CMR road waybill (PDF/PNG/JPG); the document type is detected automatically and returned as doc_type, with a field set tailored to that type. Fields not present in the document are null — never guessed. One document = one usage unit regardless of type. Documents and data are stored exclusively in the EU.
  contact:
    url: https://bol.ai
servers:
- url: https://bol.ai
security:
- apiKey: []
tags:
- name: Usage
paths:
  /api/usage:
    get:
      summary: Usage and billing state
      description: Remaining prepaid credits, active subscription (if any) and can_extract. Agents should call this before large batches instead of discovering exhaustion via a 402 mid-batch. A 402 from extract endpoints includes buy_credits_url and checkout_endpoint so a human can top up.
      responses:
        '200':
          description: Usage state
          content:
            application/json:
              schema:
                type: object
                properties:
                  credits:
                    type: integer
                  subscription:
                    type:
                    - object
                    - 'null'
                    properties:
                      status:
                        type: string
                      plan:
                        type: string
                        enum:
                        - starter
                        - professional
                      current_period_end:
                        type:
                        - string
                        - 'null'
                  can_extract:
                    type: boolean
                  buy_credits_url:
                    type: string
      tags:
      - Usage
      operationId: getApiUsage
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Bol.ai API key (bolai_...). Create one in the app: https://bol.ai/app/ — available on the Professional plan or with credits; new accounts include 5 free documents.'