Benjamin_Boenisch/breakpilot-pwa
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2026-02-15. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
ac1bb1d97bdfef59b3b9c4fa6c2000c34484f801
breakpilot-pwa/docs-site/api/backend-api/index.html
BreakPilot Dev 557305db5d
Some checks failed
ci/woodpecker/push/integration Pipeline failed
Details
ci/woodpecker/push/main Pipeline failed
Details
CI/CD Pipeline / Go Tests (push) Has been cancelled
Details
CI/CD Pipeline / Python Tests (push) Has been cancelled
Details
CI/CD Pipeline / Website Tests (push) Has been cancelled
Details
CI/CD Pipeline / Linting (push) Has been cancelled
Details
CI/CD Pipeline / Security Scan (push) Has been cancelled
Details
CI/CD Pipeline / Docker Build & Push (push) Has been cancelled
Details
CI/CD Pipeline / Integration Tests (push) Has been cancelled
Details
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
Details
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
Details
CI/CD Pipeline / CI Summary (push) Has been cancelled
Details
Security Scanning / Secret Scanning (push) Has been cancelled
Details
Security Scanning / Dependency Vulnerability Scan (push) Has been cancelled
Details
Security Scanning / Go Security Scan (push) Has been cancelled
Details
Security Scanning / Python Security Scan (push) Has been cancelled
Details
Security Scanning / Node.js Security Scan (push) Has been cancelled
Details
Security Scanning / Docker Image Security (push) Has been cancelled
Details
Security Scanning / Security Summary (push) Has been cancelled
Details
Tests / Go Tests (push) Has been cancelled
Details
Tests / Python Tests (push) Has been cancelled
Details
Tests / Integration Tests (push) Has been cancelled
Details
Tests / Go Lint (push) Has been cancelled
Details
Tests / Python Lint (push) Has been cancelled
Details
Tests / Security Scan (push) Has been cancelled
Details
Tests / All Checks Passed (push) Has been cancelled
Details
feat: Add Academy, Whistleblower, Incidents SDK modules, pitch-deck, blog and CI/CD config 
- Academy, Whistleblower, Incidents frontend pages with API proxies and types
- Vendor compliance API proxy route
- Go backend handlers and models for all new SDK modules
- Investor pitch-deck app with interactive slides
- Blog section with DSGVO, AI Act, NIS2, glossary articles
- MkDocs documentation site
- CI/CD pipelines (Woodpecker, GitHub Actions), security scanning config
- Planning and implementation documentation

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 21:12:16 +01:00

