workflows

Generate an Executive Snapshot (1-2 slide leadership-facing RAG report)

Smallest agile archetype — designed to read in <30 seconds.

Slide 1: Big RAG status banner (ON TRACK / AT RISK / OFF TRACK) + 4 KPI tiles (completion, velocity, cycle time, defect rate) + key updates list. Slide 2 (optional): Velocity & throughput trend chart + 3-5 explanatory bullets.

Audience: executives, sponsors, steering committees. Cadence: weekly or per-sprint. Scope: project (with project_id) or workspace-wide.

Modes: connection_id (we fetch from Zoho) or prepared_data (SprintMetrics-shaped dict). Pricing $0.06 per report (2 × $0.03).

post/v1/workflows/agile/executive-snapshot

Request

  • Base URL: https://api.slideforge.dev
  • URL: https://api.slideforge.dev/v1/workflows/agile/executive-snapshot
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

connection_idstring nullable

OAuth connection (from /v1/oauth/{vendor}/authorize flow). Workspace-wide aggregation when project_id is omitted.

project_idstring nullable

Project ID (single-project mode); omit for workspace-wide aggregation.

sprint_historyinteger

Number of past sprints for trending

staging_dataobject nullable

Caller-supplied canonical entities (SprintData, etc). NOT YET implemented.

prepared_dataobject nullable

Pre-computed SprintMetrics-shaped dict — render only. Keys match SprintMetrics dataclass fields.

theme_idstring
optionsobject

Workflow-specific options, e.g. {exclude_slides: [...]}

Response

Report queued — poll GET /v1/jobs/{deck_id}

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.