Document Generator

Overview

The Allternit Document Generator (services/document-generator) is a FastAPI skill server that generates office artifacts: photo-card decks, study guides and rubric spreadsheets. It can also create a Canvas LMS module. Generated files are uploaded to SharePoint and the response returns the file URL. Status: Implementation IMPLEMENTED / Exposure INTERNAL. The service is not mounted behind api.allternit.com; run it yourself and call it directly. The Agent Swarm document-generator tool is the HTTP bridge to it.

Run locally

cd services/document-generator
pip install -r requirements.txt
export API_KEY=your-secret-api-key
uvicorn main:app --host 0.0.0.0 --port 8000

SharePoint upload uses TENANT_ID, CLIENT_ID and CLIENT_SECRET. If API_KEY is unset the service falls back to the placeholder your-secret-api-key; always set your own.

Authentication

Action endpoints require the X-API-Key header, compared against API_KEY.

Endpoints

Method	Path	Description
GET	`/health`	Health check (`ok`, `service`, `version`, `time_utc`)
POST	`/actions/generatePhotoCardDeck`	Generate a PPTX photo-card deck
POST	`/actions/generateStudyGuide`	Generate a DOCX or PDF study guide
POST	`/actions/generateRubricSpreadsheet`	Generate an XLSX rubric, tracker or calculator
POST	`/actions/createCanvasModule`	Create a module in a Canvas course (`course_id`, `name`)

Request fields

Endpoint	Fields
`generatePhotoCardDeck`	`title` (required), `audience`, `slide_count` (4-10, default 6), `deck_style` (default `photo_card`), `key_points`, `outline`, `images`, `citations`, `sharepoint_target`, `output`, `request_meta`
`generateStudyGuide`	`topic` (required), `audience`, `format` (`docx` default, or `pdf`), `length` (default `short`), `learning_objectives`, `key_terms`, `include_self_check`, `examples`, `citations`, `sharepoint_target`, `output`, `request_meta`
`generateRubricSpreadsheet`	`template_type` (required), `title`, `columns`, `rows`, `validation`, `formulas`, `citations`, `sharepoint_target`, `output`, `request_meta`

Example: study guide

curl -X POST http://127.0.0.1:8000/actions/generateStudyGuide \
  -H 'X-API-Key: your-secret-api-key' \
  -H 'content-type: application/json' \
  -d '{
    "topic": "Cell Biology",
    "format": "docx",
    "length": "short",
    "learning_objectives": ["Describe the cell membrane"],
    "key_terms": ["nucleus", "mitochondria"]
  }'

Artifact responses share one shape:

{
  "request_id": "req_0123456789abcdef",
  "artifact_type": "docx",
  "file_name": "cell-biology-study-guide.docx",
  "sharepoint_file_url": "https://...",
  "expires_at_utc": null,
  "warnings": []
}

Get Started

Allternit Factory

Workspace workflows

Architecture

Work Runtime

Cognitive Runtime

Context & Memory

Tools & Execution

Verification & Safety

Observability & Evaluation

Kernel Contracts

Build on Allternit

Operations

Reference

Core Concepts

Gizzi Code CLI

Tools & ACI

Security & Enterprise

Admin API

BYOC Runtime

Surfaces

CI CD

Guides

Cookbooks

Release Notes

Overview

Run locally

Authentication

Endpoints

Request fields

Example: study guide

​Overview

​Run locally

​Authentication

​Endpoints

​Request fields

​Example: study guide

​Related pages

Overview

Run locally

Authentication

Endpoints

Request fields

Example: study guide

Related pages