REST API — Introdução

Desenvolvedor

Visão Geral

A API do Prodgy permite que aplicações externas se conectem a plataforma para acessar recursos como agentes de IA, base de conhecimento, integrações e webhooks. A comunicação é feita via REST API com respostas em JSON.

O que você pode fazer com a API?

Recurso	Descrição
Agentes	Listar, instalar e gerenciar agentes de IA
Execuções	Disparar e consultar execuções de agentes
Integrações	Gerenciar conexões com ferramentas externas
Base de Conhecimento	Importar e consultar documentos
Triggers	Configurar gatilhos automáticos
Webhooks	Receber eventos de sistemas externos
Transcrição	Transcrever arquivos de audio em texto

URL Base

Todas as requisições devem ser feitas para a URL base da sua instância do Prodgy:

https://<sua-instância>.prodgy.app/api

Formato das Requisições

Aspecto	Detalhe
Content-Type	`application/json` (padrão) ou `multipart/form-data` (uploads)
Resposta	Sempre `application/json`
Autenticação	Via header `X-API-Token` ou `Authorization: Bearer`
Codificação	UTF-8

Formato Padrão de Resposta

Sucesso

{
  "success": true,
  "message": "Operação realizada com sucesso",
  "data": { }
}

Erro

{
  "success": false,
  "error": "Tipo do erro",
  "message": "Descrição detalhada do erro"
}

Códigos HTTP

Código	Significado
200	Requisição bem-sucedida
201	Recurso criado com sucesso
400	Parâmetros invalidos na requisição
401	Autenticação ausente ou inválida
404	Recurso não encontrado
429	Limite de requisições excedido
500	Erro interno do servidor

Rate Limiting

A API possui limites de taxa para proteger os recursos do servidor:

Padrão: 10 requisições por minuto por IP
Estrito: 5 requisições por minuto (operações intensivas)

Quando o limite e atingido, a resposta retorna o código 429 com os seguintes headers:

Header	Descrição
`RateLimit-Limit`	Número máximo de requisições permitidas
`RateLimit-Remaining`	Requisições restantes na janela atual
`RateLimit-Reset`	Timestamp Unix do próximo reset

Documentação Interativa

O Prodgy disponibiliza uma interface Swagger para exploração interativa da API:

Recurso	URL
Swagger UI	https://prodgy.programmers.com.br/swagger
OpenAPI JSON	https://prodgy.programmers.com.br/swagger.json

Próximos Passos

Autenticação — aprenda a criar e utilizar tokens de API
Endpoints — consulte os endpoints disponíveis e seus parâmetros
Webhooks — configure webhooks para receber eventos externos