API Reference

NeoRun provides a REST API for programmatic access to deployments, pods, and project management.

Authentication

All API requests require authentication via one of:


curl -H "X-API-Key: neo_sk_your_key_here" \
  https://api.neorun.dev/v1/pods

Create API keys in Settings → API Keys. Keys support expiration (30d, 90d, 1y, or never).


curl -H "Authorization: Bearer <supabase_jwt>" \
  https://api.neorun.dev/v1/pods


https://api.neorun.dev/v1


GET /projects

Returns all projects owned by the authenticated user.


POST /projects
Content-Type: application/json
 
{
  "repo_url": "https://github.com/user/repo",
  "name": "My Project"
}


GET /jobs/{job_id}

Returns current job status, build steps, and timing information.


POST /jobs
Content-Type: application/json
 
{
  "project_id": "uuid",
  "gpu_config": {
    "enabled": true,
    "min_vram_gb": 8
  }
}


POST /jobs/{job_id}/cancel


GET /pods

Returns all running and stopped pods.


POST /pods/{pod_id}/stop


POST /pods/{pod_id}/start


DELETE /pods/{pod_id}


GET /pods/{pod_id}/logs?tail=100


GET /health

Returns worker status, Docker availability, GPU info, and queue depth.

Rate limits are per-user and use a sliding window algorithm.

All errors follow this format:


{
  "error": "Human-readable error message",
  "code": "ERROR_CODE",
  "status": 400
}

Common status codes:

Code	Meaning
401	Missing or invalid authentication
403	Insufficient permissions or quota exceeded
404	Resource not found
429	Rate limit exceeded
500	Internal server error

Subscribe to build and pod lifecycle events via webhooks.