Remote API Overview
The AGNT Remote API (https://api.agnt.gg) provides cloud-based services for user management, marketplace operations, and shared resources.
Base URL
https://api.agnt.ggAPI Categories
User Management
- Authentication - Login, registration, OAuth
- Users - Profile, settings, stats (see Remote API Endpoints)
- Subscriptions - Billing and plan management (see Remote API Endpoints)
Execution & Analytics
- Executions - Execution history and analytics (see Remote API Endpoints)
Content & Tools
- Content Outputs - Generated content management (see Remote API Endpoints)
- Custom Tools - Custom tool definitions (see Remote API Endpoints)
- Streaming - Real-time AI streaming (see Remote API Endpoints)
Marketplace
- Marketplace - Browse, publish, and install marketplace items (see Remote API Endpoints)
- Reviews - Review and rating system (see Remote API Endpoints)
Integration & Communication
- Auth Providers - OAuth provider management (see Remote API Endpoints)
- Email - Email services and notifications (see Remote API Endpoints)
- Webhooks - Webhook management (see Remote API Endpoints)
Community & Growth
- Referrals - Referral program (see Remote API Endpoints)
- Waitlist & Onboarding - Waitlist and user onboarding (see Remote API Endpoints)
Quick Reference
Common Endpoints
| Endpoint | Method | Description | Auth Required |
|---|---|---|---|
/users/login |
POST | User login | No |
/users/register |
POST | User registration | No |
/users/profile |
GET | Get user profile | Yes |
/agents |
GET | List all agents | Yes |
/agents/save |
POST | Create/update agent | Yes |
/workflows |
GET | List all workflows | Yes |
/marketplace/items |
GET | Browse marketplace | No |
/marketplace/items/:id/install |
POST | Install marketplace item | Yes |
Authentication
All authenticated endpoints require a JWT token in the Authorization header:
headers: {
'Authorization': 'Bearer YOUR_JWT_TOKEN'
}Response Format
Success:
{
"success": true,
"data": {
/* response data */
}
}Error:
{
"success": false,
"error": "Error message",
"details": "Additional details"
}Rate Limits
Rate limits vary by subscription plan:
| Plan | Requests/Hour | Requests/Day |
|---|---|---|
| Free | 100 | 1,000 |
| Personal | 1,000 | 10,000 |
| Business | 10,000 | 100,000 |
| Enterprise | Custom | Custom |
Rate Limit Headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200Health Check
Check API status:
GET https://api.agnt.gg/agents/health
// Response
{
"status": "OK",
"timestamp": "2025-11-25T10:00:00Z"
}CORS
The API supports CORS for browser-based applications:
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Authorization, Content-TypePagination
List endpoints support pagination:
GET https://api.agnt.gg/agents?page=1&limit=20
// Response
{
"success": true,
"data": [ /* items */ ],
"pagination": {
"page": 1,
"limit": 20,
"total": 100,
"pages": 5
}
}Filtering & Sorting
Many endpoints support filtering and sorting:
// Filter by status
GET https://api.agnt.gg/workflows?status=active
// Sort by creation date
GET https://api.agnt.gg/agents?sort=createdAt&order=desc
// Combine filters
GET https://api.agnt.gg/marketplace/items?category=automation&sort=popularityWebhooks
Subscribe to events via webhooks:
POST https://api.agnt.gg/webhooks
Authorization: Bearer YOUR_JWT_TOKEN
{
"url": "https://your-server.com/webhook",
"events": ["workflow.completed", "agent.created"],
"secret": "your-webhook-secret"
}Error Codes
| Code | Description | Common Causes |
|---|---|---|
| 400 | Bad Request | Invalid parameters, malformed JSON |
| 401 | Unauthorized | Missing or invalid token |
| 403 | Forbidden | Insufficient permissions or plan |
| 404 | Not Found | Resource doesn't exist |
| 409 | Conflict | Resource already exists |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error |
| 503 | Service Unavailable | Maintenance or overload |
SDK Support
Use the official SDK for easier integration:
npm install @agnt/sdkimport { AgntClient } from '@agnt/sdk';
const client = new AgntClient({
apiKey: 'YOUR_API_KEY',
baseUrl: 'https://api.agnt.gg',
});
// Use the client
const agents = await client.agents.list();
const workflow = await client.workflows.get('workflow-id');Next Steps
- Authentication Guide - Learn about authentication
- Remote API Endpoints - Explore all endpoints
- Local API Overview - Learn about the local API
- Examples - See code examples