Skip to content

REST API Reference

  • Managed: https://cell.synapserun.dev
  • Self-hosted: http://localhost:8001
Authorization: Bearer cell_sk_live_...
MethodPathDescription
GET/v1/healthHealth check
GET/v1/metricsUsage metrics
GET/v1/statsDashboard stats
MethodPathDescription
POST/v1/cellsCreate a cell
GET/v1/cellsList cells (paginated)
GET/v1/cells/{id}Get cell info
DELETE/v1/cells/{id}Kill a cell
MethodPathDescription
PUT/v1/cells/{id}/timeoutSet timeout
POST/v1/cells/{id}/refreshReset timer
GET/v1/cells/{id}/is_runningHeartbeat
POST/v1/cells/{id}/pausePause + snapshot
POST/v1/cells/{id}/resumeResume
GET/v1/cells/{id}/snapshotsList snapshots
MethodPathDescription
POST/v1/cells/{id}/execExecute code (blocking)
POST/v1/cells/{id}/exec/streamExecute code (SSE)
POST/v1/cells/{id}/cmdShell command
MethodPathDescription
POST/v1/cells/{id}/filesWrite file
GET/v1/cells/{id}/files?path=Read file
DELETE/v1/cells/{id}/files?path=Remove file
GET/v1/cells/{id}/files/listList directory
GET/v1/cells/{id}/files/existsCheck existence
GET/v1/cells/{id}/files/infoFile metadata
POST/v1/cells/{id}/files/mkdirCreate directory
POST/v1/cells/{id}/files/renameRename/move
MethodPathDescription
GET/v1/cells/{id}/processesList processes
GET/v1/cells/{id}/processes/{cmd}Poll process
POST/v1/cells/{id}/processes/{cmd}/killKill process
POST/v1/cells/{id}/processes/{cmd}/stdinSend stdin
MethodPathDescription
POST/v1/templatesRegister template
GET/v1/templatesList templates
GET/v1/templates/{name}Get template info
PATCH/v1/templates/{name}Update template
DELETE/v1/templates/{name}Delete template
MethodPathDescription
POST/v1/cells/{id}/fetchHTTP proxy
MethodPathDescription
GET/v1/eventsGlobal lifecycle events (last 100)
GET/v1/cells/{id}/eventsPer-cell lifecycle events
POST/v1/webhooksRegister a webhook
GET/v1/webhooksList all webhooks
DELETE/v1/webhooks/{webhook_id}Delete a webhook

The full OpenAPI 3.0.3 spec is available at:

GET /v1/openapi.yaml