Skip to content

API Path

If you are integrating Agirunner into another system, start with the platform API rather than with runtime internals.

That is an important product boundary. The platform API is the durable control-plane surface for workflows, tasks, workspaces, artifacts, logs, integrations, and runtime-facing management. The runtime is the execution system behind that control plane, not the primary public entry point for most integrators.

  1. authenticate with an API key or login token
  2. discover the workflow and playbook surfaces you need
  3. create or launch work
  4. inspect progress through workflow, task, log, and artifact endpoints

Even API-first adopters should spend a little time in the dashboard. The UI is the easiest place to understand the workflow model, the operator review surfaces, and the kinds of records the API is exposing.

The platform API is the public control-plane surface. Integrators generally talk to the platform, not directly to runtime internals.