Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Runtime REST API for programmatic access
https://app.runtm.com/api
Authorization header:
curl -H "Authorization: Bearer runtm_xxx" https://app.runtm.com/api/v0/deployments
runtm login
| Scope | Permissions |
|---|---|
read | List deployments, view logs, check status |
deploy | Create/update deployments (includes read) |
delete | Destroy deployments (includes read) |
admin | Full access including token management |
| Method | Endpoint | Description |
|---|---|---|
GET | /v0/deployments | List deployments |
POST | /v0/deployments | Create deployment |
GET | /v0/deployments/{id} | Get deployment |
DELETE | /v0/deployments/{id} | Delete deployment |
GET | /v0/deployments/search | Search deployments |
| Method | Endpoint | Description |
|---|---|---|
GET | /v0/deployments/{id}/logs | Get logs |
| Method | Endpoint | Description |
|---|---|---|
POST | /v0/deployments/{id}/domains | Add domain |
GET | /v0/deployments/{id}/domains/{hostname} | Get domain status |
DELETE | /v0/deployments/{id}/domains/{hostname} | Remove domain |
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/me | Get current user |
| Limit | Value |
|---|---|
| Deployments per hour | 10 |
| Max artifact size | 20 MB |
| Build timeout | 10 minutes |
| Deploy timeout | 5 minutes |
error field:
{
"detail": {
"error": "Deployment not found",
"deployment_id": "dep_invalid"
}
}
| Code | Meaning |
|---|---|
400 | Invalid request (bad parameters) |
401 | Invalid or missing API key |
403 | Insufficient permissions |
404 | Resource not found |
409 | Conflict (e.g., invalid state) |
413 | Artifact too large |
429 | Rate limit exceeded |
500 | Server error |
POST requests, use the Idempotency-Key header to ensure safe retries:
curl -X POST "https://app.runtm.com/api/v0/deployments" \
-H "Authorization: Bearer runtm_xxx" \
-H "Idempotency-Key: unique-request-id-123" \
-F "[email protected]" \
-F "[email protected]"
pip install runtm