Start

bidi developer docs

Build on bidi from your own code: the API, webhooks, the website widget, identity, the hosted page, mobile SDKs, the CLI and no-code tools.

Start here

Everything here works with one workspace API key from Settings > Developers in your dashboard, on the Team plan and up. The website widget, the hosted page and the installs need only your assistant's public key.

Start

Getting started

Your key, the base URL and seven calls from listing your agents to reading this month's usage, then the rules every call follows.

Start

API keys and scopes

Secret keys for your server, publishable keys for your apps, and the scopes that limit what each key can do.

API reference

Every endpoint of API v2, written from the live OpenAPI document: parameters, bodies, what each returns and the scope it needs.

Events

Webhooks

Signed events posted to your endpoint as things happen: the envelope, every event, checking the signature, retries and testing.

Your website

Widget JavaScript API

Drive the chat widget from your own page: open and close it, set opening lines, hear what is said, register tools and read campaigns.

Your website

Identity verification

Let your server vouch for a signed-in visitor with a JWT or an HMAC hash, so your team sees a verified contact and the assistant remembers them.

Your website

Hosted page and iframe

A chat page of its own for every assistant, a link and a QR code to share, and the same chat inside an iframe on your website.

Your website

WordPress and Shopify

Put the chat on a WordPress site with the bidi Chat plugin, on a Shopify store with its app embed, or on any site with one line.

Apps and tools

iOS and Android SDKs

A Swift package and a Kotlin library that put your assistant inside your own app, with a chat screen that reads Arabic right to left. Source only for now.

Apps and tools

CLI and MCP server

bidi on your own machine: a command line for terminals and scripts, and an MCP server that hands the same operations to an AI client.

Apps and tools

Zapier and Make

Connect bidi to thousands of apps without code: new leads, tickets and form submissions as triggers, contacts and messages as actions.

The essentials

Every call goes to one base URL with your key as a bearer token, and answers JSON. Every answer carries X-Bidi-Api-Version, the date of the contract you are on.

HTTP

GET https://www.bidii.ai/api/v2/me
Authorization: Bearer bidi_sk_YOUR_KEY

HTTP/1.1 200 OK
Content-Type: application/json
X-Bidi-Api-Version: 2026-10-01

In English and Arabic

Every page of these docs is in English and in Arabic. The API answers its error messages in Arabic when you send Accept-Language: ar, and everything your visitors write arrives exactly as they wrote it.

Need a hand?

Write to us from the contact page and quote the request_id of the call that surprised you: it lets us find it at once.