API Overview
The plutonium.io API follows REST conventions and returns JSON responses.
Base URL
https://api.plutonium.io/v1
Authentication
All requests require a bearer token in the Authorization header:
curl -H "Authorization: Bearer $PLUTONIUM_TOKEN" \
https://api.plutonium.io/v1/projects
Generate tokens from your account settings or via the CLI:
plutonium auth token --scope read,write
Response Format
Every response wraps data in a standard envelope:
{
"data": { ... },
"meta": {
"request_id": "req_abc123",
"timestamp": "2025-01-15T10:30:00Z"
}
}
Error responses include a code and message:
{
"error": {
"code": "not_found",
"message": "Project 'my-project' does not exist"
}
}
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /projects | List all projects |
POST | /projects | Create a project |
GET | /projects/:id | Get project details |
DELETE | /projects/:id | Delete a project |
POST | /projects/:id/deploy | Trigger a deploy |
GET | /projects/:id/deploys | List deploy history |
Rate Limits
The API enforces rate limits per token:
- Read endpoints: 100 requests/minute
- Write endpoints: 20 requests/minute
When rate-limited, the response includes a Retry-After header.