Covendocs
API ReferenceActionsRoute a control-plane action POST
Report issue

Route a control-plane action

Route a control-plane action to a live Coven session via the daemon socket API.

1 min read

POST
/actions

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/actions" \  -H "Content-Type: application/json" \  -d '{    "action": "coven.capabilities.refresh",    "origin": "coven-client",    "args": {}  }'
{
  "ok": true,
  "accepted": true,
  "action": "coven.capabilities.refresh",
  "status": "completed",
  "event": {
    "kind": "capabilities.refreshed",
    "action": "coven.capabilities.refresh",
    "origin": "coven-client",
    "payload": {
      "capabilities": 3
    }
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "Required field \"sessionId\" is missing.",
    "details": {
      "field": "sessionId"
    }
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "Unknown control-plane action id.",
    "details": {
      "action": "coven.unknown.thing"
    }
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "Unexpected internal daemon error.",
    "details": {}
  }
}
Was this page helpful?No