BrightshoalRequest a demo

Build on Brightshoal.

Everything in your console is in the API. Work from a terminal with the CLI, or let Claude, Codex and other AI clients use your account through our MCP server, always with your permissions and your approval.

The API. The same operations the console uses.

Create API keys per project with the role they need, send chats and forms in, and get every new lead, chat, call and form out through webhooks.

API referenceGuides and quickstart
$ curl https://api.brightshoal.si/api/projects \
    -H "Authorization: Bearer $BRIGHTSHOAL_API_KEY"

The CLI. Your account, from a terminal.

  • It acts as you

    brightshoal login opens your browser once. The token carries your own role, so a viewer can only view, and no shared key is passed around.

  • Changes ask first

    Every change needs --yes, and deleting something needs its id typed again. Ids you mark as protected are refused outright.

  • Built for agents

    JSON output, typed commands for every API route, and clear exit codes, so Claude Code, Codex and your scripts can use it safely.

The CLI is shared with customers on request. Ask us for it.

$ brightshoal login
  your code:  BCDF-2345
  approve it in your browser…
  logged in as you@company.com

$ brightshoal tree
  project prj_51a2  "Website"  1 site key(s), 1 sandbox key(s)
    assistant asst_0123  "Front desk"  v4

$ brightshoal assistants pull asst_0123 --draft
$ brightshoal assistants diff asst_0123
$ brightshoal assistants publish asst_0123 --yes

The MCP server. Brightshoal inside your AI assistant.

  • You choose what it gets

    Sign in, pick the organisation, and untick any permission you do not want the client to have.

  • Every change waits for you

    Reads run straight away. Every change, even a draft, opens a review in your console, and runs only once you approve it there.

  • Wide, with clear limits

    Leads, conversations, assistants, knowledge, bookings, chat analytics and Search. Keys, users, payments and outbound sending stay out.

  • Yours to switch off

    Disconnect a client in Settings and its access ends at once.

Claude Code

$ claude plugin marketplace add piyush-gambhir/brightshoal-plugins
$ claude plugin install brightshoal@brightshoal

Codex, then install Brightshoal from /plugins

$ codex plugin marketplace add piyush-gambhir/brightshoal-plugins

Any other AI client, as a remote MCP server

https://api.brightshoal.si/mcp

The plugin only adds the connection: no skills or local code. The first time it runs, your client opens Brightshoal to sign in.

Put it to work on Search. Your coding agent takes the Beacon’s To do list and makes the changes in your code.

Meet all nine agents