Developers · Agents

Everything machine-readable, in one place.

AI Broker publishes an agent-readable index, a Markdown representation of every public page, and two embed snippets a brokerage's own site can paste. This page is the index of all of it, including the parts that do not exist yet and how to ask for them.


01Agent-readable files

Read the site without parsing it.

Four files describe this site to a machine. None of them need a key, and none of them are behind a crawl delay that matters.

llms.txt is the index: what the product does, who it is for, the regulatory position, and a link to every public page. It is generated per request, so a newly published article appears in it without anyone remembering to append a line. agents.md is the instruction file: when to use AI Broker, when to point the reader elsewhere, and how to fetch from us.

/llms.txtSite index for language models. Capabilities, published writing, live production figures, contact.
/agents.mdAgent instructions: when to use AI Broker, when not to, and how to call us.
/sitemap.xmlEvery public URL, with change frequency and priority.
/robots.txtCrawl policy. Search and AI assistant crawlers are allowed on everything public.

02Markdown

The same URL, in Markdown.

Every public page serves a Markdown representation from the same URL, negotiated on the Accept header per the acceptmarkdown.com convention. Ask for text/markdown and you get the page body without nav, scripts or layout wrappers; ask for text/html and nothing changes.

Responses carry Vary: Accept, so a CDN cannot hand an agent’s Markdown to a browser or the reverse. A client that accepts neither representation gets an honest refusal rather than a silent fallback: HTTP 406, listing what is available. A path that does not exist returns a real 404 with a Markdown body pointing at the site map.

If your client does not negotiate on Accept, append .md to any path instead. The home page is /index.md.

curl -s -H "Accept: text/markdown" https://www.aibroker.ie/features/radar
curl -s https://www.aibroker.ie/features/radar.md
curl -sI -H "Accept: text/markdown" https://www.aibroker.ie/security | grep -i -E "content-type|vary"

Markdown responses are edge-cached for five minutes and carry the page title, description and canonical URL as YAML front matter.


03Embed

Put Aoibhe on your own site.

The chat widget is one script tag. It takes your tenant slug and a publishable embed key, both issued from your AI Broker settings, and mounts a launcher that talks to your brokerage’s own configuration. An embed key is scoped to an explicit list of origins — an empty list denies every request rather than allowing all of them — and it can be revoked, so a key scraped off your page is a key you turn off.

The script served at /embed.js is a loader: it injects the SDK bundle and forwards the data attributes. Point data-ai-broker-base-url at a different host only if you are testing against a non-production deployment.

<script src="https://www.aibroker.ie/embed.js"
  data-ai-broker-tenant="YOUR_TENANT_SLUG"
  data-ai-broker-embed-key="YOUR_EMBED_KEY"
  async></script>

04Forms

A proposal form, embedded.

Any form built in AI Broker can be hosted by us on a white-label page and shared by link or QR code, or embedded into your own page with a second snippet. Replies fold back into the same conversation as the rest of the client’s thread, so an embedded form is not a separate inbox to check.

The embed takes the form’s public id and the same embed key as the widget.

<div
  data-aoibhe-form="FORM_PUBLIC_ID"
  data-aoibhe-embed-key="YOUR_EMBED_KEY"
></div>
<script src="https://www.aibroker.ie/embed-form.js" async></script>

05API access

What we have not published.

There is no public REST API and no OpenAPI specification today. The API behind the product authenticates per brokerage and is not offered to third parties, and publishing a spec for endpoints nobody outside the product can call would be marketing rather than documentation.

There is no MCP server today either. If you are integrating a brokerage’s own systems and need programmatic access — a book export, a webhook on a task, a write path from your own software — write to support@aibroker.ie with the shape of the integration and we will tell you honestly whether it exists, is planned, or is not something we will build.

Developer and agent resources — AI Broker