API
The CLI is the recommended SDK surface for now.
The hosted API is available at:
https://api.wendellai.com
Health check:
curl /health
OpenAPI JSON:
curl /openapi/v1.json
Run these requests against the hosted API base above, or against your configured staging, preview, or local API when testing overrides.
Common API-backed CLI flows
| Flow | CLI commands |
|---|---|
| Register runner | wendell register |
| Create Playbook draft | wendell playbook create |
| Review Playbook summary | wendell playbook review |
| Apply review answers | wendell playbook apply |
| Approve summary | wendell playbook approve |
| Publish suite | wendell suites publish |
| Run suite | wendell run |
Authentication
The CLI sends a scoped runner API key.
Local credentials are read from:
~/.config/wendell/credentials.json
CI can provide:
WENDELL_INKPASS_API_KEY
Runner Scopes
Runner keys for hosted suites should use product-facing suite scopes:
wendell:test-suites:read
wendell:runs:create
wendell:runs:read
Playbook authoring and publishing keys also need:
wendell:test-suites:create
wendell:test-suites:update
wendell:test-suites:publish
Use the narrow run-only scopes for CI jobs that only execute an already published suite. Use the broader authoring scopes only for trusted automation that creates, reviews, generates, or publishes suites.