buzzabout docs
Getting started

Pricing

How buzzabout charges per API call — a dollar balance, four categories, all per-result and all reservation-based.

buzzabout charges US dollars per result, not per request. Your account holds a balance in dollars, and every chargeable call debits it. The four public categories below cover every chargeable endpoint and MCP tool. Asking the assistant (POST /v1/ask and the buzzabout__ask MCP tool) is free.

Credits have been removed

buzzabout used to bill in credits. It now bills in dollars, and the credit unit is gone from the product and from this API — there is no deprecation window and no dual-serve. What changed for you:

  • GET /v1/credit_prices is removed, replaced by GET /v1/prices, which returns dollars for your account's rate.
  • On GET /v1/me, usage.credits_used and usage.credits_total are now usage.balance_used and usage.balance_total, in dollars. The old field names are gone, not aliased.
  • GET /v1/me/usage_history still returns a quantity per event — now a dollar amount rather than a credit count.
  • Nothing about how much you get for your money changed. The unit moved; your purchasing power did not.

What an action costs

Every action has a fixed unit ratio — the same for every account. Your account has a rate: the dollars one unit costs on your plan.

price  =  units × your rate
CategoryUnitsWhenReservation-based?
mention1per mention collected (dataset run or tracking-agent re-scrape — unified for clients)yes
audience_profile3per profile collected by an audience-dataset runyes
post_processing0.5per post processed by a custom-parameter run or pattern-detection runyes
preview_generation1per source in a research preview (url previews refund sources that returned no data)yes

A higher plan buys a cheaper unit, so the dollar price of an action depends on your plan. Worked at a 0.007 rate:

CategoryUnitsPrice at a 0.007 rate
mention1$0.007
audience_profile3$0.021
post_processing0.5$0.0035
preview_generation1$0.007

Your own rate and prices are one call away — GET /v1/prices returns both. Plan rates are listed on buzzabout.ai/pricing.

Prices are exact — never round them

A post_processing charge of $0.0035 rounds to $0.00 at two decimals, and a cost estimate built on that is worthless. Prices are returned exactly, to as many decimal places as they need. Carry the full value through your arithmetic and round only when you display a total.

Custom-parameter preview is free, and so is asking the assistant (POST /v1/ask / buzzabout__ask).

Reservation-based charging

Every chargeable category on the public surface is reservation-based, exactly as before — only the unit moved. The endpoint reserves dollars up-front based on the upper-bound result count (e.g. the requested count on a dataset run, the source dataset's mention count for a custom-parameter or pattern-detection run), then refunds the unused remainder when the run completes. At a 0.007 rate, a run that asked for 500 mentions and returned 412 reserves $3.50, settles at $2.884, and the remaining $0.616 goes back to your balance.

A research preview reserves the preview_generation price per source; url previews refund any source that returned no data (private, non-existing, or failed to retrieve).

If a run fails before it can produce results, the full reservation is refunded.

Insufficient balance

Endpoints that would exceed your balance return 402 insufficient_credits before any work starts. Top up via the web app or upgrade your plan; in-flight requests are never partially charged. The 402 error codes keep their existing insufficient_credits* identifiers so your error handling does not have to change — only the amounts in the body are now dollars.

Programmatic access

Your account's price table is available at GET /v1/prices:

curl https://api.buzzabout.ai/v1/prices \
  -H "X-API-Key: $BUZZABOUT_API_KEY"
{
  "status": "success",
  "data": {
    "currency": "usd",
    "rate": 0.007,
    "prices": {
      "mention": 0.007,
      "audience_profile": 0.021,
      "post_processing": 0.0035,
      "preview_generation": 0.007
    }
  }
}

Use this to build cost dashboards, pre-flight budget checks, or to ground a cost-conscious agent's reasoning. Read it rather than hardcoding a number: the values are your account's, and they change if your plan does. The prices map is flat and the keys are stable — new categories ship as additive fields.

Usage history

GET /v1/me/usage_history returns a paginated feed of charges and refunds against your account. Each item carries the category, the endpoint that produced it, and the quantity in dollars. See /v1/me.

The feed may include legacy category strings (ai_assistant, REPORT, AUDIENCE_RESEARCH, TRACKING) for charges that pre-date this surface — those endpoints aren't part of the public API but their history shows up on the same feed. In particular, ai_assistant belongs to the assistant in the previous version of the app; asking the assistant today (POST /v1/ask / buzzabout__ask) is free, so the category appears only on old rows.

Historical rows are in dollars too

Every historical charge was converted to dollars at the account's rate when the migration ran, so the feed is internally consistent — you will not see credit amounts mixed in with dollar amounts. The conversion preserved every balance exactly: the same past spend, the same remaining balance, expressed in a different unit.

Next steps

On this page