Core Concepts

DeckFlow provides a unified, developer-first platform for presentation generation, revamping, translation, and file utility processing. All operations run under the base URL https://app.deckflow.com/api and require authentication via the HTTP Authorization header.

1. Core Workflows

DeckFlow features three primary product workflows along with a set of standalone file utilities:

Create (Generation)

Intelligently generates professional slides (PPTX) from raw sources:

• Supported Inputs: Local documents (PDF, Word, Markdown), Web URLs, or plain text prompts.
• Controls: Fine-tune generation using parameters like target slide count (pageCount), aspect ratio, target audience, author metadata, and toggle flags such as web search (enableSearch) or advanced reasoning models (advancedModel).

Revamp (Redesign)

Redesigns the visual style of existing decks while preserving their content, text, data, and layout hierarchy:

• Supported Inputs: PPTX, Keynote, or PDF files.
• Styling Options: Apply custom workspace Brand DNA guidelines or select from prebuilt professional templates.

Translate

Translates document layouts into different languages while preserving the typography, design, and animations:

• Supported Inputs: PPTX, Keynote, PDF, Word, or Excel files.
• Custom Glossary: Bind a custom terminology mapping (Glossary) to enforce consistent translation of brand names or specific technical terms.

2. Domain Entities

Asynchronous Task (Task)

All resource-heavy operations are driven by an asynchronous task pipeline:

1. Task Submission: Posting options to POST /tools/tasks immediately registers the request and yields a unique taskId.
2. Task Status Polling: Track progress using GET /tools/tasks/{taskId}.
3. Task States:
   • queued: Awaiting backend engine resource allocation.
   • running: Processing, rendering, or rewriting the file.
   • completed: Finished successfully. The final asset is available via result.url.
   • failed: Encountered errors. The reason is detailed in the error block.

Quotas (Credit & Spark)

Usage is metered using two balance pools:

• Credit: Meters standard document conversion, layout analysis, basic generation, translation, and OCR tasks.
• Spark: Meters heavy computational tasks, such as video compression, reasoning AI generation models, and processing exceptionally large assets.

Brand DNA

A style configuration workspace file that specifies corporate color themes, font groups, layout grids, and background templates. Referenced in Create and Revamp workflows to align design outputs with brand identity guidelines.

Glossary

A terminology mapping profile containing language pairs. Enforced during translation tasks to guarantee consistent nomenclature across translated documents.