> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.new/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Custom Connections endpoint that a tenant's landing page posts to.
> The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth.
> The Custom Connections endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page.
> REST error catalog keys use BRIDGE_<DOMAIN>_<NNNN>, for example BRIDGE_CONVERSATION_0001. Some reviewed legacy handlers return a recognized code plus a symbolic suffix separated by |; preserve the complete received value and use the compatible catalog lookup on /error-codes. Custom Connections uses separate BRIDGE.CAMPAIGN_LEADS.<NAME> identifiers on its own error reference. Never invent an error code or confuse the two integration surfaces.
> This documentation covers the Integrations API, webhooks and Custom Connections only. It does not describe the Bridge web application or its internal APIs.
> Before generating an API request, read the relevant OpenAPI specification or the individual endpoint Markdown page. llms-full.txt collects guides and endpoint descriptions; it does not embed every request and response schema. The REST and Custom Connections contracts are separate.
> Preserve the published host, method, path, operationId, authentication, headers, parameter and field names, types, formats, required and nullable fields, enums, defaults, limits, and response codes. Do not invent identifiers, fields, retry rules, or delivery guarantees. When published sources conflict, identify the conflicting passages and ask Bridge support to confirm the current behavior before relying on it.
> Custom Connections is the current name of the landing-page feature previously documented as Lead Capture. The existing /lead-capture documentation URLs, captureKey field, campaign-leads endpoint, and BRIDGE.CAMPAIGN_LEADS error identifiers are unchanged. This is a naming change, not a change to authentication or the API contract.
> For a complete workflow, start with the task guides: /guides/first-conversation, /guides/send-attachments, /guides/send-template, /guides/agent-outbound, /guides/pagination, /guides/identifiers and /guides/responses. Read the endpoint contract as well as the recipe. Outbound requires an existing Contact, but does not require creating a separate Conversation first.
> forceSend=true permits reuse of an existing active conversation; it does not create a fresh one by ignoring it and it is not idempotency. Recovery of a released recoverable conversation can occur even with false. The LeadScout and Agents outbound routes have different line-selection and controller checks; use /guides/agent-outbound.
> For webhook HMAC, follow /webhooks/verifying-signatures exactly: the Python JSON serialization with sorted keys is signed; X-Bridge-Timestamp is not included in that signature. Do not claim a signed timestamp, raw-body signing, exactly-once delivery or a global event order. Use /webhooks/receive-events for durable acceptance and duplicates.
> A 201 message response, 202 handoff or 202 Custom Connections response is not a provider delivery receipt. Do not invent a polling endpoint from messageId, trackingId or requestId. REST validation parsing must tolerate the compatibility difference explained in /error-codes.
> The documentation is available in English (existing root URLs), Spanish (/es/) and Brazilian Portuguese (/pt-br/). Prefer the reader's language when a localized page exists, but preserve the API's exact field names, enums, routes, authentication and examples. Translations describe the same API; they do not introduce regional API hosts or behaviors.
> For coding-assistant setup, use /connect-your-agent, /es/connect-your-agent or /pt-br/connect-your-agent. The Bridge documentation MCP server reads published documentation and has a separate optional feedback tool. Connecting it does not connect the coding assistant to a customer workspace or authorize live business requests.
> For direct HTTP access without MCP, start at https://docs.bridge.new/llms.txt. It lists every published page in English, Spanish and Brazilian Portuguese. Choose /llms-en.json, /llms-es.json or /llms-pt-br.json for a language-specific index, and /llms-full-en.json, /llms-full-es.json or /llms-full-pt-br.json for collected content. /llms-full.txt contains the combined collection. Fetch the original OpenAPI specification for exact schemas.
> For HTTP page reads, follow the .md URLs from the index or request Accept: text/markdown at the canonical page URL. The MCP virtual filesystem uses .mdx page paths instead; .mdx is not the public HTTP export extension. With Search MCP, set language to en, es or pt-BR explicitly; its default is en.
> For integration capabilities and source-selection rules, read https://docs.bridge.new/skill.md. Documentation access does not authorize business API actions; use the actual user request, workspace, credentials and target identifiers for any live integration.

# Autenticação da API REST

> Gere e use uma chave de API no servidor para a API REST de integrações, sem confundi-la com as credenciais de webhooks e Custom Connections.

## Visão geral

