Owlbound
Browse the docs

Reference · 3 operations

Credits

The workspace's credit wallet, its ledger and the price list.

Last updated from API version 2026-10-06 at (live spec, refreshed hourly). openapi.json

Credits

credits.get

The workspace's credit wallet.

get/api/v1/credits
Scope
read
Credits
Free
Idempotency-Key
Not used

What the workspace can spend now (available = buckets minus debt), by bucket: purchased credits (never expire), monthly credits (each with its expiry) and the legacy plan allowance. reserved is held by calls and jobs still running.

Responses

200
The wallet.
Show schema

CreditBalanceResponse

Errors

400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.

curl "https://app.owlbound.ai/api/v1/credits" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

Ledger

credits.ledger.list

List the workspace's credit ledger, newest first.

get/api/v1/credits/ledger
Scope
read
Credits
Free
Idempotency-Key
Not used

Every debit and credit of the wallet. Filter by meter and source. API charges carry the call's requestId. Cursor-paginated; with both filters, pages may be short (hasMore is the only end signal).

Parameters

  • limitqueryinteger

    Page size.

    default 50min 1max 200
  • cursorquerystring

    Opaque cursor from meta.page.nextCursor. Reusing it with other filters is 400 CURSOR_MISMATCH.

  • meterquerystring
    workdataruntimevendor
  • sourcequerystring
    agentplaybuilderconnectorenrichmentapiadmin

Responses

200
One page of ledger entries.
Show schema

CreditLedgerListResponse

Errors

400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.

curl "https://app.owlbound.ai/api/v1/credits/ledger" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

Costs

credits.costs.list

The price list, for estimates.

get/api/v1/credits/costs
Scope
read
Credits
Free
Idempotency-Key
Not used

Server prices in credits (1 credit = $0.01 list value) for every priced capability, including the priced API operations (operations, each with its own price). Prices are computed by Owlbound when a call runs; this list is for estimates before a call.

Responses

200
Every priced capability, sorted by id.
Show schema

CreditCostListResponse

Errors

400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.

curl "https://app.owlbound.ai/api/v1/credits/costs" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

Models on this page

Shared objects the operations above link to. Clients must ignore fields they do not know.

CreditBalanceobject

The workspace's credit wallet.

  • availablenumberrequired

    Spendable now (buckets minus debt); negative while in debt.

    0
  • purchasednumberrequired

    Purchased credits left. They never expire.

    0
  • monthlyarray of objectrequired

    Monthly credit grants still active, each with its expiry.

    0
    + Show child fields
    • grantedCreditsnumberrequired
      0
    • remainingCreditsnumberrequired
      0
    • expiresAtnumberrequired
      0
  • planAllowanceobjectrequired

    Legacy plan allowance for this month (0 for pay-as-you-go).

    0
    + Show child fields
    • totalnumberrequired
      0
    • usednumberrequired
      0
    • remainingnumberrequired
      0
    • expiresAtnumberrequired
      0
  • debtnumberrequired

    Spend not covered by the wallet, repaid by the next grant.

    0
  • reservednumberrequired

    Held by calls and jobs still running.

    0
  • unlimitedbooleanrequired

    Usage is recorded but not drawn from the wallet.

    0
ResponseMetaobject

Metadata on every success response.

  • requestIdstringrequired
    0
  • creditsCreditsMetarequired
    0
  • pagePageMeta

    Cursor pagination. hasMore is the only end signal; pages may be short.

    0
  • dryRunboolean

    True only on a dry-run response (action operations).

    0
CreditsMetaobject
  • usednumberrequired

    Credits charged by this request. Reads are free.

    0
  • balancenumber
    0
  • estimatednumber

    Dry run only (action operations).

    0
  • availablenumber

    Dry run only (action operations).

    0
  • reservationIdstring | null

    Async operations only; the job settles this reservation.

    0
PageMetaobject

Cursor pagination. hasMore is the only end signal; pages may be short.

  • nextCursorstring | nullrequired
    0
  • hasMorebooleanrequired
    0
  • limitintegerrequired
    min 1max 200
CreditLedgerEntryobject

One debit or credit of the wallet.

  • idstringrequired
    0
  • directionstringrequired
    debitcredit
  • sourcestringrequired
    agentplaybuilderconnectorenrichmentapiadmin
  • meterstringrequired
    workdataruntimevendor
  • capabilityIdstringrequired
    0
  • labelstringrequired
    0
  • creditsnumberrequired
    0
  • statusstringrequired
    estimatedcompletedfailedrefundedadjusted
  • requestRefstring | nullrequired

    Opaque, stable id of the charge's logical request; entries of one charge share it.

    0
  • requestIdstring | nullrequired

    The X-Request-Id of the API call that was charged.

    0
  • createdAtnumberrequired
    0
PagedResponseMetaobject

Metadata on a paginated success response.

  • requestIdstringrequired
    0
  • creditsCreditsMetarequired
    0
  • pagePageMetarequired

    Cursor pagination. hasMore is the only end signal; pages may be short.

    0
CreditCostobject

The server price of one capability.

  • capabilityIdstringrequired
    0
  • labelstring | nullrequired
    0
  • creditsnumberrequired

    Flat price, or the base when perUnitCredits is set.

    0
  • perUnitCreditsnumber | nullrequired

    Added per unit (record, page, row).

    0
  • usageTypestring | nullrequired
    ai_workdatasending
  • operationsarray of objectrequired

    API operations charged under this capability, each with its own price.

    0
    + Show child fields
    • operationIdstringrequired
      0
    • creditsnumberrequired

      Per call.

      0
    • perUnitCreditsnumber | nullrequired
      0
    • unitstring | nullrequired
      0

← All operations