> ## 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. # Listar os Agents de um workspace > Lista os Agents do workspace com seu status, disponibilidade e linhas. Inclui todos os Agents, independentemente do status; `available` indica se podem iniciar conversas. Uma página pode conter menos itens que `limit`; continue a paginação enquanto `cursor` não for null. ## OpenAPI ````yaml /pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/agents 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}/agents: get: tags: - Agents API summary: Listar os Agents de um workspace description: >- Lista os Agents do workspace com seu status, disponibilidade e linhas. Inclui todos os Agents, independentemente do status; `available` indica se podem iniciar conversas. Uma página pode conter menos itens que `limit`; continue a paginação enquanto `cursor` não for null. operationId: list_agents_bridge_api_v1_workspaces__workspaceId__agents_get 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). - name: type in: query required: false schema: anyOf: - $ref: '#/components/schemas/AgentType' - type: 'null' description: Retorna apenas Agents deste tipo. title: Type description: Retorna apenas Agents deste tipo. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Número de Agents por página default: 20 title: Limit description: Número de Agents por página - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Cursor recebido em uma solicitação anterior para obter a próxima página title: Cursor description: >- Cursor recebido em uma solicitação anterior para obter a próxima página responses: '200': description: Resposta bem-sucedida content: application/json: schema: $ref: '#/components/schemas/AgentsResponseList' '400': description: Solicitação inválida content: application/json: examples: INVALID_CURSOR: value: title: Invalid Cursor status: 400 code: BRIDGE_AI_AGENT_OUTBOUND_0007 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' '422': description: Erro de validação content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '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: AgentType: type: string enum: - LEADSCOUT - SERVICE_AGENT title: AgentType description: Tipos de Agent expostos pela API pública. AgentsResponseList: properties: agents: items: $ref: '#/components/schemas/AgentResponse' type: array title: Agents description: Lista de Agents. cursor: anyOf: - type: string - type: 'null' title: Cursor description: >- Cursor a ser enviado ao solicitar a próxima página. É null na última página. type: object required: - agents title: AgentsResponseList description: Corpo da resposta para listar os Agents de um workspace. 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. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError AgentResponse: properties: id: type: string title: Agent Identifier description: Identificador único do Agent. name: type: string title: Name description: Nome do Agent. description: anyOf: - type: string - type: 'null' title: Description description: Descrição do Agent. Sempre presente; null quando não há descrição. type: $ref: '#/components/schemas/AgentType' title: Type description: Tipo de Agent. examples: - LEADSCOUT - SERVICE_AGENT brandId: anyOf: - type: string - type: 'null' title: Brand Identifier description: >- Marca à qual o Agent pertence. Sempre presente; null quando não está limitado a uma marca. status: $ref: '#/components/schemas/AgentConfigStatus' title: Status description: Status de configuração do Agent. examples: - DRAFT - COMPLETE available: type: boolean title: Available description: >- Indica se o Agent pode iniciar conversas: sua configuração está completa e ele tem uma linha. unavailableReason: anyOf: - type: string - type: 'null' title: Unavailable Reason description: >- Motivo pelo qual o Agent não está disponível: `DRAFT` (configuração incompleta) ou `NO_LINES` (sem linha ativa). Sempre presente; null quando está disponível. examples: - DRAFT - NO_LINES lines: items: $ref: '#/components/schemas/AgentLine' type: array title: Lines description: >- Linhas ativas de WhatsApp nas quais o Agent responde. Vazio quando não há nenhuma. type: object required: - id - name - type - status - available title: AgentResponse description: Agent do workspace com seu status e disponibilidade. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError AgentConfigStatus: type: string enum: - DRAFT - COMPLETE title: AgentConfigStatus AgentLine: properties: providerChannelId: type: string title: Provider Channel Identifier description: >- Identificador da linha (o mesmo valor recebido por `providerChannelId` nas operações de saída). type: object required: - providerChannelId title: AgentLine description: Linha de WhatsApp na qual um Agent responde. 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.