buzzabout docsAccount (me)
Two endpoints — current account / plan / seats, and a paginated usage-history feed.
The me endpoints describe the calling seat — its account, plan,
feature gates, balance, and a chronological feed of credit charges /
refunds.
Pricing
Free — no credits charged. See
Pricing for the four chargeable
categories that show up on usage_history.
Endpoints
Authorization
ApiKeyAuth Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).
In: header
Response Body
application/json
curl -X GET "https://example.com/v1/me"{
"status": "info",
"data": {
"account_id": "acc_01HZ456",
"created_at": 1717200000,
"email": "person@example.com",
"id": "user_01HZ123",
"members": [
{
"email": "person@example.com",
"name": "Person Surname",
"type": "member",
"user_id": "user_01HZ123"
},
{
"email": "newhire@example.com",
"type": "invitation"
}
],
"name": "Person Surname",
"plan": {
"features": {
"api_access": true,
"audience_research": true,
"csv_export": true,
"custom_date_filter": true,
"daily_digest": true,
"digest_webhook": false,
"mcp": true,
"multisource_research": true,
"webhooks": true
},
"limits": {
"max_research_depth": 50,
"num_seats": 3,
"parallelism": 4,
"projects": 5,
"tracking_agents": 10
},
"name": "Pro",
"type": "pro"
},
"team_name": "Acme",
"teams": [
{
"account_id": "acc_01HZ456",
"name": "Acme"
}
],
"usage": {
"credits_total": 5000,
"credits_used": 1234,
"renews_at": 1748736000
}
}
}Authorization
ApiKeyAuth Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).
In: header
Query Parameters
251 <= value <= 100Response Body
application/json
application/json
curl -X GET "https://example.com/v1/me/usage_history"{
"status": "info",
"data": [
{
"category": "mention",
"created_at": 1717200000,
"id": 9183271,
"quantity": 0.5
}
],
"has_next": true,
"cursor": "string"
}{
"status": "info",
"error_code": "invalid_cursor",
"detail": "string",
"transient": true
}What /v1/me returns
The response carries:
- Identity —
id,account_id,email,name,team_name. members[]— current team roster, each entry tagged asmember(joined) orinvitation(pending).teams[]— every account the seat is a member of (in case they belong to multiple teams).plan—{ name, type, features, limits }. Useplan.features.{api_access, mcp, webhooks, ...}for feature gates andplan.limits.{num_seats, tracking_agents, projects, ...}for numerical caps.balance— current credit balance.
Usage history
GET /v1/me/usage_history is cursor-paginated. Each row carries a
category, the endpoint that produced the charge, and the delta in
credits (positive for charges, negative for refunds).
The category vocabulary is the four
public categories — mention,
audience_profile, post_processing, ai_assistant — plus any
legacy in-app strings (REPORT, AUDIENCE_RESEARCH, TRACKING)
that appear on rows pre-dating the public surface.
Per-seat breakdown is account-wide
Usage history is reported at the account level — every seat sees the same feed. Per-seat breakdowns will land via a dedicated audit endpoint in a future revision.
Next steps
- Pricing — the four chargeable categories.
GET /v1/credit_prices— current unit prices.