API Reference

The Acme Platform API is a RESTful interface for managing projects, deployments, configurations, and users programmatically. All endpoints return JSON and require authentication via API key or OAuth 2.0 bearer token.

Base URL

https://api.acme-platform.com/v1

Authentication

Include your API key in the Authorization header with every request:

Authorization: Bearer acme_sk_live_abc123

See the Authentication guide for details on obtaining and managing keys.

Common Headers

Header	Required	Description
`Authorization`	Yes	Bearer token (API key or OAuth access token)
`Content-Type`	For POST/PUT	`application/json`
`Accept`	No	`application/json` (default)

Projects

List Projects

GET /v1/projects

Returns a paginated list of projects in the authenticated account.

Response:

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "my-project",
      "created_at": "2026-01-15T10:30:00Z",
      "status": "active"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

Create Project

POST /v1/projects

Request body:

{
  "name": "my-new-project",
  "deploy_target": "cloudflare-workers"
}

Deployments

Trigger Deployment

POST /v1/projects/:project_id/deployments

Request body:

{
  "environment": "production",
  "branch": "main"
}

List Deployments

GET /v1/projects/:project_id/deployments

Error Format

All errors follow a consistent structure:

{
  "error": {
    "code": "not_found",
    "message": "The requested resource does not exist.",
    "status": 404
  }
}

SDKs

Official client libraries are available for popular languages:

JavaScript/TypeScript: npm install @acme/sdk
Python: pip install acme-sdk
Go: go get github.com/acme-platform/sdk-go