Referência da API
A referência completa da API do Polylane é gerada a partir da especificação OpenAPI que a plataforma serve, então ela sempre corresponde ao que está implantado.
Abrir a referência da API
Toda operação, o formato de requisição e resposta, e snippets de requisição copiáveis.
Autenticação
Envie uma chave de API do workspace no cabeçalho x-api-key, ou um access token OAuth em Authorization: Bearer. Crie qualquer um deles no console; veja Chaves de API e clientes OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Formato de resposta
Toda resposta JSON usa o mesmo envelope.
| Campo | Descrição |
|---|---|
success | true quando a requisição teve sucesso, false quando falhou. |
message | Em caso de sucesso, um objeto cujo message descreve o status. null em caso de falha. |
error | null em caso de sucesso. Em caso de falha, um objeto com um message, um detail opcional e metadata opcional. |
result | O payload em caso de sucesso. Ausente em caso de falha. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Limites de taxa
| Superfície | Limite |
|---|---|
| API REST | 5,000 requisições a cada 60 segundos por credencial |
| Servidor MCP da plataforma | 600 requisições a cada 60 segundos por credencial |
As respostas anunciam a política nos cabeçalhos RateLimit-Limit e RateLimit-Policy. Acima do limite, a API responde 429 com um cabeçalho Retry-After carregando a janela em segundos; recue até ela passar, depois tente de novo.
Toda operação também pode ser chamada pela CLI, que é gerada a partir da mesma especificação.
Relacionado
- Chaves de API e clientes OAuth para criar as credenciais que estas requisições usam.
- CLI para chamar a API a partir de um terminal ou de um script.
- Servidor MCP da plataforma para alcançar os mesmos dados a partir de um agente de editor.