API Reference

Endpoints are defined in modules/web/api.py.

Tags and annotations #

• POST /api/tags — Create a tag.
• GET /api/tags — List tags for a project.
• PUT /api/tags/<int:tag_id> — Update a tag.
• DELETE /api/tags/<int:tag_id> — Delete a tag and descendants.
• DELETE /api/tags/batch_delete — Delete multiple tags and descendants.
• POST /api/annotate_text — Create an annotation.
• GET /api/annotations — List annotations with filters and pagination.
• DELETE /api/annotations/<int:annotation_id> — Delete an annotation.

Notes and chat #

• POST /api/notes — Create a note.
• GET /api/notes/<project_name>/<int:pair_id> — List notes for a pair.
• PUT /api/notes/<int:note_id> — Update a note.
• DELETE /api/notes/<project_name>/<int:note_id> — Delete a note.
• GET /api/chat_history/<project_name>/<int:pair_id> — Analyzer chat history.
• GET /api/tag_report/chat/history — Tag Report chat history.

AI and NLP analysis #

• POST /api/ai_chat — Analyzer chat.
• POST /api/tag_report/chat — Tag Report chat (filter-aware).
• GET /api/linguistic_analysis/<project_name>/<int:pair_id> — Per-pair NLP analysis.
• GET /api/nlp_summary/<project_name> — Aggregate NLP stats for charts.
• GET /api/nlp_visual_report/<project_name> — LLM summary of NLP charts.
• GET /api/generate_notes_report/<project_name> — LLM summary of project notes.

Auto-tagging #

• POST /api/auto_tag/plan — Create an auto-tagging plan.
• POST /api/auto_tag/execute — Execute the plan in background.
• GET /api/auto_tag/status/<int:job_id> — Job status.

Data export #

• GET /download/<project_name>/<string:file_format> — Export annotations as csv, excel, xml, yaml, parquet, sqlite, or html.
• POST /api/export_chart/<string:file_format> — Export a single chart’s data.
• GET /download_notes_report/<project_name>/<string:file_format> — Export notes summary as md, txt, or html.