## Overview

Conversa Labs publishes a **complete API reference** in **OpenAPI 3.1** format, generated
automatically from the product's real routes. It covers **every module** — conversations, contacts,
CRM, catalog, payments, calendar, tasks, follow-ups, sales and gamification, WhatsApp and much more —
and stays in sync with the API on every build.

There are two ways to view the same reference:

- **ReDoc (reading)** — a navigable documentation, organized by groups and tags, ideal to understand
  each endpoint's contract: <https://app.conversalabs.com.br/swagger>
- **Swagger-UI (interactive)** — the same reference with a **"Try it out"** button to make real API
  calls right from the browser: <https://app.conversalabs.com.br/swagger/ui.html>
- **OpenAPI definition (JSON)** — the raw file to import into Postman, Insomnia or to generate SDKs:
  <https://app.conversalabs.com.br/swagger/swagger.json>

## Prerequisites

- A valid **access token** (generated in your profile/account). See the REST API and tokens article.
- A modern browser. To test calls, prefer a token from a test environment.

## Step by step

1. Open the reference at <https://app.conversalabs.com.br/swagger> (ReDoc) and browse the module
   groups in the sidebar.
2. Find the endpoint you need (by method and path) and read its parameters, body and responses.
3. To **test**, open the interactive reference at
   <https://app.conversalabs.com.br/swagger/ui.html>.
4. Click **Authorize** and enter your token in the **`api_access_token`** header.
5. Pick an endpoint, click **Try it out**, fill in the parameters and click **Execute**.
6. Review the response (status, body) and reuse the generated request example (cURL) in your integration.

## Settings & options

- **Auto-generation**: the reference is built from introspecting the application's real routes, so new
  endpoints show up automatically.
- **Authentication**: all authenticated endpoints use the **`api_access_token`** header.
- **Availability**: on self-hosted installs, the docs are **enabled by the operator** via an
  environment variable (`ENABLE_API_DOCS`). On hosted Conversa Labs they're already available at the
  URLs above.

## Use cases

- Quickly discover which endpoints exist for a module (CRM, Payments, Catalog, etc.).
- Test a call with your token before writing it in code.
- Import the OpenAPI definition into Postman/Insomnia or generate a client SDK.

## Tips, limits & best practices

- Treat the token as a secret — never share it or expose it in the front-end.
- For testing, use a minimal-scope token and, ideally, one from a test environment.
- Respect rate limits and handle 429/5xx errors with backoff.

## Troubleshooting

- **The page doesn't open (404)**: the docs may be disabled in that environment — the operator
  enables them with `ENABLE_API_DOCS`.
- **401/403 when testing**: the token is invalid or lacks permission; generate a new one and check the scope.
- **An endpoint is missing**: it may require a module/feature that isn't enabled on your account.

## See also

- [Dashboard Apps SDK, REST API and MCP](/hc/ajuda/articles/api-developers-dashboard-apps-sdk-rest-mcp-en)
- [REST API, tokens and webhooks](/hc/ajuda/articles/api-developers-rest-tokens-webhooks-en)
- [API & Developers overview](/hc/ajuda/articles/api-developers-overview-en)
- [Per-module events](/hc/ajuda/articles/api-developers-eventos-por-modulo-en)