find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/slideforge-dev:slideforge-dev-workflows-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SlideForge Workflows API
  description: 'Agent-first PowerPoint generation. Send structured slide intents (a `form` plus typed fields) or a brief; get back a real, editable `.pptx`. The draw path is deterministic — no model renders your slide, so supplied numbers and text come out verbatim. Every response carries `status`, `fidelity` and `warnings` so an automated caller can tell whether the output is usable. $0.05 per slide; an unusable slide is not billed. Authenticate with a SlideForge API key (`Authorization: Bearer sf_live_…` or `X-API-Key`) — new accounts include 60 free slides, no credit card: https://slideforge.dev/sign-up'
  version: 5.356.0
servers:
- url: https://api.slideforge.dev
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Workflows
paths:
  /v1/workflows/consulting-deck:
    post:
      tags:
      - Workflows
      summary: Generate a consulting-quality slide deck from a topic
      description: 'One call → finished consulting deck. Provide a topic and audience; the API generates a narrative outline, routes each slide through the intent engine, renders in parallel, and compiles into a single PPTX.


        Internally uses the same pipeline as POST /v1/deck (auto-brief mode) with a consulting-optimized prompt that structures each slide with a narrative role (hook, evidence, framework, recommendation, close).


        **Pricing:** $0.05 per slide, typically $0.30-$1.20 for a 6-slide deck.


        **Duration:** ~15-60s depending on slide count.'
      operationId: consulting_deck_v1_workflows_consulting_deck_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsultingDeckRequest'
        required: true
      responses:
        '202':
          description: Deck generation started — poll GET /v1/jobs/{deck_id}
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '402':
          description: Insufficient balance
        '503':
          description: Service not configured
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/:
    get:
      tags:
      - Workflows
      summary: List registered workflows
      description: Catalogue of all available workflow archetypes (filterable by family).
      operationId: list_workflows_v1_workflows__get
      parameters:
      - name: family
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Family
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/agile/sprint-retrospective:
    post:
      tags:
      - Workflows
      summary: Generate a Sprint Retrospective deck (team-internal per-sprint reflection)
      description: 'Team-internal per-sprint reflection deck. 6 slides: Executive Dashboard, Project & Status Breakdown, Sprint Trends, Epic Progress, Development Summary, Highlights & Risks.


        **Audience:** Scrum Master, team, PO.

        **Cadence:** end of every sprint.

        **Scope:** project (with project_id) or workspace-wide (project_id omitted).


        **Modes:** `connection_id` (we fetch from Zoho), `prepared_data` (you give us a SprintMetrics-shaped dict). Pricing $0.18 per report (6 × $0.03).'
      operationId: agile_sprint_retrospective_v1_workflows_agile_sprint_retrospective_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgileWorkflowRequest'
        required: true
      responses:
        '202':
          description: Report queued — poll GET /v1/jobs/{deck_id}
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/agile/executive-snapshot:
    post:
      tags:
      - Workflows
      summary: Generate an Executive Snapshot (1-2 slide leadership-facing RAG report)
      description: '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).'
      operationId: agile_executive_snapshot_v1_workflows_agile_executive_snapshot_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgileWorkflowRequest'
        required: true
      responses:
        '202':
          description: Report queued — poll GET /v1/jobs/{deck_id}
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/agile/sprint-review:
    post:
      tags:
      - Workflows
      summary: Generate a Sprint Review deck (outward-facing per-sprint communication)
      description: 'Outward-facing per-sprint deck for stakeholders. 6 slides:

        1. Executive Dashboard (6 KPIs)

        2. Sprint Burndown (ideal-line dashed + actual line — research convention)

        3. Velocity History (last N sprints + 3-sprint rolling average overlay)

        4. Completed Work (closed items, epic-grouped)

        5. Rollover (items still in flight at sprint end)

        6. Highlights & Risks (auto-detected signals)


        **Audience:** PO, team, stakeholders.

        **Cadence:** end of every sprint.

        **Scope:** project (with project_id) or workspace-wide.


        **Modes:** `connection_id` or `prepared_data`. Pricing $0.18 (6 × $0.03).'
      operationId: agile_sprint_review_v1_workflows_agile_sprint_review_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgileWorkflowRequest'
        required: true
      responses:
        '202':
          description: Report queued — poll GET /v1/jobs/{deck_id}
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/agile/pi-progress:
    post:
      tags:
      - Workflows
      summary: Generate a PI Progress deck (SAFe-grade quarterly progress report)
      description: 'SAFe Program Increment / quarterly progress. 4 slides:

        1. Executive Dashboard (6 KPIs)

        2. PI Predictability (achievement % per sprint, 80-100% target band)

        3. Feature Burnup (per-epic progress)

        4. Highlights & Risks


        **Audience:** RTE, Product Mgmt, executives.

        **Cadence:** per PI (8-12 weeks) or quarterly.


        **Deferred** until source data exists: PI Objectives (BV scoring), Program Board (team-per-feature), Next-PI Preview (PI plan).'
      operationId: agile_pi_progress_v1_workflows_agile_pi_progress_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgileWorkflowRequest'
        required: true
      responses:
        '202':
          description: Report queued
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/workflows/agile/portfolio-health:
    post:
      tags:
      - Workflows
      summary: Generate a Portfolio Health deck (cross-portfolio executive view)
      description: 'Cross-portfolio executive view. 4 slides:

        1. Executive Dashboard (workspace KPIs)

        2. Project RAG Grid (per-project independent health status)

        3. Portfolio Epic Burnup (all epics across all projects)

        4. Highlights & Risks


        **Audience:** portfolio mgmt, executives, steering committees.

        **Cadence:** monthly or quarterly.

        **Scope:** workspace-only (single-project portfolio view doesn''t apply — project_id is silently ignored if provided).


        **Deferred** until source data exists: Portfolio Kanban with WIP limits, Capacity Allocation by value stream.'
      operationId: agile_portfolio_health_v1_workflows_agile_portfolio_health_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgileWorkflowRequest'
        required: true
      responses:
        '202':
          description: Report queued
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid input
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgileWorkflowRequest:
      properties:
        connection_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Connection Id
          description: OAuth connection (from /v1/oauth/{vendor}/authorize flow). Workspace-wide aggregation when project_id is omitted.
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Project ID (single-project mode); omit for workspace-wide aggregation.
        sprint_history:
          type: integer
          maximum: 8.0
          minimum: 0.0
          title: Sprint History
          description: Number of past sprints for trending
          default: 4
        staging_data:
          anyOf:
          - type: object
          - type: 'null'
          title: Staging Data
          description: Caller-supplied canonical entities (SprintData, etc). NOT YET implemented.
        prepared_data:
          anyOf:
          - type: object
          - type: 'null'
          title: Prepared Data
          description: Pre-computed SprintMetrics-shaped dict — render only. Keys match SprintMetrics dataclass fields.
        theme_id:
          type: string
          title: Theme Id
          default: slideforge_standard
        options:
          type: object
          title: Options
          description: 'Workflow-specific options, e.g. {exclude_slides: [...]}'
      type: object
      title: AgileWorkflowRequest
      description: "Shared request body for /v1/workflows/agile/* endpoints.\n\nThree input modes (mutually exclusive):\n  Mode A (stored OAuth): connection_id [+ project_id for single-project, omit for workspace-wide]\n  Mode B-staging: staging_data dict — NOT YET IMPLEMENTED in Phase A\n  Mode B-prepared: prepared_data dict (a SprintMetrics-shaped dict) → render only"
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ConsultingDeckRequest:
      properties:
        topic:
          type: string
          title: Topic
        audience:
          type: string
          title: Audience
          default: executive leadership
        slide_count:
          type: integer
          title: Slide Count
          default: 6
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
        tone:
          anyOf:
          - type: string
          - type: 'null'
          title: Tone
        theme_id:
          type: string
          title: Theme Id
          default: slideforge_standard
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        include_pdf:
          type: boolean
          title: Include Pdf
          default: false
      type: object
      required:
      - topic
      title: ConsultingDeckRequest
      description: POST /v1/workflows/consulting-deck request body.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'SlideForge API key: `Authorization: Bearer sf_live_…`. Create one at https://slideforge.dev/console/keys'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Same key, header form — for clients that cannot set Authorization.