Agents
Your live assistants: list them, read one and update the websites it answers on.
API reference
API reference
Every endpoint of API v2, written from the live OpenAPI document. The endpoints' own descriptions are in English.
The API at a glance
API v2 is plain JSON over HTTPS, one bearer key per call, cursor pagination, one error shape and server-sent events for streamed chat. The contract is dated 2026-10-01; changes inside v2 only add.
- Base URL:
https://www.bidii.ai/api/v2 - Contract version:
2026-10-01 - Download openapi.json
Pagination, errors, rate limits, idempotency and versioning are explained in Getting started; the scopes in API keys and scopes.
Endpoint groups
Sources
What an agent has read, and giving it text, a sheet or questions and answers to read.
Chat
One guarded turn with an agent, as plain JSON or streamed as server-sent events, and the answers to client tools.
Conversations
What visitors and the API said, with outcomes, sources and campaigns.
Leads
People who left their details, where they stand, and an agent's own lead fields.
Tickets
The helpdesk's tickets: whose move it is, who has it, and closing it.
Contacts
The people the workspace knows: their details, attributes and whether your site verified them.
Actions
What an agent can do beyond answering, and what its forms gathered.
Usage
This month's conversations against the allowance.
Webhook subscriptions
Subscribing an endpoint to events from your own code (REST hooks), as Zapier and Make do.
Account
The key you are calling with and the workspace it belongs to.