Reference
HTTP API Reference
Public runtime HTTP endpoints with request examples
HTTP API Reference
User-facing runtime API. For most operations, CLI (
sma ...) is recommended first.
Core endpoints
GET /health
{ "status": "ok", "timestamp": "2026-03-08T12:00:00.000Z" }GET /api/status
{ "name": "shipmyagent", "status": "running", "timestamp": "..." }POST /api/execute
Request body:
{
"instructions": "Summarize today's changes",
"chatId": "default"
}Service runtime API
GET /api/services/list
List service runtime states.
POST /api/services/control
{ "serviceName": "chat", "action": "restart" }Supported action: start | stop | restart | status.
POST /api/services/command
{
"serviceName": "task",
"command": "list",
"payload": { "status": "enabled" }
}Extension runtime API
GET /api/extensions/list
List extension runtime states.
POST /api/extensions/control
{ "extensionName": "voice", "action": "status" }POST /api/extensions/command
{
"extensionName": "voice",
"command": "status",
"payload": {}
}Direct action routes
Each service/extension action also has a default route:
/service/<serviceName>/<actionName>/extension/<extensionName>/<actionName>
Examples:
POST /service/chat/sendGET /extension/voice/status
Debug baseline
Make sure runtime is up before calling APIs:
sma agent on
curl http://localhost:3000/health