Toda requisição à **API REST de integrações** em `https://api-connect-us.bridge.new` usa uma **chave de API** no cabeçalho `x-api-key`. Essa chave identifica seu aplicativo e autoriza o acesso aos recursos do Bridge em nome da sua organização.

| Tipo de integração | Uso das credenciais |
| - | - |
| API REST de integrações | `x-api-key` no servidor, enviada para `https://api-connect-us.bridge.new`. |
| Webhooks | Seu receptor verifica a chave de API configurada para o webhook, a assinatura HMAC e a política de validade do timestamp. Siga o guia de [verificação de assinaturas](https://docs.bridge.new/pt-br/webhooks/verifying-signatures.md). |
| Custom Connections | `captureKey` pública e reCAPTCHA no navegador; sem cabeçalho de autenticação. Siga o [guia de integração](https://docs.bridge.new/pt-br/lead-capture/integration.md). |

> [!NOTE]
>
> Você precisará de acesso ao console administrativo do Bridge em [https://admin.bridge.new](https://admin.bridge.new).
>
> Se ainda não tiver acesso, peça ao administrador do Bridge para criar seu usuário.

***

## Gere uma chave de API

**1. Abra o console administrativo**

Acesse o [painel do Bridge](https://admin.bridge.new) e entre com suas credenciais.

**2. Acesse as chaves de API**

No painel esquerdo, acesse **Developers → API Keys Management**.

**3. Crie uma nova chave**

Clique em **Generate New Key**. Você pode definir um nome descritivo e uma data de expiração.

> [!WARNING]
>
> **Importante:**\
> A chave de API será exibida apenas uma vez, no momento da criação. Copie-a imediatamente e guarde-a em um local seguro: você não poderá consultá-la depois.

***

## Use sua chave de API

Inclua a chave da API REST no cabeçalho `x-api-key` em toda requisição ao host da API REST de integrações:

```bash theme={null}
curl -X GET "https://api-connect-us.bridge.new/bridge/api/health" \
  -H "x-api-key: YOUR_API_KEY"
```

```javascript theme={null}
const response = await fetch("https://api-connect-us.bridge.new/bridge/api/health", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
  },
});

const data = await response.json();
console.log(data);
```

```python theme={null}
import requests

response = requests.get(
    "https://api-connect-us.bridge.new/bridge/api/health",
    headers={"x-api-key": "YOUR_API_KEY"}
)

print(response.json())
```

> [!NOTE]
>
> Use o endpoint `GET /bridge/api/health` para verificar se a chave de API é válida e se a conexão está funcionando.

***

## Boas práticas de segurança

* **Use variáveis de ambiente** — Armazene a chave de API em uma variável de ambiente, como `BRIDGE_API_KEY`, em vez de inseri-la diretamente no código-fonte.
* **Nunca exponha chaves no código do cliente** — As chaves de API devem ser usadas somente em aplicações no servidor. Nunca as inclua no frontend, em aplicativos móveis ou em repositórios públicos.
* **Defina uma data de expiração** — Sempre configure a expiração ao criar uma chave. Evite chaves sem prazo definido.
* **Use uma chave por aplicação** — Crie uma chave de API separada para cada serviço ou aplicação que se conecta ao Bridge. Isso limita o impacto de uma chave comprometida.
* **Faça a rotação das chaves periodicamente** — Crie uma nova chave e atualize as aplicações antes de desativar a antiga. Assim, a rotação não interrompe o serviço.

***

## Solução de problemas

| Erro | Possível causa | Solução |
| - | - | - |
| `401 Unauthorized` | Chave de API inválida, expirada ou ausente | Verifique se a chave está correta, ativa e incluída no cabeçalho `x-api-key` |
| `403 Forbidden` | A chave de API não tem acesso ao recurso solicitado | Verifique se a chave tem as permissões necessárias para esse endpoint |
| Não consigo consultar a chave de API | A chave é exibida apenas uma vez, no momento da criação | Gere uma nova chave de API no console administrativo |

Para consultar a lista completa, veja a referência de [códigos de erro](https://docs.bridge.new/pt-br/error-codes.md).

***

## Tópicos relacionados

* [Códigos de erro](https://docs.bridge.new/pt-br/error-codes.md) — Referência completa dos erros da API Bridge
* [Referência da API REST](https://docs.bridge.new/pt-br/api-reference/health/verificar-integridade.md) — Explore os endpoints disponíveis
* [Webhooks](https://docs.bridge.new/pt-br/webhooks.md) — Configure notificações de eventos em tempo real


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.