Skip to main content
bidiDocs Dashboard

API reference

Account

The key you are calling with and the workspace it belongs to.

All endpoint groups

GET /me

The calling key

What the API knows about the key you sent: its label, scopes, allowlist and expiry, and the workspace it belongs to with its plan. workspace.id is the id webhook events carry as workspace_id. A key follows the role of the teammate who made it: key.maker says what that role holds back now (the keys of a teammate who left the workspace are revoked, or answer 401 key_maker_left). A cheap first call.

Any key

Returns Me

  • api_version required string

    Api Version

  • key required KeyInfo
  • workspace required WorkspaceInfo

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/me \
  -H "Authorization: Bearer bidi_sk_YOUR_KEY"