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

# Responde ao lead

> Exige `inbox:operate` e um token `write`. A mensagem entra na fila de
envio e sai pela conexão de WhatsApp ou Instagram da empresa; acompanhe o
resultado em `GET /mensagens/{id}`.

**`Idempotency-Key` é obrigatório.** Use um valor por mensagem (o id da
execução do seu fluxo, por exemplo). Repetir a chamada com a mesma chave
devolve `200` com a mesma mensagem e `duplicate: true` — **nada é enviado
de novo**. A chave vale para UMA conversa: reusá-la noutra conversa é
`422`, e a resposta não diz qual mensagem a usou. O provedor de WhatsApp não deduplica: sem a chave, um retry
manda a mesma mensagem duas vezes ao lead.

**O que o envio NÃO faz:** não assume a conversa, não tira da fila do
time, não muda o estado de atendimento e não conta como primeira
resposta do time. O tempo da primeira resposta da IA é medido à parte.

**Limites:** 30 envios por minuto por token e 1.000 por dia (de Brasília)
por empresa. A repetição com a mesma chave não conta, e um envio
recusado (`409`, `422`) também não. `POST /midia` conta no limite por
minuto.




## OpenAPI

````yaml /openapi.yaml post /conversas/{id}/mensagens
openapi: 3.1.0
info:
  title: Metricaas API
  version: 1.0.0
  description: >
    API do Metricaas para automatizar o CRM de fora dele — registrar vendas de
    uma

    plataforma de pagamento, ler leads e conferir a atribuição de origem.


    **Base:** `https://app.metricaas.com.br/v1`


    Todo endpoint é server-to-server. Não há CORS: um token de API nunca deve ir

    para o navegador.
servers:
  - url: https://app.metricaas.com.br/v1
security:
  - bearerAuth: []
tags:
  - name: Sessão
  - name: Leads
  - name: Vendas
  - name: Atendimento
  - name: Agente de IA
    description: |
      Ler a conversa, responder ao lead e pedir um humano — para um agente de IA
      (no n8n, por exemplo) atender pelo número da empresa sem sair do
      MetricaaS. A mensagem do agente aparece no inbox com selo próprio, não
      assume a conversa e não conta como primeira resposta do time.

      Gere o token em **Configurações → Tokens de API** com a finalidade
      **"Agente de atendimento"**: ele só conversa (`inbox:view` e
      `inbox:operate`). O texto do lead vai para um modelo de linguagem, e um
      modelo pode ser manipulado pela própria mensagem — o token não pode
      permitir nada além de conversar.

      **Este token é do seu servidor (o n8n), não do modelo.** Nunca o entregue
      ao modelo de IA como ferramenta: uma mensagem do lead poderia mandar o
      modelo ler outras conversas.
  - name: Comentários
    description: >
      Os comentários dos posts do Instagram e a resposta EM PÚBLICO, como a
      conta

      da empresa — a mesma fila da caixa de comentários. Uso típico: o webhook

      `comment.received` chega, um agente escreve a resposta, uma pessoa aprova,
      e

      o seu servidor publica por `POST
      /v1/comentarios/{comentario_id}/respostas`.
  - name: Fluxos
    description: >
      Criar um fluxo completo e ligar um post do Instagram a um fluxo de

      comentário — a ponte para quem publica o post fora do MetricaaS (o Estúdio

      do Horus, ou um motor de Reels) e quer que o fluxo certo responda a quem

      comentar nele.


      Gere o token em **Configurações → Tokens de API** com a finalidade

      **"Acesso completo do papel"** e o modo de **escrita**, herdando alguém
      que pode montar

      fluxos (`automations:manage`).
  - name: Configuração do CRM
    description: |
      Funis, etapas, tags e campos personalizados — para montar a operação por
      script (ex.: o funil "Infoproduto": Comentou → Abriu material → Lead →
      Clicou comprar → Comprou → Entregue → Cliente recorrente · Perdido).

      **Criar é idempotente pelo nome** (no campo, pela chave): repetir o
      script devolve `200` com `criado: false` e não duplica nada. O que já
      existe com **outro tipo** é `409`, e nada muda. Renomear, reordenar o que
      existe e remover ficam na tela. Ler pede a tela correspondente (Funil,
      Leads); criar pede `funnel:config`.
