Skip to main content
bidiDocs Dashboard

API reference

Usage

This month's conversations against the allowance.

All endpoint groups

GET /usage

This month's usage

The workspace's pool (the plan's conversations plus this month's top-ups, shared by every agent) and, per agent, what it counted and its messages, for the current month in UTC. A conversation is counted once, on its first answered message, on any channel.

Scope: usage:read

Returns Usage

  • month required string

    The first day of the month, UTC.

  • plan optional string

    Plan

  • conversations_per_agent optional integer

    Deprecated name: the plan's monthly conversations, one pool for the whole workspace (see pool), not an allowance per agent.

  • pool optional UsagePool
  • agents required AgentUsage[]

    Agents

Responses

  • 200 Successful Response
  • 401 Missing, invalid, revoked or expired key. Leaving the workspace, or being removed from it, revokes the keys a teammate made; a key whose maker's membership ended any other way answers key_maker_left.
  • 403 The plan has no API, the key lacks the scope, or the role of the teammate who made the key no longer allows it (maker_role_limit; a publishable key says insufficient_scope).
  • 404 Nothing by that id in this workspace.
  • 413 The request body is larger than this route accepts (1 MB; 3 MB for a text source). On a source: plan_text_limit, the agent's plan cannot hold more text (limit_chars, used_chars).
  • 422 The request did not validate; details lists the fields.
  • 429 Rate limit reached; wait Retry-After seconds.
  • 500 Our fault; quote request_id to support.
curl
curl https://www.bidii.ai/api/v2/usage \
  -H "Authorization: Bearer bidi_sk_YOUR_KEY"