API Reference
Complete reference for the GenRex REST API. All endpoints use JSON for request and response bodies.
Base URL
https://api.genrex.io/v1
API Modules
Endpoints Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /document/create |
Create a new document |
| GET | /document/status/{uuid} |
Check document status and retrieve result |
| POST | /image/create |
Create a new image generation request |
| GET | /image/status/{uuid} |
Check image status and retrieve result |
| POST | /audio/create |
Create a new text-to-speech audio request |
| GET | /audio/status/{uuid} |
Check audio status and retrieve result |
Rate Limits
API requests are rate limited to ensure fair usage:
| Endpoint Type | Limit |
|---|---|
| All endpoints | 60 requests per minute |
Response Format
Create endpoints return the process UUID:
{
"success": true,
"id": "550e8400-e29b-41d4-a716-446655440000"
}
Status endpoints return the current status and data when completed:
{
"success": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"data": { ... }
}
Error responses:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The prompt field is required."
}
}