API Reference

Welcome to the Ercent API reference. Our API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API Integration

Seamlessly connect your existing tools and workflows with our robust integration endpoints.

API Development

Build, test, and deploy powerful APIs with our comprehensive development suite.

AI Solutions

Leverage cutting-edge AI models to enhance your applications with intelligence.

Authentication

Authenticate your API requests using your API key. You can manage your API keys in the dashboard.

BASH

curl https://api.ercent.com/v1/projects \
-H "Authorization: Bearer YOUR_API_KEY"

Pagination

Ercent's API uses cursor-based pagination. Responses that return a list of resources will include a has_more boolean and potentially a next_cursor to retrieve the next page.

Errors

Ercent uses standard HTTP response codes to indicate the success or failure of an API request.

400 Bad RequestThe request was acceptable, but the server cannot process it.

401 UnauthorizedThe request lacks valid authentication credentials.

404 Not FoundThe requested resource could not be found.

429 Too Many RequestsYou have hit the rate limit. Please backup and retry.

Rate Limiting

The API is rate limited to 100 requests per minute per API key. You can check the returned HTTP headers to see your current status.

Users

Manage user profiles and settings.

GET/v1/users/me

Retrieves the currently authenticated user.

Projects

Projects organize your deployments and resources.

GET/v1/projects

{ "data": [ { "id": "proj_123", "name": "My First Project", "created_at": "2024-12-27T10:00:00Z" } ], "has_more": false }

Deployments

Manage and trigger deployments programmatically.

POST/v1/deployments

Trigger a new deployment from a git ref or id.

Webhooks

Listen for events on your projects.

GET/v1/webhooks