API de Documentos

2 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/documents

Procurar anexos já enviados

Busca anexos da empresa por nome do arquivo e/ou entidade a que estão ligados. Ordenado do mais recente para o mais antigo — é o que 'aquele boleto que mandei' quer dizer na prática.

documents:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`search`(query)	string	Trecho do nome do arquivo.
`entity_type`(query)	string
`entity_id`(query)	string (uuid)	Anexos de um registro específico.

Resposta 200 — Anexos encontrados

`id`	string (uuid)
`entity_type`	string
`entity_id`	string (uuid)
`file_name`	string
`file_path`	string
`file_size`	integer
`mime_type`	string
`created_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/documents" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/documents/analyze

Analisar documento anexado

Lê um anexo da empresa (PDF, imagem ou texto) e extrai os campos financeiros: tipo do documento, valor, vencimento, número, emitente, linha digitável do boleto e chave Pix. Usa o texto do arquivo e, quando ele não basta (PDF escaneado), a leitura visual do modelo.

documents:read

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`attachment_id`	string (uuid)	UUID do anexo em entity_attachments.
`file_name`	string	Alternativa ao id: parte do nome do arquivo.

Resposta 200 — Campos extraídos do documento

`attachment_id`	string (uuid)
`file_name`	string
`kind`	string	boleto \| arrecadacao \| nfe \| nfse \| fatura \| recibo \| desconhecido
`direction`	string	pagar \| receber \| indefinido
`amount`	number
`due_date`	string (date)
`document_number`	string
`barcode`	string
`digitable_line`	string
`pix_key`	string
`counterparty_name`	string
`counterparty_document`	string
`is_own_company_document`	boolean	O documento encontrado é o da própria empresa (contribuinte/pagador).
`missing`	array de string	Campos essenciais que não foi possível extrair.
`extracted`	boolean

Exemplo

curl -X POST "https://api.comando.one/v1/documents/analyze" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Split de Pagamentos (9)Catálogos (7)Propostas (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente