> ## 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__, 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. 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. # Criar conversa com identificação flexível de usuários > Cria uma conversa com identificação flexível de usuários. Os usuários externos podem ser identificados por ID, e-mail ou telefone. Usuários internos só são atribuídos quando informados explicitamente; caso contrário, as conversas são distribuídas em rodízio por uma equipe ou ficam abertas para qualquer usuário interno disponível. Quando não há uma linha livre e os Contacts têm uma conversa liberada com exatamente os participantes solicitados, essa conversa é recuperada e retornada, mantendo seu `id` e histórico. O `name` e o `status` da solicitação não são aplicados a ela. ## OpenAPI ````yaml /pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/conversations openapi: 3.1.0 info: title: Bridge API summary: Especificação da API do Bridge para gerenciar o sistema de chat. description: >- Especificação da API REST de integrações do Bridge para gerenciar contatos, conversas, mensagens, arquivos, atributos personalizados, canais de provedores, modelos, usuários internos e Agents. Os webhooks são documentados separadamente em https://docs.bridge.new/pt-br/webhooks; este OpenAPI contém apenas endpoints REST. **Arquitetura multiempresa**: as operações sobre recursos são limitadas a um workspace específico por workspaceId. A verificação de integridade não inclui um workspace no caminho. termsOfService: https://www.sainapsis.com/legal/terms-of-service contact: name: Bridge Support url: https://app.bridge.new/ email: support@sainapsis.com license: name: MIT License url: https://spdx.org/licenses/MIT.html version: 1.0.0 servers: - url: https://api-connect-us.bridge.new description: Servidor de produção security: [] paths: /bridge/api/v1/workspaces/{workspaceId}/conversations: post: tags: - Conversations API summary: Criar conversa com identificação flexível de usuários description: >- Cria uma conversa com identificação flexível de usuários. Os usuários externos podem ser identificados por ID, e-mail ou telefone. Usuários internos só são atribuídos quando informados explicitamente; caso contrário, as conversas são distribuídas em rodízio por uma equipe ou ficam abertas para qualquer usuário interno disponível. Quando não há uma linha livre e os Contacts têm uma conversa liberada com exatamente os participantes solicitados, essa conversa é recuperada e retornada, mantendo seu `id` e histórico. O `name` e o `status` da solicitação não são aplicados a ela. operationId: >- create_conversation_bridge_api_v1_workspaces__workspaceId__conversations_post parameters: - name: workspaceId in: path required: true schema: type: string format: uuid description: Identificador único do workspace (UUID v4). examples: - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234 title: Workspaceid description: Identificador único do workspace (UUID v4). requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConversationRequest' description: Corpo da solicitação para criar uma conversa. responses: '201': description: Resposta bem-sucedida content: application/json: schema: $ref: '#/components/schemas/ConversationResponse' '400': description: Solicitação inválida content: application/json: examples: MIN_PARTICIPANTS_REQUIRED: value: title: Min Participants Required status: 400 code: BRIDGE_CONVERSATION_0210 ONBOARDING_TEMPLATE_NOT_IN_WORKSPACE: value: title: Onboarding Template Not In Workspace status: 400 code: BRIDGE_CONVERSATION_0602 ONBOARDING_TEMPLATE_NOT_APPROVED: value: title: Onboarding Template Not Approved status: 400 code: BRIDGE_CONVERSATION_0603 schema: $ref: '#/components/schemas/Problem' '403': description: Acesso proibido content: application/json: examples: FORBIDDEN: value: title: Forbidden status: 403 code: BRIDGE_CORE_0301 schema: $ref: '#/components/schemas/Problem' '404': description: Não encontrado content: application/json: examples: WORKSPACE_NOT_FOUND: value: title: Workspace Not Found status: 404 code: BRIDGE_WORKSPACE_0001 EXTERNAL_USER_NOT_FOUND: value: title: External User Not Found status: 404 code: BRIDGE_EXTERNAL_0001 INTERNAL_USER_NOT_FOUND: value: title: Internal User Not Found status: 404 code: BRIDGE_INTERNAL_0001 ONBOARDING_TEMPLATE_NOT_FOUND: value: title: Onboarding Template Not Found status: 404 code: BRIDGE_CONVERSATION_0601 schema: $ref: '#/components/schemas/Problem' '409': description: Conflito content: application/json: examples: CONVERSATION_WITH_SAME_PARTICIPANTS_ALREADY_EXISTS: value: title: Conversation With Same Participants Already Exists status: 409 code: BRIDGE_CONVERSATION_0003 EXTERNAL_USER_NOT_IN_WORKSPACE: value: title: External User Not In Workspace status: 409 code: BRIDGE_EXTERNAL_0004 INTERNAL_USERS_NOT_IN_WORKSPACE: value: title: Internal Users Not In Workspace status: 409 code: BRIDGE_INTERNAL_0002 PROVIDER_CHANNEL_NOT_FOUND: value: title: Provider Channel Not Found status: 409 code: BRIDGE_PROVIDER_CHANNEL_0001 EXTERNAL_USER_ALREADY_USE_THIS_CHANNEL: value: title: External User Already Use This Channel status: 409 code: BRIDGE_CONVERSATION_0105 schema: $ref: '#/components/schemas/Problem' '422': description: Conteúdo não processável content: application/json: examples: ONBOARDING_TEMPLATE_MISSING_PARAMETERS: value: title: Onboarding Template Missing Parameters status: 422 code: BRIDGE_CONVERSATION_0604 ONBOARDING_TEMPLATE_UNKNOWN_PARAMETERS: value: title: Onboarding Template Unknown Parameters status: 422 code: BRIDGE_CONVERSATION_0605 ONBOARDING_TEMPLATE_PARAMETERS_NOT_SUPPORTED: value: title: Onboarding Template Parameters Not Supported status: 422 code: BRIDGE_CONVERSATION_0606 ONBOARDING_TEMPLATE_INVALID_PARAMETER_VALUES: value: title: Onboarding Template Invalid Parameter Values status: 422 code: BRIDGE_CONVERSATION_0607 ONBOARDING_CONFIGURED_TEMPLATE_REQUIRES_CALLER_INPUT: value: title: Onboarding Configured Template Requires Caller Input status: 422 code: BRIDGE_CONVERSATION_0608 schema: $ref: '#/components/schemas/Problem' '429': description: Muitas solicitações content: application/json: schema: $ref: '#/components/schemas/Problem' examples: WORKSPACE_BUDGET_EXHAUSTED: value: title: Too Many Requests status: 429 code: BRIDGE_RATE_LIMIT_0001 security: - x-api-key: [] components: schemas: CreateConversationRequest: properties: participants: $ref: '#/components/schemas/CreateParticipantsOnConversationRequest' title: Participants description: Participantes a adicionar à conversa. name: anyOf: - type: string - type: 'null' title: Name description: Nome ou título opcional da conversa. examples: - Bridge Support Team - null status: $ref: '#/components/schemas/ConversationStatus' title: Status description: >- Status inicial da conversa: 'active' para conversas visíveis e 'ghost' para conversas invisíveis até a primeira interação. default: ACTIVE examples: - ACTIVE teamId: anyOf: - type: string format: uuid - type: 'null' title: Team Identifier description: >- UUID da equipe para distribuição em rodízio (opcional e mutuamente exclusivo com internalParticipants). examples: - 9fd1468d-e5ca-4ba3-98d1-13017e6f3808 onboardingTemplates: items: $ref: '#/components/schemas/OnboardingTemplateRequest' type: array title: Onboarding Templates description: >- Templates ordenados para abrir a conversa. Eles substituem a sequência de abertura configurada no workspace para esta conversa, por inteiro ou apenas seu primeiro template, conforme a configuração do workspace; no segundo caso, o restante da sequência configurada ainda é enviado depois dos seus. A posição determina a ordem. Omita para manter o padrão do workspace. Cada template deve existir, pertencer ao seu workspace ou ao escopo da plataforma e, para templates de provedor do WhatsApp, estar aprovado pela Meta para a WhatsApp Business Account da linha pela qual cada participante é contatado; caso contrário, a solicitação é rejeitada e nenhuma conversa é criada. Um template cujas variáveis precisem de valores que só você pode fornecer os recebe em `parameters` da entrada. Se um dos templates configurados enviados depois dos seus precisar de valores que só quem chama pode fornecer, a solicitação é rejeitada com 422 `BRIDGE_CONVERSATION_0608`, com `extra.templateId` identificando esse template e `extra.origin` definido como `WORKSPACE_CONFIGURATION`. Alterar a solicitação não ajudará: peça a um administrador do workspace que altere a sequência de abertura. additionalProperties: false type: object required: - participants title: CreateConversationRequest description: Corpo da solicitação para criar uma conversa. ConversationResponse: properties: id: type: string title: Identifier description: Identificador único da conversa (UUID v4). examples: - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234 workspaceId: type: string title: Workspace Identifier description: Identificador único do workspace (UUID v4). examples: - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234 participants: $ref: '#/components/schemas/ConversationParticipantsResponse' title: Participants description: Participantes da conversa. name: anyOf: - type: string - type: 'null' title: Name description: Nome ou título opcional da conversa. examples: - Bridge Support Team status: anyOf: - $ref: '#/components/schemas/ConversationStatus' - type: 'null' title: Status description: >- Status atual da conversa: 'ACTIVE' para conversas visíveis e 'GHOST' para conversas invisíveis até a primeira interação. examples: - ACTIVE createdAt: type: string format: date-time title: Created At description: Data e hora de criação da conversa. examples: - '2003-04-10T09:00:00.000Z' updatedAt: type: string format: date-time title: Updated At description: Data e hora da última atualização da conversa. examples: - '2003-04-10T09:00:00.000Z' type: object required: - id - workspaceId - participants - createdAt - updatedAt title: ConversationResponse description: Corpo da resposta para os detalhes de uma conversa. Problem: properties: title: type: string title: Title description: Resumo breve do tipo de problema. status: type: integer title: Status description: >- Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema. detail: anyOf: - type: string - type: 'null' title: Detail description: Explicação específica desta ocorrência do problema. instance: anyOf: - type: string - type: 'null' title: Instance description: Referência URI que identifica esta ocorrência do problema. traceId: anyOf: - type: string - type: 'null' title: Traceid description: ID de rastreamento para depuração. code: anyOf: - type: string - type: 'null' title: Code description: >- Código para identificar o erro; consulte a página de códigos de erro para mais detalhes. errors: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Errors description: Lista de detalhes dos erros. extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra description: Informações adicionais sobre o problema. type: object required: - title - status title: Problem description: Objeto que representa o corpo de uma resposta Problem. CreateParticipantsOnConversationRequest: properties: externals: items: $ref: '#/components/schemas/ExternalUserIdentifierRequest' type: array title: Externals description: Lista de identificadores de usuários externos. internals: items: $ref: '#/components/schemas/InternalUserIdentifierRequest' type: array title: Internals description: >- Lista de identificadores de usuários internos (opcional e mutuamente exclusiva com teamId). type: object title: CreateParticipantsOnConversationRequest description: Corpo da solicitação de participantes ao criar uma conversa. ConversationStatus: type: string enum: - ACTIVE - GHOST - RELEASED - NOT_ASSIGNED_TO_HUMAN - BLOCKED title: ConversationStatus OnboardingTemplateRequest: properties: templateId: type: string title: Template Identifier description: Identificador do modelo do sistema a ser enviado. examples: - 4061e74e-f6fe-4072-a760-3aec0b64f7a6 parameters: additionalProperties: type: string maxLength: 1024 propertyNames: maxLength: 128 type: object maxProperties: 50 title: Template Parameters description: >- Valores das variáveis deste template, indexados pela `key` da variável retornada por `GET /templates/{templateId}`. As variáveis marcadas com `callerMustSupply: true` são obrigatórias: a Bridge não tem outra fonte para elas. As demais são opcionais; um valor enviado para uma delas, como o primeiro nome do Contact, substitui o valor por Contact e é usado para todos os Contacts da conversa. Somente templates de provedor do WhatsApp aceitam parâmetros. Se um valor obrigatório estiver ausente ou em branco, uma chave não corresponder a nenhuma variável do template ou o template não aceitar parâmetros, a solicitação é rejeitada com 422 e nenhuma conversa é criada: `BRIDGE_CONVERSATION_0604` lista as variáveis ausentes em `extra.missingVariables` como `[{key, label}]`, `0605` lista as chaves desconhecidas em `extra.unknownKeys` e `0606` identifica o template em `extra.templateId`. Os valores também devem cumprir as regras do WhatsApp: sem quebras de linha ou tabulações, no máximo quatro espaços consecutivos, o cabeçalho com seu valor dentro de 60 caracteres, o link de um botão de URL com seu valor dentro de 2.000 e o texto do corpo mais seus valores dentro de 1.024. A Bridge recusa os valores que já consegue identificar como inválidos com `BRIDGE_CONVERSATION_0607`, identificando o template em `extra.templateId` e listando cada valor inválido em `extra.invalidVariables` como `[{key, label, reason}]`. `reason` é a primeira regra violada pelo valor: `NEWLINE`, `TAB`, `CONSECUTIVE_SPACES`, `TOO_LONG` (cabeçalho ou botão de URL) ou `BODY_TOO_LONG` (o corpo excede o limite, portanto todos os valores de corpo enviados são listados). Os valores preenchidos depois pela Bridge, como o primeiro nome do Contact, também contam para o limite do corpo; por isso, reserve espaço para eles. No máximo, 50 parâmetros por template, com chaves de até 128 caracteres e cada valor de até 1.024. examples: - delivery_date: 3 de octubre order_number: A-10492 additionalProperties: false type: object required: - templateId title: OnboardingTemplateRequest description: >- Entrada da substituição de onboarding; sua posição na lista determina a ordem. ConversationParticipantsResponse: properties: externals: items: $ref: '#/components/schemas/ExternalParticipant' type: array title: Externals description: Lista de participantes externos. internals: items: $ref: '#/components/schemas/InternalParticipant' type: array title: Internals description: Lista de participantes internos. type: object required: - externals - internals title: ConversationParticipantsResponse description: Corpo da resposta para os participantes de uma conversa. ExternalUserIdentifierRequest: properties: identifier: type: string title: Identifier description: Valor do identificador do usuário. examples: - john.doe@example.com - '+13802098869' - 37673840-6259-40f9-bbe5-a7db40f8e3cf identifierType: type: string enum: - ID - EMAIL - PHONE title: Identifier Type description: Tipo de identificador de usuários externos (ID, EMAIL ou PHONE). examples: - EMAIL - PHONE - ID messageProviderType: anyOf: - $ref: '#/components/schemas/MessageProviderType' - type: 'null' title: Message Provider Type description: Tipo de provedor de mensagens da conversa. examples: - WHATSAPP - null providerChannelId: anyOf: - type: string - type: 'null' title: Provider Channel Identifier description: >- ID do canal do provedor usado pelo Bridge para se comunicar com o usuário. brandId: anyOf: - type: string - type: 'null' title: Brand Identifier description: >- Marca proprietária da linha corporativa usada para contatar o usuário. Quando o workspace tem pelo menos uma linha com marca, a seleção automática de linhas é limitada a essa marca e a solicitação deve incluir brandId ou providerChannelId; a ausência de ambos é rejeitada. Ignorado quando o workspace não tem linhas com marca. type: object required: - identifier - identifierType title: ExternalUserIdentifierRequest description: Corpo para identificar um usuário externo no Bridge. InternalUserIdentifierRequest: properties: identifier: type: string title: Identifier description: Valor do identificador do usuário. examples: - john.doe@example.com - '+13802098869' - 37673840-6259-40f9-bbe5-a7db40f8e3cf identifierType: $ref: '#/components/schemas/InternalParticipantIdentifierType' title: Identifier Type description: Tipo de identificador de usuários internos (ID ou EMAIL). examples: - EMAIL - ID type: object required: - identifier - identifierType title: InternalUserIdentifierRequest description: Corpo para identificar um usuário interno no Bridge. ExternalParticipant: properties: identifier: type: string title: Identifier description: Valor do identificador do participante. examples: - ef7ee722-5f95-415a-9a98-81eeae178b11 identifierType: type: string enum: - ID - EMAIL - PHONE title: Identifier Type description: >- Tipo de identificador de participantes externos (ID, EMAIL ou PHONE). examples: - EMAIL - PHONE - ID role: $ref: '#/components/schemas/UserType' title: Role description: Papel do participante na conversa. examples: - EXTERNAL - INTERNAL joinedAt: type: string format: date-time title: Joined At description: Data e hora em que o participante entrou na conversa. examples: - '2004-04-10T09:00:00.000Z' lastSeenAt: anyOf: - type: string format: date-time - type: 'null' title: Last Seen At description: Data e hora da última atividade observada do participante. examples: - null - '2004-04-10T09:00:00.000Z' type: object required: - identifier - identifierType - role - joinedAt title: Participant description: Objeto que representa o participante externo da conversa. InternalParticipant: properties: identifier: type: string title: Identifier description: Valor do identificador do participante. examples: - ef7ee722-5f95-415a-9a98-81eeae178b11 identifierType: $ref: '#/components/schemas/InternalParticipantIdentifierType' title: Identifier Type description: Tipo de identificador de participantes internos (ID ou EMAIL). examples: - EMAIL - ID role: $ref: '#/components/schemas/UserType' title: Role description: Papel do participante na conversa. examples: - EXTERNAL - INTERNAL joinedAt: type: string format: date-time title: Joined At description: Data e hora em que o participante entrou na conversa. examples: - '2004-04-10T09:00:00.000Z' lastSeenAt: anyOf: - type: string format: date-time - type: 'null' title: Last Seen At description: Data e hora da última atividade observada do participante. examples: - null - '2004-04-10T09:00:00.000Z' type: object required: - identifier - identifierType - role - joinedAt title: Participant description: Objeto que representa o participante interno da conversa. MessageProviderType: type: string enum: - WHATSAPP - SMS - TELEGRAM - INSTAGRAM - TWITTER - LINE - FACEBOOK - IMESSAGE - WHATSAPP_TEST - HEYGIA title: MessageProviderType InternalParticipantIdentifierType: type: string enum: - ID - EMAIL title: InternalParticipantIdentifierType UserType: type: string enum: - INTERNAL - EXTERNAL - BOT title: UserType securitySchemes: x-api-key: type: apiKey description: Copy the API key as provided by the Bridge Console. in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.