REST API — Introduction

Developer

Tip

This guide is intended for developers and integrators who want to consume Prodgy services via REST API, connecting external applications to the platform’s resources.

Overview

The Prodgy API allows external applications to connect to the platform to access resources such as AI agents, knowledge base, integrations, and webhooks. Communication is done via REST API with JSON responses.

---

What can you do with the API?

Resource	Description
Agents	List, install, and manage AI agents
Executions	Trigger and query agent executions
Integrations	Manage connections with external tools
Knowledge Base	Import and query documents
Triggers	Configure automatic triggers
Webhooks	Receive events from external systems
Transcription	Transcribe audio files to text

---

Base URL

All requests must be made to your Prodgy instance’s base URL:

https://<your-instance>.prodgy.app/api

Note

The base URL varies according to your organization’s environment. Consult the administrator to obtain the correct URL.

---

Request Format

Aspect	Detail
Content-Type	application/json (default) or multipart/form-data (uploads)
Response	Always application/json
Authentication	Via X-API-Token header or Authorization: Bearer
Encoding	UTF-8

---

Standard Response Format

Success

{
  "success": true,
  "message": "Operation completed successfully",
  "data": { }
}

Error

{
  "success": false,
  "error": "Error type",
  "message": "Detailed error description"
}

---

HTTP Status Codes

Code	Meaning
200	Successful request
201	Resource created successfully
400	Invalid request parameters
401	Missing or invalid authentication
404	Resource not found
429	Rate limit exceeded
500	Internal server error

---

Rate Limiting

The API has rate limits to protect server resources:

• Standard: 10 requests per minute per IP
• Strict: 5 requests per minute (resource-intensive operations)

When the limit is reached, the response returns a 429 status code with the following headers:

Header	Description
RateLimit-Limit	Maximum number of allowed requests
RateLimit-Remaining	Remaining requests in the current window
RateLimit-Reset	Unix timestamp of the next reset

---

Interactive Documentation

Prodgy provides a Swagger interface for interactive API exploration:

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

Note

Swagger documentation allows you to test endpoints directly from the browser and consult all available parameters and responses.

---

Next Steps

• Authentication — learn how to create and use API tokens
• Endpoints — check available endpoints and their parameters
• Webhooks — configure webhooks to receive external events