API Documentation
Authentication
AutoAPI Enterprise supports multiple authentication methods:
JWT Bearer Token
Authorization: Bearer <your-jwt-token>
API Key
X-API-Key: <your-api-key>
Rate Limiting
| Tier | Requests/min | Burst |
|---|---|---|
| Free | 60 | 10 |
| Starter | 300 | 50 |
| Professional | 1,000 | 100 |
| Enterprise | 10,000 | 500 |
Endpoints
Authentication
POST /auth/register- Register new userPOST /auth/login- Login and get tokensPOST /auth/refresh- Refresh access token
Platform API
GET /platform/apis- List all APIsPOST /platform/apis/generate- Create new APIGET /platform/apis/:id- Get API detailsPUT /platform/apis/:id- Update APIDELETE /platform/apis/:id- Delete APIGET /platform/apis/:id/analytics- Get API analyticsGET /platform/api-keys- List API keysPOST /platform/api-keys- Create API keyDELETE /platform/api-keys/:key- Revoke API keyGET /platform/webhooks- List webhooksPOST /platform/webhooks- Create webhookGET /platform/audit-logs- View audit logs
Generated APIs
Each generated API is available at /api/v1/:apiId/:resource
GET /api/v1/:apiId/:resource- List itemsGET /api/v1/:apiId/:resource/:id- Get single itemPOST /api/v1/:apiId/:resource- Create itemPUT /api/v1/:apiId/:resource/:id- Update itemPATCH /api/v1/:apiId/:resource/:id- Partial updateDELETE /api/v1/:apiId/:resource/:id- Delete item
Query Parameters
| Parameter | Description | Example |
|---|---|---|
| limit | Items per page (max 100) | ?limit=20 |
| offset | Skip items | ?offset=40 |
| sort | Sort by field | ?sort=name:asc |
| fields | Select fields | ?fields=id,name |
| q | Full-text search | ?q=widget |
| {field} | Filter by field | ?status=active |
| {field}[op] | Filter with operator | ?price[gt]=10 |
Response Format
{
"success": true,
"timestamp": "2024-01-01T00:00:00.000Z",
"data": { ... },
"meta": {
"total": 100,
"limit": 20,
"offset": 0,
"hasMore": true
}
}