Shipplane
  • English

      • HTTP API

      Shipplane Lite exposes a JSON API under /api/v1. The built-in UI at /, /editor, and /registry uses the same routes. There is no stable public API contract yet, so routes and response shapes may change between releases.

      All responses use JSON. Error responses have a non-2xx status and the shape { "error": string }. Known business errors also include a code.

      Workflows — /api/v1/workflow

      MethodPathBodyDescription
      GET/—List all workflows.
      GET/:workflowID—Get a workflow and its template.
      POST/create{ template: string }Create a workflow from a template string.
      PUT/:workflowID{ template: string }Update a workflow's template.
      DELETE/:workflowID—Delete a workflow.
      POST/run{ workflowID: number }Start a run for a workflow.
      POST/:workflowID/cancel—Cancel the workflow's active run.
      GET/status/:workflowID—Get the workflow's current run status.
      GET/state/:workflowID—Get the workflow's full run state/snapshot.

      template is a JSON-encoded WorkflowDefinition. See @shipplane/core.

      Example — start a run:

      curl -X POST http://localhost:3000/api/v1/workflow/run \
  -H 'Content-Type: application/json' \
  -d '{"workflowID": 1}'

      Registry — /api/v1/registry

      MethodPathBodyDescription
      GET/—List available task type definitions, grouped by worker.
      curl http://localhost:3000/api/v1/registry

      The response shape is { "data": { "lite_worker": TaskRegistryDefinition[] } }. See Registry for the available task types.