> ## 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.

# Sobe um arquivo para enviar

> Exige `inbox:operate` e um token `write`. O corpo é **o arquivo em
binário** (não JSON, não multipart), com o tipo no `Content-Type` e o
nome em `X-Filename` (pode vir codificado com `encodeURIComponent`).
Teto de 10 MB.

Devolve a `url` para usar em `media_url` no envio. Ela é uma URL
ASSINADA: abre o arquivo por 10 minutos e depois deixa de abrir — mas
continua aceita em `media_url`, sem prazo. Conta no limite de 30
por minuto do token, e há um teto de 60 arquivos por minuto por empresa.

O conteúdo é conferido contra o `Content-Type`: um arquivo cujo começo
não é o do tipo declarado (um HTML mandado como `image/png`, por
exemplo) é recusado com `422`.

Tipos aceitos: imagem (jpeg, png, webp, gif, heic), áudio (mp3, m4a,
aac, ogg/opus, wav, amr, webm), vídeo (mp4, webm, mov, 3gp) e documento
(pdf, doc, docx, xls, xlsx, csv).




## OpenAPI

````yaml /openapi.yaml post /midia
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:
  /midia:
    post:
      tags:
        - Agente de IA
      summary: Sobe um arquivo para enviar
      description: |
        Exige `inbox:operate` e um token `write`. O corpo é **o arquivo em
        binário** (não JSON, não multipart), com o tipo no `Content-Type` e o
        nome em `X-Filename` (pode vir codificado com `encodeURIComponent`).
        Teto de 10 MB.

        Devolve a `url` para usar em `media_url` no envio. Ela é uma URL
        ASSINADA: abre o arquivo por 10 minutos e depois deixa de abrir — mas
        continua aceita em `media_url`, sem prazo. Conta no limite de 30
        por minuto do token, e há um teto de 60 arquivos por minuto por empresa.

        O conteúdo é conferido contra o `Content-Type`: um arquivo cujo começo
        não é o do tipo declarado (um HTML mandado como `image/png`, por
        exemplo) é recusado com `422`.

        Tipos aceitos: imagem (jpeg, png, webp, gif, heic), áudio (mp3, m4a,
        aac, ogg/opus, wav, amr, webm), vídeo (mp4, webm, mov, 3gp) e documento
        (pdf, doc, docx, xls, xlsx, csv).
      parameters:
        - name: X-Filename
          in: header
          schema:
            type: string
            example: Tabela%20de%20pre%C3%A7os.pdf
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
          image/*:
            schema:
              type: string
              format: binary
          audio/*:
            schema:
              type: string
              format: binary
          video/*:
            schema:
              type: string
              format: binary
          application/pdf:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Guardado
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                  media_type:
                    type: string
                    enum:
                      - image
                      - audio
                      - video
                      - document
                  name:
                    type: string
              example:
                url: >-
                  https://armazenamento.exemplo/media/2b8e4c1a-6d3f-4e7b-9a52-0c1d2e3f4a5b/h/4f6a9c2e1b7d8a3f5e0c9b2d7a1e6f3c8b4d0a9e2f7c1b6d3a8e5f0c4b9d2a7e/Tabela-de-precos.pdf
                media_type: document
                name: Tabela-de-precos.pdf
        '401':
          $ref: '#/components/responses/NaoAutenticado'
        '403':
          $ref: '#/components/responses/SemPermissao'
        '413':
          description: Acima de 10 MB
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
        '422':
          description: >-
            Tipo não suportado, corpo vazio, ou o conteúdo não é do tipo
            declarado ("o conteúdo não é um PNG")
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
        '429':
          $ref: '#/components/responses/LimiteAtingido'
        '503':
          description: O armazenamento não respondeu. Tente de novo.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
components:
  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'
    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.
  schemas:
    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
  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.