REST API

Manage your account's resources over HTTP with a bearer API key.

View as MarkdownOpen in ClaudeOpen in ChatGPT

The REST API lives under https://api.gheima.ma/v1 and covers what you do in the dashboard. Authenticate with an API key as a bearer token. The rate limit is per key and depends on your plan, from 60 requests per minute on Free to 1,200 on Agency. The X-RateLimit-* response headers show what you have left. The full machine-readable spec is at /api/v1/openapi.json.

Shell
# List services (cursor-paginated: ?limit=&cursor=&type=WEB|WORKER|STATIC)
curl "https://api.gheima.ma/v1/services?limit=20" \
  -H "Authorization: Bearer gh_xxxxx"

# Create a service
curl -X POST https://api.gheima.ma/v1/services \
  -H "Authorization: Bearer gh_xxxxx" -H "content-type: application/json" \
  -d '{"projectId":"prj_1","name":"web","repoUrl":"https://github.com/me/app"}'

# Trigger a deployment -> 202 { deploymentId }
curl -X POST https://api.gheima.ma/v1/services/<id>/deploy \
  -H "Authorization: Bearer gh_xxxxx"

List endpoints are cursor-paginated. Pass ?limit= (1 to 100, default 20) and ?cursor=, then read the next cursor from pagination.nextCursor in the response.

✦ Any language that can make an HTTP request can drive Gheima.