3133 lines
70 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="de" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://macmini:8008/api/backend-api/">
<link rel="prev" href="../../services/ai-compliance-sdk/SBOM/">
<link rel="next" href="../../development/testing/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>Backend API - Breakpilot Dokumentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#breakpilot-backend-api-dokumentation" class="md-skip">
Zum Inhalt
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Kopfzeile">
<a href="../.." title="Breakpilot Dokumentation" class="md-header__button md-logo" aria-label="Breakpilot Dokumentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Breakpilot Dokumentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Backend API
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo" aria-label="Dark Mode aktivieren" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode aktivieren" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="indigo" aria-label="Light Mode aktivieren" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode aktivieren" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Suche" placeholder="Suche" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Suche">
<button type="reset" class="md-search__icon md-icon" title="Zurücksetzen" aria-label="Zurücksetzen" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Suche wird initialisiert
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Hauptnavigation" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Start
</a>
</li>
<li class="md-tabs__item">
<a href="../../getting-started/environment-setup/" class="md-tabs__link">
Erste Schritte
</a>
</li>
<li class="md-tabs__item">
<a href="../../architecture/system-architecture/" class="md-tabs__link">
Architektur
</a>
</li>
<li class="md-tabs__item">
<a href="../../services/ki-daten-pipeline/" class="md-tabs__link">
Services
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
API
</a>
</li>
<li class="md-tabs__item">
<a href="../../development/testing/" class="md-tabs__link">
Entwicklung
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Breakpilot Dokumentation" class="md-nav__button md-logo" aria-label="Breakpilot Dokumentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
Breakpilot Dokumentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Start
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Erste Schritte
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Erste Schritte
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../getting-started/environment-setup/" class="md-nav__link">
<span class="md-ellipsis">
Umgebung einrichten
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/mac-mini-setup/" class="md-nav__link">
<span class="md-ellipsis">
Mac Mini Setup
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Architektur
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Architektur
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../architecture/system-architecture/" class="md-nav__link">
<span class="md-ellipsis">
Systemuebersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/auth-system/" class="md-nav__link">
<span class="md-ellipsis">
Auth-System
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/mail-rbac-architecture/" class="md-nav__link">
<span class="md-ellipsis">
Mail-RBAC
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/multi-agent/" class="md-nav__link">
<span class="md-ellipsis">
Multi-Agent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/secrets-management/" class="md-nav__link">
<span class="md-ellipsis">
Secrets Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/devsecops/" class="md-nav__link">
<span class="md-ellipsis">
DevSecOps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/sdk-protection/" class="md-nav__link">
<span class="md-ellipsis">
SDK Protection
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/environments/" class="md-nav__link">
<span class="md-ellipsis">
Environments
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/zeugnis-system/" class="md-nav__link">
<span class="md-ellipsis">
Zeugnis-System
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Services
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Services
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_1" >
<label class="md-nav__link" for="__nav_4_1" id="__nav_4_1_label" tabindex="0">
<span class="md-ellipsis">
KI-Daten-Pipeline
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_1">
<span class="md-nav__icon md-icon"></span>
KI-Daten-Pipeline
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../services/ki-daten-pipeline/" class="md-nav__link">
<span class="md-ellipsis">
Uebersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/ki-daten-pipeline/architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architektur
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Klausur-Service
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Klausur-Service
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../services/klausur-service/" class="md-nav__link">
<span class="md-ellipsis">
Uebersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/byoeh-system-erklaerung/" class="md-nav__link">
<span class="md-ellipsis">
BYOEH Systemerklaerung
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/BYOEH-Architecture/" class="md-nav__link">
<span class="md-ellipsis">
BYOEH Architektur
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/BYOEH-Developer-Guide/" class="md-nav__link">
<span class="md-ellipsis">
BYOEH Developer Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/NiBiS-Ingestion-Pipeline/" class="md-nav__link">
<span class="md-ellipsis">
NiBiS Pipeline
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/OCR-Labeling-Spec/" class="md-nav__link">
<span class="md-ellipsis">
OCR Labeling
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/OCR-Compare/" class="md-nav__link">
<span class="md-ellipsis">
OCR Compare
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/RAG-Admin-Spec/" class="md-nav__link">
<span class="md-ellipsis">
RAG Admin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/klausur-service/Worksheet-Editor-Architecture/" class="md-nav__link">
<span class="md-ellipsis">
Worksheet Editor
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../services/voice-service/" class="md-nav__link">
<span class="md-ellipsis">
Voice-Service
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/agent-core/" class="md-nav__link">
<span class="md-ellipsis">
Agent-Core
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_5" >
<label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0">
<span class="md-ellipsis">
AI-Compliance-SDK
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_5">
<span class="md-nav__icon md-icon"></span>
AI-Compliance-SDK
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../services/ai-compliance-sdk/" class="md-nav__link">
<span class="md-ellipsis">
Uebersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/ai-compliance-sdk/ARCHITECTURE/" class="md-nav__link">
<span class="md-ellipsis">
Architektur
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/ai-compliance-sdk/DEVELOPER/" class="md-nav__link">
<span class="md-ellipsis">
Developer Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/ai-compliance-sdk/AUDITOR_DOCUMENTATION/" class="md-nav__link">
<span class="md-ellipsis">
Auditor Dokumentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../services/ai-compliance-sdk/SBOM/" class="md-nav__link">
<span class="md-ellipsis">
SBOM
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Backend API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Backend API
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Inhaltsverzeichnis">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Inhaltsverzeichnis
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#ubersicht" class="md-nav__link">
<span class="md-ellipsis">
Übersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#worksheets-api" class="md-nav__link">
<span class="md-ellipsis">
Worksheets API
</span>
</a>
<nav class="md-nav" aria-label="Worksheets API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-worksheetsgeneratemultiple-choice" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/multiple-choice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratecloze" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/cloze
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratemindmap" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/mindmap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratequiz" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/quiz
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#corrections-api" class="md-nav__link">
<span class="md-ellipsis">
Corrections API
</span>
</a>
<nav class="md-nav" aria-label="Corrections API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-corrections" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-correctionsidupload" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/{id}/upload
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-correctionsid" class="md-nav__link">
<span class="md-ellipsis">
GET /corrections/{id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-correctionsidanalyze" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/{id}/analyze
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-correctionsidexport-pdf" class="md-nav__link">
<span class="md-ellipsis">
GET /corrections/{id}/export-pdf
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#letters-api" class="md-nav__link">
<span class="md-ellipsis">
Letters API
</span>
</a>
<nav class="md-nav" aria-label="Letters API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-letters" class="md-nav__link">
<span class="md-ellipsis">
POST /letters/
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-lettersimprove" class="md-nav__link">
<span class="md-ellipsis">
POST /letters/improve
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#state-engine-api" class="md-nav__link">
<span class="md-ellipsis">
State Engine API
</span>
</a>
<nav class="md-nav" aria-label="State Engine API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-statedashboard" class="md-nav__link">
<span class="md-ellipsis">
GET /state/dashboard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-statesuggestions" class="md-nav__link">
<span class="md-ellipsis">
GET /state/suggestions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-statemilestone" class="md-nav__link">
<span class="md-ellipsis">
POST /state/milestone
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#klausur-korrektur-api-abitur" class="md-nav__link">
<span class="md-ellipsis">
Klausur-Korrektur API (Abitur)
</span>
</a>
<nav class="md-nav" aria-label="Klausur-Korrektur API (Abitur)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#klausur-modi" class="md-nav__link">
<span class="md-ellipsis">
Klausur-Modi
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-klausur-korrekturklausuren" class="md-nav__link">
<span class="md-ellipsis">
POST /klausur-korrektur/klausuren
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-klausur-korrekturstudentsidevaluate" class="md-nav__link">
<span class="md-ellipsis">
POST /klausur-korrektur/students/{id}/evaluate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#15-punkte-notenschlussel" class="md-nav__link">
<span class="md-ellipsis">
15-Punkte-Notenschlüssel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bewertungskriterien" class="md-nav__link">
<span class="md-ellipsis">
Bewertungskriterien
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#security-api-devsecops-dashboard" class="md-nav__link">
<span class="md-ellipsis">
Security API (DevSecOps Dashboard)
</span>
</a>
<nav class="md-nav" aria-label="Security API (DevSecOps Dashboard)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-v1securitytools" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-v1securityfindings" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/findings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-v1securitysbom" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/sbom
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-v1securityscantype" class="md-nav__link">
<span class="md-ellipsis">
POST /v1/security/scan/{type}
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#fehler-responses" class="md-nav__link">
<span class="md-ellipsis">
Fehler-Responses
</span>
</a>
<nav class="md-nav" aria-label="Fehler-Responses">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#400-bad-request" class="md-nav__link">
<span class="md-ellipsis">
400 Bad Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#401-unauthorized" class="md-nav__link">
<span class="md-ellipsis">
401 Unauthorized
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#404-not-found" class="md-nav__link">
<span class="md-ellipsis">
404 Not Found
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#500-internal-server-error" class="md-nav__link">
<span class="md-ellipsis">
500 Internal Server Error
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Entwicklung
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Entwicklung
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../development/testing/" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../development/documentation/" class="md-nav__link">
<span class="md-ellipsis">
Dokumentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../development/ci-cd-pipeline/" class="md-nav__link">
<span class="md-ellipsis">
CI/CD Pipeline
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Inhaltsverzeichnis">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Inhaltsverzeichnis
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#ubersicht" class="md-nav__link">
<span class="md-ellipsis">
Übersicht
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#worksheets-api" class="md-nav__link">
<span class="md-ellipsis">
Worksheets API
</span>
</a>
<nav class="md-nav" aria-label="Worksheets API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-worksheetsgeneratemultiple-choice" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/multiple-choice
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratecloze" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/cloze
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratemindmap" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/mindmap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-worksheetsgeneratequiz" class="md-nav__link">
<span class="md-ellipsis">
POST /worksheets/generate/quiz
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#corrections-api" class="md-nav__link">
<span class="md-ellipsis">
Corrections API
</span>
</a>
<nav class="md-nav" aria-label="Corrections API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-corrections" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-correctionsidupload" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/{id}/upload
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-correctionsid" class="md-nav__link">
<span class="md-ellipsis">
GET /corrections/{id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-correctionsidanalyze" class="md-nav__link">
<span class="md-ellipsis">
POST /corrections/{id}/analyze
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-correctionsidexport-pdf" class="md-nav__link">
<span class="md-ellipsis">
GET /corrections/{id}/export-pdf
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#letters-api" class="md-nav__link">
<span class="md-ellipsis">
Letters API
</span>
</a>
<nav class="md-nav" aria-label="Letters API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-letters" class="md-nav__link">
<span class="md-ellipsis">
POST /letters/
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-lettersimprove" class="md-nav__link">
<span class="md-ellipsis">
POST /letters/improve
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#state-engine-api" class="md-nav__link">
<span class="md-ellipsis">
State Engine API
</span>
</a>
<nav class="md-nav" aria-label="State Engine API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-statedashboard" class="md-nav__link">
<span class="md-ellipsis">
GET /state/dashboard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-statesuggestions" class="md-nav__link">
<span class="md-ellipsis">
GET /state/suggestions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-statemilestone" class="md-nav__link">
<span class="md-ellipsis">
POST /state/milestone
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#klausur-korrektur-api-abitur" class="md-nav__link">
<span class="md-ellipsis">
Klausur-Korrektur API (Abitur)
</span>
</a>
<nav class="md-nav" aria-label="Klausur-Korrektur API (Abitur)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#klausur-modi" class="md-nav__link">
<span class="md-ellipsis">
Klausur-Modi
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-klausur-korrekturklausuren" class="md-nav__link">
<span class="md-ellipsis">
POST /klausur-korrektur/klausuren
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-klausur-korrekturstudentsidevaluate" class="md-nav__link">
<span class="md-ellipsis">
POST /klausur-korrektur/students/{id}/evaluate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#15-punkte-notenschlussel" class="md-nav__link">
<span class="md-ellipsis">
15-Punkte-Notenschlüssel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bewertungskriterien" class="md-nav__link">
<span class="md-ellipsis">
Bewertungskriterien
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#security-api-devsecops-dashboard" class="md-nav__link">
<span class="md-ellipsis">
Security API (DevSecOps Dashboard)
</span>
</a>
<nav class="md-nav" aria-label="Security API (DevSecOps Dashboard)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-v1securitytools" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-v1securityfindings" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/findings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-v1securitysbom" class="md-nav__link">
<span class="md-ellipsis">
GET /v1/security/sbom
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#post-v1securityscantype" class="md-nav__link">
<span class="md-ellipsis">
POST /v1/security/scan/{type}
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#fehler-responses" class="md-nav__link">
<span class="md-ellipsis">
Fehler-Responses
</span>
</a>
<nav class="md-nav" aria-label="Fehler-Responses">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#400-bad-request" class="md-nav__link">
<span class="md-ellipsis">
400 Bad Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#401-unauthorized" class="md-nav__link">
<span class="md-ellipsis">
401 Unauthorized
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#404-not-found" class="md-nav__link">
<span class="md-ellipsis">
404 Not Found
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#500-internal-server-error" class="md-nav__link">
<span class="md-ellipsis">
500 Internal Server Error
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="breakpilot-backend-api-dokumentation">BreakPilot Backend API Dokumentation<a class="headerlink" href="#breakpilot-backend-api-dokumentation" title="Permanent link">&para;</a></h1>
<h2 id="ubersicht">Übersicht<a class="headerlink" href="#ubersicht" title="Permanent link">&para;</a></h2>
<p>Base URL: <code>http://localhost:8000/api</code></p>
<p>Alle Endpoints erfordern Authentifizierung via JWT im Authorization-Header:
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>Authorization: Bearer &lt;token&gt;
</code></pre></div></p>
<hr />
<h2 id="worksheets-api">Worksheets API<a class="headerlink" href="#worksheets-api" title="Permanent link">&para;</a></h2>
<p>Generiert Lernmaterialien (MC-Tests, Lückentexte, Mindmaps, Quiz).</p>
<h3 id="post-worksheetsgeneratemultiple-choice">POST /worksheets/generate/multiple-choice<a class="headerlink" href="#post-worksheetsgeneratemultiple-choice" title="Permanent link">&para;</a></h3>
<p>Generiert Multiple-Choice-Fragen aus Quelltext.</p>
<p><strong>Request Body:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">{</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">&quot;source_text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Der Text, aus dem Fragen generiert werden sollen...&quot;</span><span class="p">,</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">&quot;num_questions&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">&quot;difficulty&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;medium&quot;</span><span class="p">,</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">&quot;topic&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Thema&quot;</span><span class="p">,</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">&quot;subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Deutsch&quot;</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="p">}</span>
</code></pre></div></p>
<p><strong>Response (200):</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">&quot;success&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">&quot;content&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;multiple_choice&quot;</span><span class="p">,</span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="nt">&quot;questions&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="nt">&quot;question&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Was ist...?&quot;</span><span class="p">,</span>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span><span class="nt">&quot;options&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;A&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;B&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;C&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;D&quot;</span><span class="p">],</span>
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="nt">&quot;correct&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="w"> </span><span class="nt">&quot;explanation&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Erklärung...&quot;</span>
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="p">}</span>
</code></pre></div></p>
<h3 id="post-worksheetsgeneratecloze">POST /worksheets/generate/cloze<a class="headerlink" href="#post-worksheetsgeneratecloze" title="Permanent link">&para;</a></h3>
<p>Generiert Lückentexte.</p>
<h3 id="post-worksheetsgeneratemindmap">POST /worksheets/generate/mindmap<a class="headerlink" href="#post-worksheetsgeneratemindmap" title="Permanent link">&para;</a></h3>
<p>Generiert Mindmap als Mermaid-Diagramm.</p>
<h3 id="post-worksheetsgeneratequiz">POST /worksheets/generate/quiz<a class="headerlink" href="#post-worksheetsgeneratequiz" title="Permanent link">&para;</a></h3>
<p>Generiert Mix aus verschiedenen Fragetypen.</p>
<hr />
<h2 id="corrections-api">Corrections API<a class="headerlink" href="#corrections-api" title="Permanent link">&para;</a></h2>
<p>OCR-basierte Klausurkorrektur mit automatischer Bewertung.</p>
<h3 id="post-corrections">POST /corrections/<a class="headerlink" href="#post-corrections" title="Permanent link">&para;</a></h3>
<p>Erstellt neue Korrektur-Session.</p>
<h3 id="post-correctionsidupload">POST /corrections/{id}/upload<a class="headerlink" href="#post-correctionsidupload" title="Permanent link">&para;</a></h3>
<p>Lädt gescannte Klausur hoch und startet OCR im Hintergrund.</p>
<h3 id="get-correctionsid">GET /corrections/{id}<a class="headerlink" href="#get-correctionsid" title="Permanent link">&para;</a></h3>
<p>Ruft Korrektur-Status ab.</p>
<p><strong>Status-Werte:</strong>
- <code>uploaded</code> - Datei hochgeladen
- <code>processing</code> - OCR läuft
- <code>ocr_complete</code> - OCR fertig
- <code>analyzing</code> - Analyse läuft
- <code>analyzed</code> - Analyse abgeschlossen
- <code>completed</code> - Fertig
- <code>error</code> - Fehler</p>
<h3 id="post-correctionsidanalyze">POST /corrections/{id}/analyze<a class="headerlink" href="#post-correctionsidanalyze" title="Permanent link">&para;</a></h3>
<p>Analysiert extrahierten Text und bewertet Antworten.</p>
<h3 id="get-correctionsidexport-pdf">GET /corrections/{id}/export-pdf<a class="headerlink" href="#get-correctionsidexport-pdf" title="Permanent link">&para;</a></h3>
<p>Exportiert korrigierte Arbeit als PDF.</p>
<hr />
<h2 id="letters-api">Letters API<a class="headerlink" href="#letters-api" title="Permanent link">&para;</a></h2>
<p>Elternbriefe mit GFK-Integration und PDF-Export.</p>
<h3 id="post-letters">POST /letters/<a class="headerlink" href="#post-letters" title="Permanent link">&para;</a></h3>
<p>Erstellt neuen Elternbrief.</p>
<p><strong>letter_type Werte:</strong>
- <code>general</code> - Allgemeine Information
- <code>halbjahr</code> - Halbjahresinformation
- <code>fehlzeiten</code> - Fehlzeiten-Mitteilung
- <code>elternabend</code> - Einladung Elternabend
- <code>lob</code> - Positives Feedback
- <code>custom</code> - Benutzerdefiniert</p>
<h3 id="post-lettersimprove">POST /letters/improve<a class="headerlink" href="#post-lettersimprove" title="Permanent link">&para;</a></h3>
<p>Verbessert Text nach GFK-Prinzipien.</p>
<hr />
<h2 id="state-engine-api">State Engine API<a class="headerlink" href="#state-engine-api" title="Permanent link">&para;</a></h2>
<p>Begleiter-Modus mit Phasen-Management und Antizipation.</p>
<h3 id="get-statedashboard">GET /state/dashboard<a class="headerlink" href="#get-statedashboard" title="Permanent link">&para;</a></h3>
<p>Komplettes Dashboard für Begleiter-Modus.</p>
<h3 id="get-statesuggestions">GET /state/suggestions<a class="headerlink" href="#get-statesuggestions" title="Permanent link">&para;</a></h3>
<p>Ruft Vorschläge für Lehrer ab.</p>
<h3 id="post-statemilestone">POST /state/milestone<a class="headerlink" href="#post-statemilestone" title="Permanent link">&para;</a></h3>
<p>Schließt Meilenstein ab.</p>
<hr />
<h2 id="klausur-korrektur-api-abitur">Klausur-Korrektur API (Abitur)<a class="headerlink" href="#klausur-korrektur-api-abitur" title="Permanent link">&para;</a></h2>
<p>Abitur-Klausurkorrektur mit 15-Punkte-System, Erst-/Zweitprüfer-Workflow und KI-gestützter Bewertung.</p>
<h3 id="klausur-modi">Klausur-Modi<a class="headerlink" href="#klausur-modi" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Modus</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>landes_abitur</code></td>
<td>NiBiS Niedersachsen - rechtlich geklärte Aufgaben</td>
</tr>
<tr>
<td><code>vorabitur</code></td>
<td>Lehrer-erstellte Klausuren mit Rights-Gate</td>
</tr>
</tbody>
</table>
<h3 id="post-klausur-korrekturklausuren">POST /klausur-korrektur/klausuren<a class="headerlink" href="#post-klausur-korrekturklausuren" title="Permanent link">&para;</a></h3>
<p>Erstellt neue Abitur-Klausur.</p>
<h3 id="post-klausur-korrekturstudentsidevaluate">POST /klausur-korrektur/students/{id}/evaluate<a class="headerlink" href="#post-klausur-korrekturstudentsidevaluate" title="Permanent link">&para;</a></h3>
<p>Startet KI-Bewertung.</p>
<p><strong>Response (200):</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">&quot;criteria_scores&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">&quot;rechtschreibung&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;score&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">85</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;weight&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.15</span><span class="p">},</span>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">&quot;grammatik&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;score&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;weight&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.15</span><span class="p">},</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">&quot;inhalt&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;score&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">75</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;weight&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.40</span><span class="p">},</span>
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="w"> </span><span class="nt">&quot;struktur&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;score&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">80</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;weight&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.15</span><span class="p">},</span>
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="nt">&quot;stil&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;score&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">85</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;weight&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.15</span><span class="p">}</span>
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span><span class="nt">&quot;raw_points&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">80</span><span class="p">,</span>
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span><span class="nt">&quot;grade_points&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">11</span><span class="p">,</span>
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="w"> </span><span class="nt">&quot;grade_label&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2&quot;</span>
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a><span class="p">}</span>
</code></pre></div></p>
<h3 id="15-punkte-notenschlussel">15-Punkte-Notenschlüssel<a class="headerlink" href="#15-punkte-notenschlussel" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Punkte</th>
<th>Prozent</th>
<th>Note</th>
</tr>
</thead>
<tbody>
<tr>
<td>15</td>
<td>≥95%</td>
<td>1+</td>
</tr>
<tr>
<td>14</td>
<td>≥90%</td>
<td>1</td>
</tr>
<tr>
<td>13</td>
<td>≥85%</td>
<td>1-</td>
</tr>
<tr>
<td>12</td>
<td>≥80%</td>
<td>2+</td>
</tr>
<tr>
<td>11</td>
<td>≥75%</td>
<td>2</td>
</tr>
<tr>
<td>10</td>
<td>≥70%</td>
<td>2-</td>
</tr>
<tr>
<td>9</td>
<td>≥65%</td>
<td>3+</td>
</tr>
<tr>
<td>8</td>
<td>≥60%</td>
<td>3</td>
</tr>
<tr>
<td>7</td>
<td>≥55%</td>
<td>3-</td>
</tr>
<tr>
<td>6</td>
<td>≥50%</td>
<td>4+</td>
</tr>
<tr>
<td>5</td>
<td>≥45%</td>
<td>4</td>
</tr>
<tr>
<td>4</td>
<td>≥40%</td>
<td>4-</td>
</tr>
<tr>
<td>3</td>
<td>≥33%</td>
<td>5+</td>
</tr>
<tr>
<td>2</td>
<td>≥27%</td>
<td>5</td>
</tr>
<tr>
<td>1</td>
<td>≥20%</td>
<td>5-</td>
</tr>
<tr>
<td>0</td>
<td>&lt;20%</td>
<td>6</td>
</tr>
</tbody>
</table>
<h3 id="bewertungskriterien">Bewertungskriterien<a class="headerlink" href="#bewertungskriterien" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Kriterium</th>
<th>Gewicht</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>rechtschreibung</code></td>
<td>15%</td>
<td>Orthografie</td>
</tr>
<tr>
<td><code>grammatik</code></td>
<td>15%</td>
<td>Grammatik &amp; Syntax</td>
</tr>
<tr>
<td><code>inhalt</code></td>
<td>40%</td>
<td>Inhaltliche Qualität</td>
</tr>
<tr>
<td><code>struktur</code></td>
<td>15%</td>
<td>Aufbau &amp; Gliederung</td>
</tr>
<tr>
<td><code>stil</code></td>
<td>15%</td>
<td>Ausdruck &amp; Stil</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="security-api-devsecops-dashboard">Security API (DevSecOps Dashboard)<a class="headerlink" href="#security-api-devsecops-dashboard" title="Permanent link">&para;</a></h2>
<p>API fuer das Security Dashboard mit DevSecOps-Tools Integration.</p>
<h3 id="get-v1securitytools">GET /v1/security/tools<a class="headerlink" href="#get-v1securitytools" title="Permanent link">&para;</a></h3>
<p>Gibt Status aller DevSecOps-Tools zurueck.</p>
<h3 id="get-v1securityfindings">GET /v1/security/findings<a class="headerlink" href="#get-v1securityfindings" title="Permanent link">&para;</a></h3>
<p>Gibt alle Security-Findings zurueck.</p>
<h3 id="get-v1securitysbom">GET /v1/security/sbom<a class="headerlink" href="#get-v1securitysbom" title="Permanent link">&para;</a></h3>
<p>Gibt SBOM (Software Bill of Materials) zurueck.</p>
<h3 id="post-v1securityscantype">POST /v1/security/scan/{type}<a class="headerlink" href="#post-v1securityscantype" title="Permanent link">&para;</a></h3>
<p>Startet einen Security-Scan.</p>
<p><strong>Path Parameter:</strong>
- <code>type</code>: Scan-Typ (secrets, sast, deps, containers, sbom, all)</p>
<hr />
<h2 id="fehler-responses">Fehler-Responses<a class="headerlink" href="#fehler-responses" title="Permanent link">&para;</a></h2>
<h3 id="400-bad-request">400 Bad Request<a class="headerlink" href="#400-bad-request" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p">{</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">&quot;detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Beschreibung des Fehlers&quot;</span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="p">}</span>
</code></pre></div>
<h3 id="401-unauthorized">401 Unauthorized<a class="headerlink" href="#401-unauthorized" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">&quot;detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Not authenticated&quot;</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="p">}</span>
</code></pre></div>
<h3 id="404-not-found">404 Not Found<a class="headerlink" href="#404-not-found" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="p">{</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="nt">&quot;detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Ressource nicht gefunden&quot;</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="p">}</span>
</code></pre></div>
<h3 id="500-internal-server-error">500 Internal Server Error<a class="headerlink" href="#500-internal-server-error" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="p">{</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">&quot;detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Interner Serverfehler&quot;</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="p">}</span>
</code></pre></div>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Zurück zum Seitenanfang
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="http://macmini:3003/breakpilot/breakpilot-pwa" target="_blank" rel="noopener" title="macmini:3003" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["search.highlight", "search.suggest", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "content.code.copy", "content.tabs.link", "toc.follow"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "In Zwischenablage kopiert", "clipboard.copy": "In Zwischenablage kopieren", "search.result.more.one": "1 weiteres Suchergebnis auf dieser Seite", "search.result.more.other": "# weitere Suchergebnisse auf dieser Seite", "search.result.none": "Keine Suchergebnisse", "search.result.one": "1 Suchergebnis", "search.result.other": "# Suchergebnisse", "search.result.placeholder": "Suchbegriff eingeben", "search.result.term.missing": "Es fehlt", "select.version": "Version ausw\u00e4hlen"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink