Use Gauge with AI tools
Give your AI assistant the Gauge docs, in the formats it reads best.
Coding assistants write better integrations when they read the real docs instead of guessing. These docs are published in forms AI tools can read directly.
Give your assistant the docs
/llms.txt | An index of every page with a one-line summary, following the llms.txt convention. Point an assistant here first. |
/llms-full.txt | Every guide in one plain-text file. Paste it, or attach it, as context. |
/openapi/v2.json | The exact OpenAPI 3.1 document: every endpoint, schema, scope and error. |
| Copy page | The button at the top of every page copies it as Markdown. Open sends it to ChatGPT or Claude. |
A prompt that works well:
Read https://docs.gauge.chat/llms.txt and https://docs.gauge.chat/openapi/v2.json. Using plain
fetch(no SDK), write a Node function that sends a WhatsApp message with the Gauge API, with anIdempotency-Key, and retries on 429 usingRetry-After.
Keep keys out of prompts
Never paste an API key or a webhook signing secret into an AI tool. Use an environment variable
(GAUGE_API_KEY) in the code it writes, and set the value yourself.
Coming next: a Gauge MCP server
Coming soonThe Model Context Protocol lets AI assistants call tools directly. A Gauge MCP server is planned. It will be generated from the same OpenAPI document as this reference, and will be read-only by default: an assistant could look up conversations, contacts and connections with your key, and could only send when you grant it a key with write scopes.
Until then, the files above give an assistant everything it needs to write the integration with you.
Support embed S1: the API core
This page is the reference for the console UI lane and for integrators. Machine truth lives in GET /openapi.json, and the zod sources are in packages/types/src/support-embed.ts,…
Changelog
What changed in the Gauge API, newest first. Additive changes, new endpoints, and anything you need to act on.