Workflow
Pipeline workflow
Use this sequence when an agent needs to create or update a project, run pipeline stages, inspect status, and verify artifacts.
End-to-end command
pds projects create --name automation-demo --idempotency-key automation-demo:create --json
pds script set --project automation-demo --file main_script.md --idempotency-key automation-demo:script --json
pds pipeline plan --project automation-demo --to audit --json
pds pipeline run --project automation-demo --to audit --dry-run --wait --json
pds pipeline run --project automation-demo --to audit --idempotency-key automation-demo:audit --wait --json
pds artifacts list --project automation-demo --jsonRequired inputs and scopes
- Required input file: source script.
- Required project context: an existing project id or permission to create a project.
- Required scopes: project:create, project:read, project:write, pipeline:run, artifact:read.
Project source artifact prerequisites
- Source script is required.
- Reference Catalog and selected Style Guide may already exist on the project.
- Selected Style Guide is not a timing manifest and is not a Phase 1 agent API endpoint.
- Style Guide freshness can mark tts-script, references, specs, veo, compositions, music, and audit stale.
- Distribution becomes stale through downstream render, audit, and package fingerprints rather than direct Style Guide freshness.
Dry-run path
pds pipeline run --project automation-demo --to audit --dry-run --wait --jsonLong-running status path
pds pipeline status --project automation-demo --json- 01setup
- 02script
- 03references
- 04tts-script
- 05tts-render
- 06audio-sync
- 07specs
- 08veo
- 09compositions
- 10music
- 11render
- 12stitch
- 13audit
- 14distribution-package
- 15distribution-publish
- The human UI combines render and stitch under Render.
- The human UI combines distribution-package and distribution-publish under Distribution.
- The agent status API keeps those stages separate so automation can distinguish packaging, upload, render, and stitch failures.
The 15-stage agent view is setup, script, references, tts-script, tts-render, audio-sync, specs, veo, compositions, music, render, stitch, audit, distribution-package, distribution-publish. Async steps stream or poll progress while synchronous runner steps return JSON and should be followed by status refresh.
Verification checklist
- CLI exit code is 0.
- JSON or JSONL payload parses.
- Returned ok, data, or a command-specific result field is present.
- Long-running commands returned or resolved a runId.
- Status or artifacts were verified with a follow-up command.
Common public failure modes
- Missing script or project selection.
- Token lacks project, pipeline, or artifact scopes.
- A stage is stale after source artifact changes.
- Audit, quota, timeout, or provider failures. Preserve error.code for triage.