Skip to main content
The Proliferate API gives you programmatic access to coding agents, sessions, and automations. The API is built on REST principles with JSON request/response formats. All endpoints require authentication. Make API requests to: https://app.proliferate.com/api or https://your-self-hosted-instance.com/api
For self-hosted deployments, replace the domain with your instance URL.

Authentication

All API requests require a Bearer token. Generate an API key from the Proliferate dashboard under Settings > API Keys. Include your API key in the Authorization header:
curl https://app.proliferate.com/api/sessions \
  -H "Authorization: Bearer YOUR_API_KEY"
Keep your API keys secure. Do not commit them to version control or expose them in client-side code.

API Key Types

Full access to all resources within your organization.Use cases:
  • Backend integrations
  • CI/CD pipelines
  • Automation scripts
  • Server-to-server communication
Recommended for most programmatic access.
Tied to your user account and permissions.Use cases:
  • Local development
  • CLI tools
  • Personal scripts
Access is limited to what your user can access in the dashboard.

Base URL

All API endpoints are prefixed with /api. For example:
EndpointFull URL
List sessionshttps://app.proliferate.com/api/sessions
Get a repohttps://app.proliferate.com/api/repos/{id}
Create automationhttps://app.proliferate.com/api/automations

Response Format

All responses are JSON. Successful responses return the requested data:
{
  "sessions": [
    {
      "id": "abc-123",
      "title": "Fix login bug",
      "status": "running",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}
Error responses include an error field:
{
  "error": "Session not found",
  "code": "NOT_FOUND"
}

Rate Limits

API requests are rate limited to ensure fair usage:
  • 1000 requests per minute for standard endpoints
  • 100 requests per minute for session creation
Rate limit headers are included in responses:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Requests remaining in window
  • X-RateLimit-Reset: Unix timestamp when limit resets

Next Steps