# Chatfuel Docs API

> Read-only HTTP API over the Chatfuel Help Center and the Chatfuel Public API (GraphQL) reference. No key, no sign-in. Answers are Markdown (add `format=json` for JSON), and every link in them is absolute and ready to open.

Use it to answer questions about Chatfuel (WhatsApp, Instagram, Facebook Messenger, TikTok and website chat automation with an AI Agent) and to write code against the Chatfuel Public API. It reads documentation only: it cannot see or change anyone's bots. To work with the user's own bots, connect the Chatfuel MCP server `https://mcp.chatfuel.com/panel`: https://chatfuel.com/docs/mcp/how-to-connect-chatfuel-to-ai-assistants-with-mcp

## How to use it

1. Search: `GET https://chatfuel.com/docs/api/v1/search?q=<words>`. Each result has the page URL and up to three matching sections, each with a `section` link that returns only that section as Markdown.
2. Open what you need: a section (cheapest), or the whole page with its `markdown` link.
3. For an API operation, open `GET https://chatfuel.com/docs/api/v1/operations/<name>`: its signature, the lowest role that may call it, its errors and the whole reference section with an example request. Names are camelCase; fields of `Bot` are written `Bot.<field>`.
4. Before writing API code, read Authentication, Requests and Errors (links below).
5. Cite canonical help center URLs (`https://chatfuel.com/docs/...`), not API URLs.

## Endpoints

All are `GET`, return `text/markdown` (or JSON with `format=json`) and take `lang`: `en` (default), `es` or `pt`.

### Search the help center and the API reference

`https://chatfuel.com/docs/api/v1/search?q=<words>&section=<help|developers>&limit=<1-20>`

- `q`: words, a question or an operation name.
- `section`: `help` for help articles, `developers` for the Public API and Chatfuel MCP. Default: both.
- `limit`: pages to return, default 8.

Examples:
- https://chatfuel.com/docs/api/v1/search?q=send+a+WhatsApp+template
- https://chatfuel.com/docs/api/v1/search?q=contacts+segment&section=developers
- https://chatfuel.com/docs/api/v1/search?q=plantilla+de+WhatsApp&lang=es

### List API operations

`https://chatfuel.com/docs/api/v1/operations?q=<words>&kind=<query|mutation|subscription>`

Every query, mutation and subscription of the Public API with its role and a one-line description. `q` filters by name and description, every word must match.

Examples:
- https://chatfuel.com/docs/api/v1/operations?q=booking&kind=mutation
- https://chatfuel.com/docs/api/v1/operations?kind=subscription

### Get one operation

`https://chatfuel.com/docs/api/v1/operations/<name>`

Signature, kind, role, errors and the reference section that defines it (schema excerpt, example request, notes), plus the other operations on that page. An unknown name answers 404 with the closest names.

Examples:
- https://chatfuel.com/docs/api/v1/operations/contactsConnection
- https://chatfuel.com/docs/api/v1/operations/Bot.contactsCount

### Get a page or one section of it

`https://chatfuel.com/docs/api/v1/page?path=<slug or URL>&section=<heading id>`

`path` is a slug like `whatsapp/24-hour-messaging-window` or any help center URL (an `#anchor` in it selects the section). Without `section`, the whole page. JSON answers list the page's sections.

Examples:
- https://chatfuel.com/docs/api/v1/page?path=public-api/authentication
- https://chatfuel.com/docs/api/v1/page?path=public-api/requests
- https://chatfuel.com/docs/api/v1/page?path=public-api/errors
- https://chatfuel.com/docs/api/v1/page?path=public-api/contacts&section=how-to-filter-contacts-with-segments

## Other ways in

- OpenAPI 3.1 description of these endpoints (for ChatGPT GPT Actions and tool builders): https://chatfuel.com/docs/api/openapi.json
- Every article with a one-line summary: https://chatfuel.com/docs/llms.txt (Spanish: https://chatfuel.com/es/docs/llms.txt, Portuguese: https://chatfuel.com/pt/docs/llms.txt)
- The whole help center in one file: https://chatfuel.com/docs/llms-full.txt
- Any article as Markdown: add `.md` to its URL.
- Human-readable version of this guide: https://chatfuel.com/docs/public-api/docs-api

## Product vocabulary

"AI Agent" is the AI that talks to customers; the articles call it "Fuely AI". "Automations" (Fuely AI → Automations) hold its settings. The "AI Co-pilot" (called "AI Co-Worker" in the articles) is the in-product assistant that changes settings for the user. Prices, limits and Meta policies change: prefer recent `last_updated` dates and say when a fact is dated.