Skip to main content

​
AI-Ready API

Seus devs (ou os agentes de IA deles) integram em minutos, não dias.A Engine API é a primeira API fiscal do Brasil projetada para ser consumida tanto por humanos quanto por agentes de IA. Qualquer LLM — Claude, ChatGPT, Gemini, Copilot, Cursor, Windsurf — consegue gerar código de integração correto apontando para nosso contexto machine-readable.

​
Por que isso importa

Hoje, a maioria dos times de engenharia usa IA no dia a dia para escrever código. Quando a API é AI-Ready, o custo de integração cai drasticamente:
AbordagemTempo estimadoRisco de erro
Ler docs + escrever código manual2 a 5 diasAlto — interpretação humana
Copiar exemplos da doc1 a 2 diasMédio — depende de contexto
Apontar IA para llms.txtMinutosBaixo — contexto completo

​
Recursos disponíveis para IAs

A Engine API fornece 3 recursos machine-readable que IAs usam automaticamente:

llms.txt

Contexto completo para LLMs — endpoints, SDK, auth e erros

OpenAPI Spec

92 endpoints com schemas tipados e exemplos

SDK TypeScript

Tipos exportados para auto-complete em qualquer IDE
RecursoURLAtualização
llms.txtdocs.engineapi.com.br/llms.txtAutomática via CI
OpenAPI Specapi.engineapi.com.br/v1/api-docs-jsonAutomática via CI
SDK Typesnpm install @engineapi/sdkA cada release

​
Como usar com agentes de IA

​
Claude, ChatGPT, Gemini (conversacional)

Cole este bloco na conversa com qualquer agente de IA: 
Preciso integrar com a Engine API — uma API fiscal brasileira.

Contexto completo da API: https://docs.engineapi.com.br/llms.txt

Use o SDK @engineapi/sdk (npm). Crie uma integração para emitir NFe
com tratamento de erros e retry. A API key está em process.env.ENGINE_API_KEY.
O agente vai gerar código funcional de primeira porque o llms.txt contém todos os endpoints, parâmetros e formatos de resposta.

​
Cursor / Windsurf / Copilot (IDE)

1

Adicione o contexto

No Cursor: abra o chat e adicione https://docs.engineapi.com.br/llms.txt como referência. No Copilot: cole o conteúdo do llms.txt como comentário no topo do arquivo.
2

Peça a integração

Integre com a Engine API para emitir NFe.
Use @engineapi/sdk. API key em process.env.ENGINE_API_KEY.
3

Revise e execute

O agente gera o código completo com imports, client setup, chamada e error handling.

​
Agentes autônomos (Forge, Devin, Sweep)

Para agentes que operam em repositórios, adicione ao seu CONTEXT.md ou README.md: 
## Fiscal API Integration

Engine API — Motor Fiscal SaaS
- SDK: npm install @engineapi/sdk
- llms.txt: https://docs.engineapi.com.br/llms.txt
- OpenAPI: https://api.engineapi.com.br/v1/api-docs-json
- Auth: header x-api-key
O agente encontra essas referências automaticamente e integra sem intervenção humana.

​
OpenAPI Import (Postman, Insomnia, Hoppscotch)

Para ferramentas de API testing: 
https://api.engineapi.com.br/v1/api-docs-json
Importe e todos os 92 endpoints aparecem organizados por módulo, com parâmetros e responses tipados.

​
Bloco de contexto rápido

Se você está usando IA agora mesmo, copie e cole este bloco completo: 
Engine API — Motor Fiscal SaaS B2B2B
npm install @engineapi/sdk

import { EngineApiClient } from '@engineapi/sdk';
const client = new EngineApiClient({
  baseUrl: 'https://api.engineapi.com.br',
  apiKey: process.env.ENGINE_API_KEY,
});

Módulos:
- client.nfe      (emitir, listar, cancelar, cartaCorrecao, downloadPdf, downloadXml)
- client.boleto   (criarContaBancaria, emitir, listar, cancelar, downloadPdf)
- client.dfe      (consultar, listar, manifestar, downloadXml)
- client.companies (criar, listar, uploadCertificado)

Auth: header x-api-key: ek_live_UUID
Erros: EngineApiError (isValidationError, isUnauthorized, isRateLimited, isServerError)
OpenAPI: https://api.engineapi.com.br/v1/api-docs-json
Docs: https://docs.engineapi.com.br

​
O que é llms.txt

O llms.txt é um padrão emergente — como o robots.txt para crawlers, mas para modelos de linguagem. Quando uma IA acessa sua documentação, ela procura por esse arquivo para entender rapidamente o que a API faz e como usar.
O OpenAPI é um spec técnico completo (schemas, validações, responses). O llms.txt é um resumo em linguagem natural otimizado para LLMs — contém o que a IA precisa para gerar código correto sem ler centenas de páginas.São complementares: a IA lê o llms.txt primeiro para entender a estrutura, depois consulta o OpenAPI spec para detalhes de parâmetros.
Sim. O pipeline de CI da Engine API gera o llms.txt automaticamente a partir do OpenAPI spec em cada deploy. Se um endpoint muda no código, o CI bloqueia o merge até que a documentação seja atualizada.
Sim. O llms.txt é texto puro — funciona com Claude, ChatGPT, Gemini, Copilot, Cursor, Windsurf, Devin, e qualquer agente que leia texto.

​
Próximos passos

SDK TypeScript

Documentacao completa do SDK oficial com tipos

Quickstart

Da conta criada à primeira nota em 5 minutos