paths:
  /conversas/{id}/mensagens:
    post:
      tags:
        - Agente de IA
      summary: Responde ao lead
      description: >
        Exige `inbox:operate` e um token `write`. A mensagem entra na fila de

        envio e sai pela conexão de WhatsApp ou Instagram da empresa; acompanhe
        o

        resultado em `GET /mensagens/{id}`.


        **`Idempotency-Key` é obrigatório.** Use um valor por mensagem (o id da

        execução do seu fluxo, por exemplo). Repetir a chamada com a mesma chave

        devolve `200` com a mesma mensagem e `duplicate: true` — **nada é
        enviado

        de novo**. A chave vale para UMA conversa: reusá-la noutra conversa é

        `422`, e a resposta não diz qual mensagem a usou. O provedor de WhatsApp
        não deduplica: sem a chave, um retry

        manda a mesma mensagem duas vezes ao lead.


        **O que o envio NÃO faz:** não assume a conversa, não tira da fila do

        time, não muda o estado de atendimento e não conta como primeira

        resposta do time. O tempo da primeira resposta da IA é medido à parte.


        **Limites:** 30 envios por minuto por token e 1.000 por dia (de
        Brasília)

        por empresa. A repetição com a mesma chave não conta, e um envio

        recusado (`409`, `422`) também não. `POST /midia` conta no limite por

        minuto.
      parameters:
        - $ref: '#/components/parameters/IdConversa'
        - name: Idempotency-Key
          in: header
          required: true
          description: De 1 a 200 caracteres, único por mensagem nesta empresa.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            example: n8n-exec-48211
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  maxLength: 4096
                  description: |
                    Até 4.096 caracteres, depois de aparar espaços. Obrigatório
                    quando não há mídia; com mídia, vira a legenda.
                media_url:
                  type: string
                  description: >
                    Só a `url` devolvida por `POST /midia`. URL de qualquer
                    outro

                    lugar é `422`: o provedor buscaria o endereço que você
                    mandasse.

                    Ela continua valendo aqui depois de vencer para abrir — o
                    que

                    conta é o arquivo que ela aponta, não a assinatura.
                media_type:
                  type: string
                  enum:
                    - image
                    - audio
                    - ptt
                    - video
                    - document
                  description: '`ptt` = nota de voz (chega como áudio gravado na hora).'
                forcar:
                  type: boolean
                  default: false
                  description: |
                    Envia mesmo com a IA pausada nesta conversa. Fica registrado
                    na auditoria da empresa.
            examples:
              texto:
                value:
                  text: >-
                    Oi, Maria! O plano anual sai por R$ 1.188,00. Quer o link de
                    pagamento?
              nota-de-voz:
                value:
                  media_url: >-
                    https://armazenamento.exemplo/media/2b8e4c1a-6d3f-4e7b-9a52-0c1d2e3f4a5b/h/4f6a9c2e1b7d8a3f5e0c9b2d7a1e6f3c8b4d0a9e2f7c1b6d3a8e5f0c4b9d2a7e/resposta.ogg
                  media_type: ptt
      responses:
        '200':
          description: >
            Esta `Idempotency-Key` já foi usada nesta empresa. É a mesma
            mensagem,

            com o `status` de agora; nada foi enviado de novo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MensagemEnfileirada'
              example:
                id: 0d9e8f7a-6b5c-4d3e-8f21-a0b1c2d3e4f5
                conversation_id: 7b0c2e4a-1f3d-4c55-9a10-2d6f8e9b3c71
                status: sent
                duplicate: true
        '202':
          description: Enfileirada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MensagemEnfileirada'
              example:
                id: 0d9e8f7a-6b5c-4d3e-8f21-a0b1c2d3e4f5
                conversation_id: 7b0c2e4a-1f3d-4c55-9a10-2d6f8e9b3c71
                status: pending
                duplicate: false
        '400':
          description: Sem `Idempotency-Key`, ou com mais de 200 caracteres
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
        '401':
          $ref: '#/components/responses/NaoAutenticado'
        '403':
          $ref: '#/components/responses/SemPermissao'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '409':
          description: |
            A IA está pausada nesta conversa — um humano assumiu, ou o agente
            pediu um. O `detail` diz quem pausou e quando. Mande `forcar: true`
            para enviar mesmo assim.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
              example:
                type: about:blank
                title: IA pausada nesta conversa
                status: 409
                detail: >-
                  A IA foi pausada em 2026-10-21T13:55:00.000Z por
                  joana@empresa.com.br. Um humano está cuidando desta conversa.
                  Mande "forcar": true para enviar mesmo assim.
        '422':
          description: >
            Texto vazio ou longo demais, mídia inválida ou de fora, a empresa

            não tem conexão ativa no canal da conversa — a mensagem não sairia
            —,

            ou a `Idempotency-Key` já foi usada para **outra** conversa

            (`field: Idempotency-Key`, `message: já usada para outra conversa`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
              example:
                type: about:blank
                title: Requisição inválida
                status: 422
                errors:
                  - field: media_url
                    message: só a URL devolvida por POST /v1/midia
        '429':
          $ref: '#/components/responses/LimiteAtingido'
components:
  parameters:
    IdConversa:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    MensagemEnfileirada:
      type: object
      properties:
        id:
          type: string
          format: uuid
        conversation_id:
          type: string
          format: uuid
        status:
          type: string
          description: '`pending` ao enfileirar; na repetição, o status de agora.'
        duplicate:
          type: boolean
          description: >-
            `true` quando a `Idempotency-Key` já tinha sido usada — nada foi
            enviado de novo.
    Problema:
      type: object
      description: Erros seguem RFC 7807.
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    NaoAutenticado:
      description: Token ausente, inválido, expirado ou revogado
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    SemPermissao:
      description: O token não tem a capacidade exigida, ou é de leitura
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    NaoEncontrado:
      description: >
        Não existe **ou** é de outra empresa. A API responde `404` nos dois
        casos

        de propósito: um `403` confirmaria que o id existe.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    LimiteAtingido:
      description: |
        Passou de 30 envios por minuto neste token, ou de 1.000 por dia (de
        Brasília) nesta empresa. Espere os segundos do `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
            example: 42
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          example:
            type: about:blank
            title: Limite de envios
            status: 429
            detail: >-
              Limite de 30 envios por minuto para este token. Tente de novo em
              42 s.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        `Authorization: Bearer mcp_…` — gere em **Configurações → Tokens de
        API**.


        O token de API tem modo `read` ou `write`. Um token `read` responde
        `403`

        a qualquer verbo que não seja `GET`. As capacidades do token são a

        **interseção** com as da pessoa de quem ele herda o papel: se ela perder

        acesso na grade de Equipe, o token perde junto, sem ninguém revogar
        nada.


        **Token de agência** (gerado no console da agência): vale para as

        empresas da agência, e a empresa de cada chamada vai no header

        **`X-Empresa: <slug da empresa>`**. Sem o header, `401`. Num token de

        empresa o header é opcional e, se vier, tem de ser a própria empresa. O

        modo `read` vale igual: um token de agência de leitura só faz `GET` —

        é o token para pôr numa função que só consulta.

````

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