Skip to main content
Esta página reúne as regras que valem para todas as requisições à API: a URL base, o formato das respostas e o limite de requisições por minuto.

URL base

Todos os endpoints da API começam com esta URL base:
Por exemplo, a listagem de projetos fica em https://api.olie.ai/api/management/projects.

Formato de resposta

A API retorna todas as respostas em JSON, com codificação UTF-8. Configure a sua integração para ler esse formato. As respostas seguem uma estrutura padronizada, descrita em Estrutura de respostas.

Limite de requisições

O limite padrão é de 160 requisições por minuto. A API conta as requisições por identidade autenticada: cada usuário tem o seu contador, e cada aplicação tem o seu. Requisições sem autenticação são contadas por endereço IP. O limite não é por empresa. Duas aplicações da mesma empresa têm 160 requisições por minuto cada uma, e consumir o limite de uma não afeta a outra.

Limite maior para uma empresa

O limite de 160 requisições por minuto pode ser aumentado para uma empresa específica. A API só reconhece esse aumento quando a requisição chega com o cabeçalho Origin apontando para o subdomínio da empresa. Uma alteração no limite de uma empresa leva até 5 minutos para passar a valer. Integrações servidor a servidor normalmente não enviam Origin. Nesse caso, a requisição fica no limite padrão de 160 requisições por minuto, mesmo que a empresa tenha um limite maior configurado. O limite aplicado a cada requisição aparece no cabeçalho X-RateLimit-Limit da resposta. Use esse cabeçalho como referência, em vez de assumir 160.

Limites por tipo de rota

Nem toda rota usa o mesmo contador. A tabela mostra o limite de cada contexto e o que identifica quem faz a requisição: O MCP tem um contador próprio, separado do da API: consumir o limite do MCP não reduz as requisições disponíveis na API, e vice-versa. Veja MCP.

Cabeçalhos de limite

As respostas de sucesso da API trazem dois cabeçalhos sobre o limite:
  • X-RateLimit-Limit: o número máximo de requisições por minuto aplicado àquela requisição.
  • X-RateLimit-Remaining: quantas requisições ainda restam no minuto atual.
Acompanhe o X-RateLimit-Remaining para reduzir o ritmo antes de chegar a zero.

Quando o limite é excedido

Se a integração passar do limite, a API responde com HTTP 429 (Too Many Requests). O corpo da resposta traz, no campo wait_seconds, quantos segundos esperar antes de uma nova requisição:
Aguarde o tempo de wait_seconds e repita a requisição. A resposta 429 não traz o cabeçalho Retry-After: leia a espera no corpo.
Exceder o limite de forma abusiva ou repetida pode levar ao bloqueio temporário ou à suspensão permanente do token.
Se a integração precisa de muitas requisições, guarde em cache os dados que não mudam com frequência. Para alterar vários registros de uma vez, use as operações em lote.