DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.
Python ai-agentsai-tutorclawbotcli-tooldeepresearchinteractive-learninglearningmulti-agent-systemsrag
{
"components": {
"schemas": {
"ActionPayload": {
"properties": {
"locale": {
"default": "en",
"maxLength": 32,
"title": "Locale",
"type": "string"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"selection": {
"default": "",
"maxLength": 10000,
"title": "Selection",
"type": "string"
}
},
"required": [
"locator"
],
"title": "ActionPayload",
"type": "object"
},
"ActiveModelUpdate": {
"description": "Switch the globally-active model for a kind (llm / embedding).",
"properties": {
"kind": {
"title": "Kind",
"type": "string"
},
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"kind",
"profile_id",
"model_id"
],
"title": "ActiveModelUpdate",
"type": "object"
},
"AddGitHubSourceRequest": {
"properties": {
"branch": {
"default": "main",
"title": "Branch",
"type": "string"
},
"glob": {
"default": "*.md",
"title": "Glob",
"type": "string"
},
"path": {
"default": "",
"title": "Path",
"type": "string"
},
"repo": {
"title": "Repo",
"type": "string"
}
},
"required": [
"repo"
],
"title": "AddGitHubSourceRequest",
"type": "object"
},
"AddRecordRequest": {
"description": "Add record request",
"properties": {
"kb_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Kb Name"
},
"metadata": {
"additionalProperties": true,
"default": {},
"title": "Metadata",
"type": "object"
},
"notebook_ids": {
"items": {
"type": "string"
},
"title": "Notebook Ids",
"type": "array"
},
"output": {
"title": "Output",
"type": "string"
},
"record_type": {
"enum": [
"solve",
"question",
"research",
"chat",
"co_writer",
"tutorbot",
"reading",
"video_learning"
],
"title": "Record Type",
"type": "string"
},
"summary": {
"default": "",
"title": "Summary",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"user_query": {
"title": "User Query",
"type": "string"
}
},
"required": [
"notebook_ids",
"record_type",
"title",
"user_query",
"output"
],
"title": "AddRecordRequest",
"type": "object"
},
"AddWebSourceRequest": {
"properties": {
"max_depth": {
"default": 3,
"maximum": 5.0,
"minimum": 1.0,
"title": "Max Depth",
"type": "integer"
},
"max_pages": {
"default": 200,
"maximum": 200.0,
"minimum": 1.0,
"title": "Max Pages",
"type": "integer"
},
"url": {
"maxLength": 2048,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "AddWebSourceRequest",
"type": "object"
},
"AdminBatchDeleteRequest": {
"description": "Usernames for an admin-initiated batch deletion.",
"properties": {
"usernames": {
"items": {
"type": "string"
},
"maxItems": 500,
"minItems": 1,
"title": "Usernames",
"type": "array"
}
},
"required": [
"usernames"
],
"title": "AdminBatchDeleteRequest",
"type": "object"
},
"AdminCreateUserRequest": {
"description": "Admin user-creation payload.\n\nA preset configures an ordinary account; it never becomes a third role.",
"properties": {
"password": {
"title": "Password",
"type": "string"
},
"preset": {
"default": "standard",
"enum": [
"standard",
"learner",
"custom"
],
"title": "Preset",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "AdminCreateUserRequest",
"type": "object"
},
"AnchorThreadRequest": {
"properties": {
"block_id": {
"maxLength": 64,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Block Id",
"type": "string"
},
"origin": {
"default": "ask",
"enum": [
"ask",
"generate"
],
"title": "Origin",
"type": "string"
},
"quote": {
"default": "",
"maxLength": 4000,
"title": "Quote",
"type": "string"
},
"session_id": {
"pattern": "^[A-Za-z0-9_.:-]{1,128}$",
"title": "Session Id",
"type": "string"
}
},
"required": [
"session_id",
"block_id"
],
"title": "AnchorThreadRequest",
"type": "object"
},
"AnnotationInfo": {
"properties": {
"annotation_id": {
"title": "Annotation Id",
"type": "string"
},
"author": {
"title": "Author",
"type": "string"
},
"color": {
"title": "Color",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "number"
},
"kind": {
"title": "Kind",
"type": "string"
},
"locator": {
"title": "Locator",
"type": "integer"
},
"material_revision": {
"default": 1,
"title": "Material Revision",
"type": "integer"
},
"note": {
"title": "Note",
"type": "string"
},
"quote": {
"title": "Quote",
"type": "string"
},
"rects": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"title": "Rects",
"type": "array"
},
"selectors": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Selectors",
"type": "array"
},
"source_anchor": {
"default": "",
"title": "Source Anchor",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"annotation_id",
"locator",
"kind",
"color",
"quote",
"note",
"rects",
"author",
"created_at",
"updated_at"
],
"title": "AnnotationInfo",
"type": "object"
},
"AnnotationPayload": {
"description": "An annotation as the reader sends it.\n\n``rects`` are normalised to the unit box (0..1, origin top-left) by the\nclient, because only the client knows the rendered geometry. They are still\nre-validated server-side — an inverted or out-of-range rectangle is ordered\nand clipped rather than trusted.",
"properties": {
"annotation_id": {
"default": "",
"title": "Annotation Id",
"type": "string"
},
"color": {
"default": "yellow",
"title": "Color",
"type": "string"
},
"kind": {
"default": "highlight",
"enum": [
"highlight",
"underline",
"note",
"citation"
],
"title": "Kind",
"type": "string"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"note": {
"default": "",
"title": "Note",
"type": "string"
},
"quote": {
"default": "",
"maxLength": 2000,
"title": "Quote",
"type": "string"
},
"rects": {
"items": {
"items": {
"type": "number"
},
"type": "array"
},
"title": "Rects",
"type": "array"
},
"selectors": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TextQuoteSelectorPayload"
},
{
"$ref": "#/components/schemas/TextPositionSelectorPayload"
}
]
},
"maxItems": 2,
"title": "Selectors",
"type": "array"
},
"source_anchor": {
"default": "",
"maxLength": 4096,
"title": "Source Anchor",
"type": "string"
}
},
"required": [
"locator"
],
"title": "AnnotationPayload",
"type": "object"
},
"AnswerImageItem": {
"description": "Persisted reference to one image attached to a learner's answer.\n\nThe bytes live in the AttachmentStore at ``url``; we never round-trip\nbase64 back to the client so notebook lookups stay cheap.",
"properties": {
"filename": {
"default": "",
"title": "Filename",
"type": "string"
},
"id": {
"default": "",
"title": "Id",
"type": "string"
},
"mime_type": {
"default": "",
"title": "Mime Type",
"type": "string"
},
"url": {
"default": "",
"title": "Url",
"type": "string"
}
},
"title": "AnswerImageItem",
"type": "object"
},
"AnswerImageUpload": {
"description": "One image attached to the learner's answer.\n\nEither ``base64`` (new upload) or ``url`` (re-submit of an already\npersisted image) must be set. ``id`` is preserved when the client\nsends one so the same logical image keeps a stable AttachmentStore\nrecord across resubmissions.",
"properties": {
"base64": {
"default": "",
"title": "Base64",
"type": "string"
},
"filename": {
"default": "answer.png",
"title": "Filename",
"type": "string"
},
"id": {
"default": "",
"title": "Id",
"type": "string"
},
"mime_type": {
"default": "image/png",
"title": "Mime Type",
"type": "string"
},
"url": {
"default": "",
"title": "Url",
"type": "string"
}
},
"title": "AnswerImageUpload",
"type": "object"
},
"AnswerRequest": {
"properties": {
"answer": {
"default": "",
"maxLength": 20000,
"title": "Answer",
"type": "string"
}
},
"title": "AnswerRequest",
"type": "object"
},
"ApplyOpsRequest": {
"properties": {
"ops": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Ops",
"type": "array"
}
},
"required": [
"ops"
],
"title": "ApplyOpsRequest",
"type": "object"
},
"ApprovalRequest": {
"properties": {
"snapshot_digest": {
"pattern": "^[0-9a-f]{64}$",
"title": "Snapshot Digest",
"type": "string"
}
},
"required": [
"snapshot_digest"
],
"title": "ApprovalRequest",
"type": "object"
},
"AssetAddRequest": {
"properties": {
"knowledge_bases": {
"items": {
"type": "string"
},
"title": "Knowledge Bases",
"type": "array"
},
"notebooks": {
"items": {
"type": "string"
},
"title": "Notebooks",
"type": "array"
},
"skills": {
"items": {
"type": "string"
},
"title": "Skills",
"type": "array"
}
},
"title": "AssetAddRequest",
"type": "object"
},
"AssetSpec": {
"properties": {
"knowledge_bases": {
"items": {
"type": "string"
},
"title": "Knowledge Bases",
"type": "array"
},
"notebooks": {
"items": {
"type": "string"
},
"title": "Notebooks",
"type": "array"
},
"skills": {
"items": {
"type": "string"
},
"title": "Skills",
"type": "array"
}
},
"title": "AssetSpec",
"type": "object"
},
"AuditRequest": {
"properties": {
"budget": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Budget"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__memory__LLMSelectionPayload"
},
{
"type": "null"
}
]
}
},
"title": "AuditRequest",
"type": "object"
},
"AuthStatusResponse": {
"description": "Response body for the GET /status endpoint.",
"properties": {
"authenticated": {
"title": "Authenticated",
"type": "boolean"
},
"avatar": {
"default": "",
"title": "Avatar",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"is_admin": {
"default": false,
"title": "Is Admin",
"type": "boolean"
},
"learning_policy": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Learning Policy"
},
"preset": {
"anyOf": [
{
"enum": [
"standard",
"learner",
"custom"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Preset"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Role"
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
}
},
"required": [
"enabled",
"authenticated"
],
"title": "AuthStatusResponse",
"type": "object"
},
"AutoMarkRequest": {
"properties": {
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__co_writer__LLMSelectionPayload"
},
{
"type": "null"
}
]
},
"text": {
"maxLength": 600000,
"title": "Text",
"type": "string"
}
},
"required": [
"text"
],
"title": "AutoMarkRequest",
"type": "object"
},
"AutoMarkResponse": {
"properties": {
"marked_text": {
"title": "Marked Text",
"type": "string"
},
"operation_id": {
"title": "Operation Id",
"type": "string"
}
},
"required": [
"marked_text",
"operation_id"
],
"title": "AutoMarkResponse",
"type": "object"
},
"AutomationRun": {
"properties": {
"at": {
"title": "At",
"type": "string"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"every_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Every Seconds"
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expr"
},
"id": {
"title": "Id",
"type": "string"
},
"job_id": {
"title": "Job Id",
"type": "string"
},
"kind": {
"enum": [
"at",
"every",
"cron"
],
"title": "Kind",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
}
},
"required": [
"id",
"job_id",
"name",
"message",
"at",
"kind"
],
"title": "AutomationRun",
"type": "object"
},
"BilingualPairingInfo": {
"properties": {
"pairing_id": {
"title": "Pairing Id",
"type": "string"
},
"pairing_method": {
"default": "hreflang",
"title": "Pairing Method",
"type": "string"
},
"source_file": {
"default": "",
"title": "Source File",
"type": "string"
},
"source_lang": {
"default": "",
"title": "Source Lang",
"type": "string"
},
"source_url": {
"title": "Source Url",
"type": "string"
},
"target_file": {
"default": "",
"title": "Target File",
"type": "string"
},
"target_lang": {
"default": "",
"title": "Target Lang",
"type": "string"
},
"target_url": {
"title": "Target Url",
"type": "string"
},
"updated_at": {
"default": 0,
"title": "Updated At",
"type": "integer"
}
},
"required": [
"pairing_id",
"source_url",
"target_url"
],
"title": "BilingualPairingInfo",
"type": "object"
},
"Body_admin_import_users_api_auth_users_import_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_admin_import_users_api_auth_users_import_post",
"type": "object"
},
"Body_create_knowledge_base_api_knowledge_bases_post": {
"properties": {
"embedding_model": {
"default": "",
"title": "Embedding Model",
"type": "string"
},
"files": {
"default": [],
"items": {
"contentMediaType": "application/octet-stream",
"type": "string"
},
"title": "Files",
"type": "array"
},
"indexing_llm": {
"default": "",
"title": "Indexing Llm",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"pageindex_mode": {
"default": "",
"title": "Pageindex Mode",
"type": "string"
},
"rag_provider": {
"default": "llamaindex",
"title": "Rag Provider",
"type": "string"
},
"rel_paths": {
"items": {
"type": "string"
},
"title": "Rel Paths",
"type": "array"
},
"search_mode": {
"default": "",
"title": "Search Mode",
"type": "string"
},
"storage_workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Storage Workspace Id"
}
},
"required": [
"name"
],
"title": "Body_create_knowledge_base_api_knowledge_bases_post",
"type": "object"
},
"Body_import_docx_api_documents_import_docx_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_import_docx_api_documents_import_docx_post",
"type": "object"
},
"Body_import_preview_api_question_notebook_practice_import_preview_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
},
"target": {
"default": "bank",
"enum": [
"bank",
"mistakes"
],
"title": "Target",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_import_preview_api_question_notebook_practice_import_preview_post",
"type": "object"
},
"Body_import_visualizer_api_visualizers_import_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_import_visualizer_api_visualizers_import_post",
"type": "object"
},
"Body_library_add": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"description": "Raw file bytes",
"title": "File",
"type": "string"
},
"filename": {
"description": "Original filename",
"title": "Filename",
"type": "string"
},
"mime_type": {
"default": "",
"title": "Mime Type",
"type": "string"
}
},
"required": [
"filename",
"file"
],
"title": "Body_library_add",
"type": "object"
},
"Body_preview_office_upload_api_file_preview_pdf_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_preview_office_upload_api_file_preview_pdf_post",
"type": "object"
},
"Body_reindex_knowledge_base_api_knowledge_bases__kb_name__reindex_post": {
"properties": {
"config_fingerprint": {
"default": "",
"title": "Config Fingerprint",
"type": "string"
},
"embedding_model": {
"default": "",
"title": "Embedding Model",
"type": "string"
},
"indexing_llm": {
"default": "",
"title": "Indexing Llm",
"type": "string"
}
},
"title": "Body_reindex_knowledge_base_api_knowledge_bases__kb_name__reindex_post",
"type": "object"
},
"Body_speech_to_text_api_voice_stt_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
}
},
"required": [
"file"
],
"title": "Body_speech_to_text_api_voice_stt_post",
"type": "object"
},
"Body_upload_avatar_api_auth_profile_avatar_put": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_upload_avatar_api_auth_profile_avatar_put",
"type": "object"
},
"Body_upload_files_api_knowledge_bases__kb_name__upload_post": {
"properties": {
"dest_subdir": {
"title": "Dest Subdir",
"type": "string"
},
"files": {
"items": {
"contentMediaType": "application/octet-stream",
"type": "string"
},
"title": "Files",
"type": "array"
},
"image_analysis": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Require image analysis with the pinned VLM; false skips images, omitted follows the pinned policy.",
"title": "Image Analysis"
},
"rag_provider": {
"title": "Rag Provider",
"type": "string"
},
"rel_paths": {
"items": {
"type": "string"
},
"title": "Rel Paths",
"type": "array"
}
},
"required": [
"files"
],
"title": "Body_upload_files_api_knowledge_bases__kb_name__upload_post",
"type": "object"
},
"Body_upload_material_api_reading_materials_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_upload_material_api_reading_materials_post",
"type": "object"
},
"Body_upload_note_asset_api_documents__doc_id__assets_post": {
"properties": {
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
}
},
"required": [
"file"
],
"title": "Body_upload_note_asset_api_documents__doc_id__assets_post",
"type": "object"
},
"BookPermissionPayload": {
"properties": {
"books": {
"additionalProperties": {
"enum": [
"none",
"read",
"edit"
],
"type": "string"
},
"title": "Books",
"type": "object"
},
"create": {
"default": true,
"title": "Create",
"type": "boolean"
},
"default": {
"default": "none",
"enum": [
"none",
"read"
],
"title": "Default",
"type": "string"
}
},
"title": "BookPermissionPayload",
"type": "object"
},
"BookReference": {
"additionalProperties": false,
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"page_ids": {
"items": {
"type": "string"
},
"title": "Page Ids",
"type": "array"
}
},
"required": [
"book_id"
],
"title": "BookReference",
"type": "object"
},
"BookmarkInfo": {
"properties": {
"bookmark_id": {
"title": "Bookmark Id",
"type": "string"
},
"created_at": {
"default": 0.0,
"title": "Created At",
"type": "number"
},
"label": {
"default": "",
"maxLength": 200,
"title": "Label",
"type": "string"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"source_anchor": {
"default": "",
"maxLength": 4096,
"title": "Source Anchor",
"type": "string"
}
},
"required": [
"locator",
"bookmark_id"
],
"title": "BookmarkInfo",
"type": "object"
},
"BookmarkList": {
"properties": {
"bookmarks": {
"items": {
"$ref": "#/components/schemas/BookmarkInfo"
},
"title": "Bookmarks",
"type": "array"
}
},
"required": [
"bookmarks"
],
"title": "BookmarkList",
"type": "object"
},
"BookmarkPayload": {
"properties": {
"label": {
"default": "",
"maxLength": 200,
"title": "Label",
"type": "string"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"source_anchor": {
"default": "",
"maxLength": 4096,
"title": "Source Anchor",
"type": "string"
}
},
"required": [
"locator"
],
"title": "BookmarkPayload",
"type": "object"
},
"BranchSelectionRequest": {
"description": "Edit-branch picker state: `{parent_message_id: chosen_child_id}`.\n\nStored inside the session preferences blob so it survives reloads\nwithout a dedicated column.",
"properties": {
"selected_branches": {
"additionalProperties": {
"type": "integer"
},
"title": "Selected Branches",
"type": "object"
}
},
"title": "BranchSelectionRequest",
"type": "object"
},
"BuiltinToolPayload": {
"properties": {
"aliases": {
"default": [],
"items": {
"type": "string"
},
"title": "Aliases",
"type": "array"
},
"available": {
"default": true,
"title": "Available",
"type": "boolean"
},
"capability": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Capability"
},
"coming_soon": {
"default": false,
"title": "Coming Soon",
"type": "boolean"
},
"description": {
"title": "Description",
"type": "string"
},
"description_i18n": {
"additionalProperties": {
"type": "string"
},
"default": {},
"propertyNames": {
"enum": [
"en",
"zh"
]
},
"title": "Description I18N",
"type": "object"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"hints": {
"additionalProperties": {
"$ref": "#/components/schemas/ToolHintsPayload"
},
"propertyNames": {
"enum": [
"en",
"zh"
]
},
"title": "Hints",
"type": "object"
},
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/ToolParameterPayload"
},
"title": "Parameters",
"type": "array"
},
"toggleable": {
"default": false,
"title": "Toggleable",
"type": "boolean"
},
"unavailable_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Unavailable Reason"
}
},
"required": [
"name",
"description",
"parameters",
"hints"
],
"title": "BuiltinToolPayload",
"type": "object"
},
"BulkCategoryRequest": {
"description": "File (or unfile) many entries at once.\n\nOne round-trip per bulk action keeps the list view consistent: the\nclient re-reads once instead of racing N per-entry writes.",
"properties": {
"category_id": {
"title": "Category Id",
"type": "integer"
},
"entry_ids": {
"items": {
"type": "integer"
},
"maxItems": 500,
"minItems": 1,
"title": "Entry Ids",
"type": "array"
},
"link": {
"default": true,
"title": "Link",
"type": "boolean"
}
},
"required": [
"entry_ids",
"category_id"
],
"title": "BulkCategoryRequest",
"type": "object"
},
"CalendarEntry": {
"properties": {
"color": {
"title": "Color",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"is_default": {
"title": "Is Default",
"type": "boolean"
},
"name": {
"title": "Name",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
},
"updated_at": {
"title": "Updated At",
"type": "string"
},
"visible": {
"title": "Visible",
"type": "boolean"
}
},
"required": [
"id",
"name",
"color",
"visible",
"position",
"is_default",
"created_at",
"updated_at"
],
"title": "CalendarEntry",
"type": "object"
},
"CalendarEvent": {
"description": "A stored master or override row.",
"properties": {
"all_day": {
"title": "All Day",
"type": "boolean"
},
"calendar_id": {
"title": "Calendar Id",
"type": "string"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"created_at": {
"title": "Created At",
"type": "string"
},
"end": {
"title": "End",
"type": "string"
},
"exdates": {
"items": {
"type": "string"
},
"title": "Exdates",
"type": "array"
},
"id": {
"title": "Id",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"recurrence_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recurrence Id"
},
"reminders": {
"items": {
"type": "integer"
},
"title": "Reminders",
"type": "array"
},
"rrule": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rrule"
},
"series_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Series Id"
},
"source": {
"default": "user",
"enum": [
"user",
"dito",
"import"
],
"title": "Source",
"type": "string"
},
"start": {
"title": "Start",
"type": "string"
},
"task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"task_workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Workspace Id"
},
"title": {
"title": "Title",
"type": "string"
},
"tzid": {
"title": "Tzid",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "string"
}
},
"required": [
"id",
"calendar_id",
"title",
"notes",
"location",
"all_day",
"start",
"end",
"tzid",
"rrule",
"exdates",
"reminders",
"color",
"task_id",
"task_workspace_id",
"series_id",
"recurrence_id",
"created_at",
"updated_at"
],
"title": "CalendarEvent",
"type": "object"
},
"CalendarEventResponse": {
"properties": {
"event": {
"$ref": "#/components/schemas/CalendarEvent"
},
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"event",
"revision"
],
"title": "CalendarEventResponse",
"type": "object"
},
"CalendarLayers": {
"properties": {
"automations": {
"items": {
"$ref": "#/components/schemas/AutomationRun"
},
"title": "Automations",
"type": "array"
},
"footprints": {
"items": {
"$ref": "#/components/schemas/FootprintDay"
},
"title": "Footprints",
"type": "array"
},
"reviews": {
"items": {
"$ref": "#/components/schemas/ReviewDay"
},
"title": "Reviews",
"type": "array"
},
"workspace_id": {
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"workspace_id"
],
"title": "CalendarLayers",
"type": "object"
},
"CalendarList": {
"properties": {
"calendars": {
"items": {
"$ref": "#/components/schemas/CalendarEntry"
},
"title": "Calendars",
"type": "array"
},
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"calendars",
"revision"
],
"title": "CalendarList",
"type": "object"
},
"CalendarOk": {
"properties": {
"ok": {
"default": true,
"title": "Ok",
"type": "boolean"
}
},
"title": "CalendarOk",
"type": "object"
},
"CalendarResponse": {
"properties": {
"calendar": {
"$ref": "#/components/schemas/CalendarEntry"
},
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"calendar",
"revision"
],
"title": "CalendarResponse",
"type": "object"
},
"CalendarRevision": {
"properties": {
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"revision"
],
"title": "CalendarRevision",
"type": "object"
},
"CalendarSearchHit": {
"properties": {
"all_day": {
"title": "All Day",
"type": "boolean"
},
"calendar_id": {
"title": "Calendar Id",
"type": "string"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"created_at": {
"title": "Created At",
"type": "string"
},
"end": {
"title": "End",
"type": "string"
},
"exdates": {
"items": {
"type": "string"
},
"title": "Exdates",
"type": "array"
},
"id": {
"title": "Id",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"next_start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Start"
},
"notes": {
"title": "Notes",
"type": "string"
},
"recurrence_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recurrence Id"
},
"reminders": {
"items": {
"type": "integer"
},
"title": "Reminders",
"type": "array"
},
"rrule": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rrule"
},
"series_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Series Id"
},
"source": {
"default": "user",
"enum": [
"user",
"dito",
"import"
],
"title": "Source",
"type": "string"
},
"start": {
"title": "Start",
"type": "string"
},
"task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"task_workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Workspace Id"
},
"title": {
"title": "Title",
"type": "string"
},
"tzid": {
"title": "Tzid",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "string"
}
},
"required": [
"id",
"calendar_id",
"title",
"notes",
"location",
"all_day",
"start",
"end",
"tzid",
"rrule",
"exdates",
"reminders",
"color",
"task_id",
"task_workspace_id",
"series_id",
"recurrence_id",
"created_at",
"updated_at"
],
"title": "CalendarSearchHit",
"type": "object"
},
"CalendarSearchResponse": {
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/CalendarSearchHit"
},
"title": "Events",
"type": "array"
}
},
"required": [
"events"
],
"title": "CalendarSearchResponse",
"type": "object"
},
"CatalogPayload": {
"properties": {
"catalog": {
"additionalProperties": true,
"title": "Catalog",
"type": "object"
}
},
"required": [
"catalog"
],
"title": "CatalogPayload",
"type": "object"
},
"CatalogServicePayload": {
"description": "One model-catalog service to promote without touching other drafts.",
"properties": {
"config": {
"additionalProperties": true,
"title": "Config",
"type": "object"
},
"service": {
"enum": [
"llm",
"task",
"embedding",
"search",
"tts",
"stt",
"imagegen",
"videogen"
],
"title": "Service",
"type": "string"
}
},
"required": [
"service",
"config"
],
"title": "CatalogServicePayload",
"type": "object"
},
"CategoryAddRequest": {
"properties": {
"category_id": {
"title": "Category Id",
"type": "integer"
}
},
"required": [
"category_id"
],
"title": "CategoryAddRequest",
"type": "object"
},
"CategoryCreateRequest": {
"properties": {
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CategoryCreateRequest",
"type": "object"
},
"CategoryItem": {
"properties": {
"created_at": {
"default": 0,
"title": "Created At",
"type": "number"
},
"entry_count": {
"default": 0,
"title": "Entry Count",
"type": "integer"
},
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "CategoryItem",
"type": "object"
},
"CategoryRenameRequest": {
"properties": {
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CategoryRenameRequest",
"type": "object"
},
"ChangeBlockTypeRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"new_type": {
"title": "New Type",
"type": "string"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"params_override": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Params Override"
}
},
"required": [
"book_id",
"page_id",
"block_id",
"new_type"
],
"title": "ChangeBlockTypeRequest",
"type": "object"
},
"ChannelOnboardingStartRequest": {
"properties": {
"channel": {
"enum": [
"feishu",
"wecom"
],
"title": "Channel",
"type": "string"
}
},
"required": [
"channel"
],
"title": "ChannelOnboardingStartRequest",
"type": "object"
},
"ChapterImport": {
"properties": {
"knowledge_points": {
"default": [],
"items": {
"type": "string"
},
"title": "Knowledge Points",
"type": "array"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"title"
],
"title": "ChapterImport",
"type": "object"
},
"ChatAttachmentRequest": {
"properties": {
"base64": {
"default": "",
"title": "Base64",
"type": "string"
},
"filename": {
"default": "",
"title": "Filename",
"type": "string"
},
"mime_type": {
"default": "",
"title": "Mime Type",
"type": "string"
},
"type": {
"default": "file",
"title": "Type",
"type": "string"
},
"url": {
"default": "",
"title": "Url",
"type": "string"
}
},
"title": "ChatAttachmentRequest",
"type": "object"
},
"ChatAttachmentSettingsUpdate": {
"description": "Chat attachment policy (size caps + extraction budgets).\n\nBounds mirror the normalization clamps in\n``runtime_settings.CHAT_ATTACHMENT_*_RANGE`` so the API rejects loudly\nwhat the file layer would silently clamp.",
"properties": {
"max_chars_per_doc": {
"maximum": 5000000.0,
"minimum": 10000.0,
"title": "Max Chars Per Doc",
"type": "integer"
},
"max_chars_total": {
"maximum": 5000000.0,
"minimum": 10000.0,
"title": "Max Chars Total",
"type": "integer"
},
"max_file_mb": {
"maximum": 1024.0,
"minimum": 1.0,
"title": "Max File Mb",
"type": "integer"
},
"max_total_mb": {
"maximum": 2048.0,
"minimum": 1.0,
"title": "Max Total Mb",
"type": "integer"
}
},
"required": [
"max_file_mb",
"max_total_mb",
"max_chars_per_doc",
"max_chars_total"
],
"title": "ChatAttachmentSettingsUpdate",
"type": "object"
},
"ChatHistoryImportRequest": {
"properties": {
"agent_id": {
"default": "",
"maxLength": 256,
"title": "Agent Id",
"type": "string"
},
"agent_name": {
"default": "",
"maxLength": 256,
"title": "Agent Name",
"type": "string"
},
"sessions": {
"items": {
"$ref": "#/components/schemas/ImportedSession"
},
"title": "Sessions",
"type": "array"
},
"source": {
"minLength": 1,
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "ChatHistoryImportRequest",
"type": "object"
},
"ChatMessageRequest": {
"properties": {
"attachments": {
"items": {
"$ref": "#/components/schemas/ChatAttachmentRequest"
},
"title": "Attachments",
"type": "array"
},
"chat_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Chat Id"
},
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"llmSelection": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Llmselection"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
},
"session_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Key"
}
},
"title": "ChatMessageRequest",
"type": "object"
},
"ChatResponseTimeoutUpdate": {
"properties": {
"chat_response_timeout": {
"maximum": 1800.0,
"minimum": 30.0,
"title": "Chat Response Timeout",
"type": "integer"
}
},
"required": [
"chat_response_timeout"
],
"title": "ChatResponseTimeoutUpdate",
"type": "object"
},
"ChatStarterSettingsUpdate": {
"description": "How much recent activity shapes the home screen's starting points.\n\nBounds mirror ``starter_settings.TRACE_COUNT_RANGE`` so the API rejects\nloudly what the file layer would silently clamp.",
"properties": {
"trace_count": {
"maximum": 100.0,
"minimum": 3.0,
"title": "Trace Count",
"type": "integer"
}
},
"required": [
"trace_count"
],
"title": "ChatStarterSettingsUpdate",
"type": "object"
},
"ClipRequest": {
"properties": {
"favorite_metadata": {
"additionalProperties": true,
"title": "Favorite Metadata",
"type": "object"
},
"favorite_type": {
"default": "",
"maxLength": 60,
"title": "Favorite Type",
"type": "string"
},
"markdown": {
"maxLength": 200000,
"title": "Markdown",
"type": "string"
},
"source_id": {
"default": "",
"maxLength": 200,
"title": "Source Id",
"type": "string"
},
"source_url": {
"default": "",
"maxLength": 2000,
"title": "Source Url",
"type": "string"
},
"summary": {
"default": "",
"maxLength": 200000,
"title": "Summary",
"type": "string"
},
"title": {
"default": "",
"maxLength": 200,
"title": "Title",
"type": "string"
}
},
"required": [
"markdown"
],
"title": "ClipRequest",
"type": "object"
},
"CodexOAuthCallbackPayload": {
"properties": {
"callback_url": {
"title": "Callback Url",
"type": "string"
}
},
"required": [
"callback_url"
],
"title": "CodexOAuthCallbackPayload",
"type": "object"
},
"CodexReasoningEffortUpdate": {
"properties": {
"model": {
"minLength": 1,
"title": "Model",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
}
},
"required": [
"model"
],
"title": "CodexReasoningEffortUpdate",
"type": "object"
},
"CommitRequest": {
"properties": {
"token": {
"maxLength": 32,
"minLength": 32,
"pattern": "^[a-f0-9]+$",
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "CommitRequest",
"type": "object"
},
"CompilePageRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"force": {
"default": false,
"title": "Force",
"type": "boolean"
},
"page_id": {
"title": "Page Id",
"type": "string"
}
},
"required": [
"book_id",
"page_id"
],
"title": "CompilePageRequest",
"type": "object"
},
"ConfirmPartnerDraftRequest": {
"description": "Editable fields accepted by the explicit draft-confirmation step.",
"properties": {
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"emoji": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Emoji"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"name": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"soul": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Soul"
},
"start": {
"default": true,
"title": "Start",
"type": "boolean"
}
},
"title": "ConfirmPartnerDraftRequest",
"type": "object"
},
"ConfirmProposalRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"proposal": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Proposal"
}
},
"required": [
"book_id"
],
"title": "ConfirmProposalRequest",
"type": "object"
},
"ConfirmSpineRequest": {
"properties": {
"auto_compile": {
"default": true,
"title": "Auto Compile",
"type": "boolean"
},
"block_types": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Block Types"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"spine": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Spine"
}
},
"required": [
"book_id"
],
"title": "ConfirmSpineRequest",
"type": "object"
},
"ConfirmTopicRequest": {
"properties": {
"description": {
"default": "",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"emoji": {
"default": "🧭",
"maxLength": 16,
"title": "Emoji",
"type": "string"
},
"goal": {
"maxLength": 2000,
"minLength": 1,
"title": "Goal",
"type": "string"
},
"modules": {
"items": {
"$ref": "#/components/schemas/ModuleInput"
},
"maxItems": 20,
"title": "Modules",
"type": "array"
},
"must_cover": {
"items": {
"type": "string"
},
"maxItems": 40,
"title": "Must Cover",
"type": "array"
},
"name": {
"default": "",
"maxLength": 120,
"title": "Name",
"type": "string"
},
"sources": {
"items": {
"$ref": "#/components/schemas/TopicSourceRequest"
},
"maxItems": 16,
"title": "Sources",
"type": "array"
}
},
"required": [
"goal"
],
"title": "ConfirmTopicRequest",
"type": "object"
},
"ConnectFolderRequest": {
"properties": {
"folder_path": {
"title": "Folder Path",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"rag_provider": {
"default": "llamaindex",
"title": "Rag Provider",
"type": "string"
}
},
"required": [
"name",
"folder_path"
],
"title": "ConnectFolderRequest",
"type": "object"
},
"ConnectImaRequest": {
"properties": {
"api_key": {
"default": "",
"title": "Api Key",
"type": "string"
},
"client_id": {
"default": "",
"title": "Client Id",
"type": "string"
},
"knowledge_base_id": {
"title": "Knowledge Base Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"knowledge_base_id"
],
"title": "ConnectImaRequest",
"type": "object"
},
"ConnectKiwixRequest": {
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"server_url": {
"title": "Server Url",
"type": "string"
},
"zim_name": {
"title": "Zim Name",
"type": "string"
}
},
"required": [
"server_url",
"zim_name",
"name"
],
"title": "ConnectKiwixRequest",
"type": "object"
},
"ConnectLightRagServerRequest": {
"properties": {
"api_key": {
"default": "",
"title": "Api Key",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"search_mode": {
"default": "",
"title": "Search Mode",
"type": "string"
},
"server_url": {
"title": "Server Url",
"type": "string"
}
},
"required": [
"name",
"server_url"
],
"title": "ConnectLightRagServerRequest",
"type": "object"
},
"ConnectMarginNote4Request": {
"properties": {
"db_path": {
"default": "",
"title": "Db Path",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "ConnectMarginNote4Request",
"type": "object"
},
"ConnectObsidianRequest": {
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"vault_path": {
"title": "Vault Path",
"type": "string"
}
},
"required": [
"name",
"vault_path"
],
"title": "ConnectObsidianRequest",
"type": "object"
},
"ConnectSubagentRequest": {
"properties": {
"agent_kind": {
"title": "Agent Kind",
"type": "string"
},
"cwd": {
"default": "",
"title": "Cwd",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"agent_kind"
],
"title": "ConnectSubagentRequest",
"type": "object"
},
"ConnectWeKnoraRequest": {
"properties": {
"api_key": {
"title": "Api Key",
"type": "string"
},
"knowledge_base_id": {
"title": "Knowledge Base Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"server_url": {
"title": "Server Url",
"type": "string"
}
},
"required": [
"name",
"server_url",
"api_key",
"knowledge_base_id"
],
"title": "ConnectWeKnoraRequest",
"type": "object"
},
"CreateBookRequest": {
"properties": {
"chat_selections": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Chat Selections",
"type": "array"
},
"chat_session_id": {
"default": "",
"title": "Chat Session Id",
"type": "string"
},
"depth": {
"default": "standard",
"title": "Depth",
"type": "string"
},
"fallback_language": {
"default": "en",
"title": "Fallback Language",
"type": "string"
},
"knowledge_bases": {
"items": {
"type": "string"
},
"title": "Knowledge Bases",
"type": "array"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"notebook_refs": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Notebook Refs",
"type": "array"
},
"question_categories": {
"items": {
"type": "integer"
},
"title": "Question Categories",
"type": "array"
},
"question_entries": {
"items": {
"type": "integer"
},
"title": "Question Entries",
"type": "array"
},
"source_refs": {
"items": {
"additionalProperties": true,
"type": "object"
},
"maxItems": 32,
"title": "Source Refs",
"type": "array"
},
"user_intent": {
"default": "",
"title": "User Intent",
"type": "string"
}
},
"title": "CreateBookRequest",
"type": "object"
},
"CreateCalendar": {
"additionalProperties": false,
"properties": {
"color": {
"pattern": "^#[0-9a-fA-F]{6}$",
"title": "Color",
"type": "string"
},
"name": {
"maxLength": 80,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"color"
],
"title": "CreateCalendar",
"type": "object"
},
"CreateCard": {
"additionalProperties": false,
"properties": {
"due_date": {
"anyOf": [
{
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"note": {
"default": "",
"maxLength": 2000,
"title": "Note",
"type": "string"
},
"title": {
"maxLength": 160,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title"
],
"title": "CreateCard",
"type": "object"
},
"CreateDocumentRequest": {
"properties": {
"blocks": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Blocks"
},
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"title": "CreateDocumentRequest",
"type": "object"
},
"CreateFolderPayload": {
"properties": {
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "CreateFolderPayload",
"type": "object"
},
"CreateNotebookRequest": {
"description": "Create notebook request",
"properties": {
"color": {
"default": "#3B82F6",
"title": "Color",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"icon": {
"default": "book",
"title": "Icon",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateNotebookRequest",
"type": "object"
},
"CreatePartnerGroupRequest": {
"properties": {
"color": {
"default": "#6366f1",
"title": "Color",
"type": "string"
},
"description": {
"default": "",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"discussion_mode": {
"default": "panel_parallel",
"title": "Discussion Mode",
"type": "string"
},
"emoji": {
"default": "👥",
"title": "Emoji",
"type": "string"
},
"member_ids": {
"items": {
"type": "string"
},
"minItems": 2,
"title": "Member Ids",
"type": "array"
},
"name": {
"maxLength": 80,
"minLength": 1,
"title": "Name",
"type": "string"
},
"shared_memory": {
"default": "whiteboard",
"title": "Shared Memory",
"type": "string"
}
},
"required": [
"name",
"member_ids"
],
"title": "CreatePartnerGroupRequest",
"type": "object"
},
"CreatePartnerInvocationRequest": {
"properties": {
"question": {
"maxLength": 2000,
"minLength": 1,
"title": "Question",
"type": "string"
},
"requester_partner_id": {
"maxLength": 80,
"minLength": 1,
"title": "Requester Partner Id",
"type": "string"
},
"session_key": {
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
},
"target_partner_id": {
"maxLength": 80,
"minLength": 1,
"title": "Target Partner Id",
"type": "string"
}
},
"required": [
"session_key",
"requester_partner_id",
"target_partner_id",
"question"
],
"title": "CreatePartnerInvocationRequest",
"type": "object"
},
"CreatePartnerRequest": {
"properties": {
"assets": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetSpec"
},
{
"type": "null"
}
]
},
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Avatar"
},
"backup_llm_selection": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Backup Llm Selection"
},
"builtin_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Builtin Tools"
},
"channels": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Channels"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"emoji": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Emoji"
},
"enabled_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Enabled Tools"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"llm_selection": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Llm Selection"
},
"mcp_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": [],
"title": "Mcp Tools"
},
"name": {
"minLength": 1,
"title": "Name",
"type": "string"
},
"partner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Partner Id"
},
"soul": {
"anyOf": [
{
"$ref": "#/components/schemas/SoulSpec"
},
{
"type": "null"
}
]
},
"start": {
"default": true,
"title": "Start",
"type": "boolean"
},
"workspace_id": {
"default": "",
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreatePartnerRequest",
"type": "object"
},
"CreatePersonaRequest": {
"properties": {
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreatePersonaRequest",
"type": "object"
},
"CreateSkillRequest": {
"properties": {
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"required": [
"name"
],
"title": "CreateSkillRequest",
"type": "object"
},
"CreateSuggestionRequest": {
"properties": {
"block_id": {
"default": "",
"title": "Block Id",
"type": "string"
},
"blocks": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Blocks"
},
"expected_original": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Expected Original"
},
"explanation": {
"default": "",
"maxLength": 10000,
"title": "Explanation",
"type": "string"
},
"markdown": {
"default": "",
"maxLength": 200000,
"title": "Markdown",
"type": "string"
},
"operation": {
"default": "insert",
"title": "Operation",
"type": "string"
},
"source_turn_id": {
"default": "",
"maxLength": 120,
"title": "Source Turn Id",
"type": "string"
}
},
"title": "CreateSuggestionRequest",
"type": "object"
},
"CreateTagRequest": {
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateTagRequest",
"type": "object"
},
"CreateVideoNoteRequest": {
"properties": {
"body": {
"maxLength": 20000,
"minLength": 1,
"title": "Body",
"type": "string"
},
"time_seconds": {
"maximum": 86400.0,
"minimum": 0.0,
"title": "Time Seconds",
"type": "number"
}
},
"required": [
"body",
"time_seconds"
],
"title": "CreateVideoNoteRequest",
"type": "object"
},
"CreateWorkspacePayload": {
"properties": {
"instructions": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
},
"resources": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkspaceResources"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"title": "CreateWorkspacePayload",
"type": "object"
},
"DailyUsage": {
"properties": {
"date": {
"title": "Date",
"type": "string"
},
"total_calls": {
"default": 0,
"title": "Total Calls",
"type": "integer"
},
"total_tokens": {
"default": 0,
"title": "Total Tokens",
"type": "integer"
},
"tracked_turns": {
"default": 0,
"title": "Tracked Turns",
"type": "integer"
},
"turns": {
"default": 0,
"title": "Turns",
"type": "integer"
}
},
"required": [
"date"
],
"title": "DailyUsage",
"type": "object"
},
"DataMigrationPayload": {
"properties": {
"features": {
"items": {
"type": "string"
},
"minItems": 1,
"title": "Features",
"type": "array"
},
"include_historical": {
"default": false,
"title": "Include Historical",
"type": "boolean"
},
"source_workspace_id": {
"default": "",
"title": "Source Workspace Id",
"type": "string"
},
"target_workspace_id": {
"default": "",
"title": "Target Workspace Id",
"type": "string"
}
},
"required": [
"features"
],
"title": "DataMigrationPayload",
"type": "object"
},
"DedupRequest": {
"properties": {
"iterations": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Iterations"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__memory__LLMSelectionPayload"
},
{
"type": "null"
}
]
}
},
"title": "DedupRequest",
"type": "object"
},
"DeepDiveRequest": {
"properties": {
"block_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Block Id"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"content_type": {
"default": "concept",
"title": "Content Type",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"parent_page_id": {
"title": "Parent Page Id",
"type": "string"
},
"topic": {
"title": "Topic",
"type": "string"
}
},
"required": [
"book_id",
"parent_page_id",
"topic"
],
"title": "DeepDiveRequest",
"type": "object"
},
"DeleteBlockRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"page_id": {
"title": "Page Id",
"type": "string"
}
},
"required": [
"book_id",
"page_id",
"block_id"
],
"title": "DeleteBlockRequest",
"type": "object"
},
"DeleteKnowledgeBaseRequest": {
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "DeleteKnowledgeBaseRequest",
"type": "object"
},
"DeviceCredentialCreateRequest": {
"description": "Admin payload for issuing a local ordinary-user device credential.",
"properties": {
"daily_limit_minutes": {
"maximum": 1440.0,
"minimum": 5.0,
"title": "Daily Limit Minutes",
"type": "integer"
},
"device_name": {
"maxLength": 80,
"minLength": 1,
"title": "Device Name",
"type": "string"
},
"expires_in_days": {
"maximum": 365.0,
"minimum": 1.0,
"title": "Expires In Days",
"type": "integer"
},
"user_id": {
"maxLength": 64,
"minLength": 1,
"title": "User Id",
"type": "string"
}
},
"required": [
"user_id",
"device_name",
"expires_in_days",
"daily_limit_minutes"
],
"title": "DeviceCredentialCreateRequest",
"type": "object"
},
"DeviceInfo": {
"properties": {
"active": {
"title": "Active",
"type": "boolean"
},
"device_id": {
"title": "Device Id",
"type": "string"
},
"device_kind": {
"title": "Device Kind",
"type": "string"
},
"device_name": {
"title": "Device Name",
"type": "string"
},
"last_seen": {
"title": "Last Seen",
"type": "string"
},
"paired_at": {
"title": "Paired At",
"type": "string"
}
},
"required": [
"device_id",
"device_name",
"device_kind",
"paired_at",
"last_seen",
"active"
],
"title": "DeviceInfo",
"type": "object"
},
"DeviceLoginRequest": {
"description": "Payload for the built-in device-credential login endpoint.",
"properties": {
"pairing_code": {
"maxLength": 128,
"minLength": 8,
"title": "Pairing Code",
"type": "string"
},
"pin": {
"maxLength": 6,
"minLength": 6,
"title": "Pin",
"type": "string"
}
},
"required": [
"pairing_code",
"pin"
],
"title": "DeviceLoginRequest",
"type": "object"
},
"DocWriteRequest": {
"properties": {
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"content"
],
"title": "DocWriteRequest",
"type": "object"
},
"DoclingRemoteTest": {
"description": "Draft Docling remote-server test. ``api_token`` is tri-state: ``None``\nfalls back to the stored key, ``\"\"`` clears it, a string supplies it (so\nthe user can verify an unsaved key before saving).",
"properties": {
"api_base_url": {
"default": "http://localhost:5001",
"title": "Api Base Url",
"type": "string"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Token"
}
},
"title": "DoclingRemoteTest",
"type": "object"
},
"DocumentParsingInstall": {
"description": "One-click pip install of an optional parser engine's package(s).",
"properties": {
"engine": {
"title": "Engine",
"type": "string"
}
},
"required": [
"engine"
],
"title": "DocumentParsingInstall",
"type": "object"
},
"DocumentParsingTest": {
"description": "Readiness test for one engine (defaults to the active engine).",
"properties": {
"engine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
}
},
"title": "DocumentParsingTest",
"type": "object"
},
"DocumentParsingUpdate": {
"description": "Document-parsing settings update (the multi-engine control panel).\n\n``engine`` (when provided) switches the active parse engine. ``engines``\ncarries partial per-engine updates merged over the stored slices. For the\nMinerU engine, ``api_token`` stays tri-state: omit it (or send ``None``) to\nkeep the stored token, ``\"\"`` clears it, a non-empty string replaces it.\nThe MinerU engine's own knobs can also be edited via the legacy\n``/mineru`` endpoints; both preserve the other engines' settings.",
"properties": {
"engine": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engine"
},
"engines": {
"anyOf": [
{
"additionalProperties": {
"additionalProperties": true,
"type": "object"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Engines"
},
"image_caption": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Image Caption"
},
"image_description_model": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageDescriptionModelSelection"
},
{
"type": "null"
}
]
}
},
"title": "DocumentParsingUpdate",
"type": "object"
},
"DocumentResponse": {
"properties": {
"applied_suggestion_ids": {
"items": {
"type": "string"
},
"title": "Applied Suggestion Ids",
"type": "array"
},
"blocks": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Blocks"
},
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"cover": {
"default": "",
"title": "Cover",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "number"
},
"icon": {
"default": "",
"title": "Icon",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"pinned": {
"default": false,
"title": "Pinned",
"type": "boolean"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"schema_version": {
"default": 1,
"title": "Schema Version",
"type": "integer"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"id"
],
"title": "DocumentResponse",
"type": "object"
},
"DocumentSummaryResponse": {
"properties": {
"cover": {
"default": "",
"title": "Cover",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "number"
},
"icon": {
"default": "",
"title": "Icon",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"pinned": {
"default": false,
"title": "Pinned",
"type": "boolean"
},
"preview": {
"default": "",
"title": "Preview",
"type": "string"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"id",
"title",
"created_at",
"updated_at"
],
"title": "DocumentSummaryResponse",
"type": "object"
},
"DuplicateCheckRequest": {
"properties": {
"files": {
"items": {
"$ref": "#/components/schemas/DuplicateFileQuery"
},
"maxItems": 50,
"title": "Files",
"type": "array"
},
"urls": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Urls",
"type": "array"
}
},
"title": "DuplicateCheckRequest",
"type": "object"
},
"DuplicateFileQuery": {
"properties": {
"content_id": {
"default": "",
"maxLength": 64,
"title": "Content Id",
"type": "string"
},
"filename": {
"default": "",
"maxLength": 512,
"title": "Filename",
"type": "string"
},
"mime": {
"default": "",
"maxLength": 128,
"title": "Mime",
"type": "string"
},
"size_bytes": {
"default": 0,
"title": "Size Bytes",
"type": "integer"
}
},
"title": "DuplicateFileQuery",
"type": "object"
},
"EditRequest": {
"properties": {
"action": {
"default": "rewrite",
"enum": [
"rewrite",
"shorten",
"expand"
],
"title": "Action",
"type": "string"
},
"instruction": {
"maxLength": 10000,
"title": "Instruction",
"type": "string"
},
"kb_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Kb Name"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__co_writer__LLMSelectionPayload"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"enum": [
"rag",
"web"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"text": {
"maxLength": 600000,
"title": "Text",
"type": "string"
}
},
"required": [
"text",
"instruction"
],
"title": "EditRequest",
"type": "object"
},
"EditResponse": {
"properties": {
"edited_text": {
"title": "Edited Text",
"type": "string"
},
"operation_id": {
"title": "Operation Id",
"type": "string"
}
},
"required": [
"edited_text",
"operation_id"
],
"title": "EditResponse",
"type": "object"
},
"EditTopicMapRequest": {
"properties": {
"modules": {
"items": {
"$ref": "#/components/schemas/ModuleInput"
},
"maxItems": 20,
"minItems": 1,
"title": "Modules",
"type": "array"
}
},
"required": [
"modules"
],
"title": "EditTopicMapRequest",
"type": "object"
},
"EnabledPayload": {
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "EnabledPayload",
"type": "object"
},
"EnabledToolsUpdate": {
"properties": {
"enabled_tools": {
"items": {
"type": "string"
},
"title": "Enabled Tools",
"type": "array"
}
},
"required": [
"enabled_tools"
],
"title": "EnabledToolsUpdate",
"type": "object"
},
"EntryUpdateRequest": {
"properties": {
"ai_judgment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ai Judgment"
},
"bookmarked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Bookmarked"
},
"followup_session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Followup Session Id"
},
"resolved": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Resolved"
}
},
"title": "EntryUpdateRequest",
"type": "object"
},
"EpubPairingRequest": {
"properties": {
"chinese_material_id": {
"title": "Chinese Material Id",
"type": "string"
},
"english_material_id": {
"title": "English Material Id",
"type": "string"
}
},
"required": [
"english_material_id",
"chinese_material_id"
],
"title": "EpubPairingRequest",
"type": "object"
},
"ErrorEnvelope": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Id"
},
"error_code": {
"title": "Error Code",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"retryable": {
"default": false,
"title": "Retryable",
"type": "boolean"
}
},
"required": [
"error_code",
"message"
],
"title": "ErrorEnvelope",
"type": "object"
},
"EventInput": {
"additionalProperties": false,
"description": "A new event, or the merged result of a patch before it is stored.",
"properties": {
"all_day": {
"default": false,
"title": "All Day",
"type": "boolean"
},
"calendar_id": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Calendar Id"
},
"color": {
"anyOf": [
{
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"end": {
"maxLength": 40,
"title": "End",
"type": "string"
},
"location": {
"default": "",
"maxLength": 300,
"title": "Location",
"type": "string"
},
"notes": {
"default": "",
"maxLength": 5000,
"title": "Notes",
"type": "string"
},
"reminders": {
"items": {
"type": "integer"
},
"maxItems": 20,
"title": "Reminders",
"type": "array"
},
"rrule": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Rrule"
},
"start": {
"maxLength": 40,
"title": "Start",
"type": "string"
},
"task_id": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"task_workspace_id": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Workspace Id"
},
"title": {
"default": "",
"maxLength": 200,
"title": "Title",
"type": "string"
},
"tzid": {
"default": "UTC",
"maxLength": 64,
"minLength": 1,
"title": "Tzid",
"type": "string"
}
},
"required": [
"start",
"end"
],
"title": "EventInput",
"type": "object"
},
"EventPatch": {
"additionalProperties": false,
"description": "Every field optional; explicit null clears rrule/color/task links only.",
"properties": {
"all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "All Day"
},
"calendar_id": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Calendar Id"
},
"color": {
"anyOf": [
{
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"end": {
"anyOf": [
{
"maxLength": 40,
"type": "string"
},
{
"type": "null"
}
],
"title": "End"
},
"location": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"notes": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"reminders": {
"anyOf": [
{
"items": {
"type": "integer"
},
"maxItems": 20,
"type": "array"
},
{
"type": "null"
}
],
"title": "Reminders"
},
"rrule": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Rrule"
},
"start": {
"anyOf": [
{
"maxLength": 40,
"type": "string"
},
{
"type": "null"
}
],
"title": "Start"
},
"task_id": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"task_workspace_id": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Workspace Id"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"tzid": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Tzid"
}
},
"title": "EventPatch",
"type": "object"
},
"EventPatchRequest": {
"additionalProperties": false,
"properties": {
"changes": {
"$ref": "#/components/schemas/EventPatch"
},
"occurrence": {
"anyOf": [
{
"maxLength": 40,
"type": "string"
},
{
"type": "null"
}
],
"title": "Occurrence"
},
"scope": {
"default": "all",
"enum": [
"this",
"following",
"all"
],
"title": "Scope",
"type": "string"
}
},
"required": [
"changes"
],
"title": "EventPatchRequest",
"type": "object"
},
"ExportDocxRequest": {
"properties": {
"content": {
"default": "",
"maxLength": 600000,
"title": "Content",
"type": "string"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
}
},
"title": "ExportDocxRequest",
"type": "object"
},
"FetchModelsPayload": {
"properties": {
"api_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Format"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"base_url": {
"default": "",
"title": "Base Url",
"type": "string"
},
"binding": {
"default": "",
"title": "Binding",
"type": "string"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
},
"service": {
"default": "llm",
"enum": [
"llm",
"task"
],
"title": "Service",
"type": "string"
}
},
"title": "FetchModelsPayload",
"type": "object"
},
"FootprintDay": {
"properties": {
"date": {
"title": "Date",
"type": "string"
},
"mastery_evidence": {
"default": 0,
"title": "Mastery Evidence",
"type": "integer"
},
"practice_reviews": {
"default": 0,
"title": "Practice Reviews",
"type": "integer"
},
"session_count": {
"default": 0,
"title": "Session Count",
"type": "integer"
},
"sessions": {
"items": {
"$ref": "#/components/schemas/FootprintSession"
},
"title": "Sessions",
"type": "array"
}
},
"required": [
"date"
],
"title": "FootprintDay",
"type": "object"
},
"FootprintSession": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "FootprintSession",
"type": "object"
},
"GenerateFromNotebookRequest": {
"properties": {
"notebook_id": {
"title": "Notebook Id",
"type": "string"
},
"records": {
"items": {
"$ref": "#/components/schemas/NotebookRecordInput"
},
"title": "Records",
"type": "array"
}
},
"required": [
"notebook_id",
"records"
],
"title": "GenerateFromNotebookRequest",
"type": "object"
},
"GenerateFromReadingRequest": {
"properties": {
"material_ids": {
"items": {
"type": "string"
},
"maxItems": 20,
"title": "Material Ids",
"type": "array"
},
"workspace_id": {
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"workspace_id"
],
"title": "GenerateFromReadingRequest",
"type": "object"
},
"GenerateTopicDraftRequest": {
"properties": {
"goal": {
"maxLength": 2000,
"minLength": 1,
"title": "Goal",
"type": "string"
},
"must_cover": {
"items": {
"type": "string"
},
"maxItems": 40,
"title": "Must Cover",
"type": "array"
},
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"sources": {
"items": {
"$ref": "#/components/schemas/TopicSourceRequest"
},
"maxItems": 16,
"title": "Sources",
"type": "array"
}
},
"required": [
"name",
"goal"
],
"title": "GenerateTopicDraftRequest",
"type": "object"
},
"GitHubSourceInfo": {
"properties": {
"added_at": {
"default": "",
"title": "Added At",
"type": "string"
},
"branch": {
"title": "Branch",
"type": "string"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"files_synced": {
"default": 0,
"title": "Files Synced",
"type": "integer"
},
"glob": {
"title": "Glob",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"last_sync_error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Sync Error"
},
"last_sync_status": {
"default": "pending",
"title": "Last Sync Status",
"type": "string"
},
"last_synced_at": {
"default": "",
"title": "Last Synced At",
"type": "string"
},
"last_synced_sha": {
"default": "",
"title": "Last Synced Sha",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
},
"repo": {
"title": "Repo",
"type": "string"
}
},
"required": [
"id",
"repo",
"branch",
"path",
"glob"
],
"title": "GitHubSourceInfo",
"type": "object"
},
"GrantPayload": {
"properties": {
"grant": {
"additionalProperties": true,
"title": "Grant",
"type": "object"
}
},
"required": [
"grant"
],
"title": "GrantPayload",
"type": "object"
},
"GraphRagConfigUpdate": {
"description": "Partial update for GraphRAG query knobs (omitted fields kept).",
"properties": {
"community_level": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Community Level"
},
"dynamic_community_selection": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Dynamic Community Selection"
},
"response_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Response Type"
}
},
"title": "GraphRagConfigUpdate",
"type": "object"
},
"GraphRagModelCompatibilityRequest": {
"description": "Configured chat-model candidate to test without activating it.",
"properties": {
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "GraphRagModelCompatibilityRequest",
"type": "object"
},
"GuardianAuthorizationPayload": {
"properties": {
"guardian_user_id": {
"maxLength": 64,
"minLength": 1,
"title": "Guardian User Id",
"type": "string"
},
"learner_user_id": {
"maxLength": 64,
"minLength": 1,
"title": "Learner User Id",
"type": "string"
},
"permissions": {
"items": {
"type": "string"
},
"title": "Permissions",
"type": "array"
}
},
"required": [
"guardian_user_id",
"learner_user_id"
],
"title": "GuardianAuthorizationPayload",
"type": "object"
},
"GuardianCredentialResetPayload": {
"properties": {
"new_password": {
"maxLength": 128,
"minLength": 8,
"title": "New Password",
"type": "string"
}
},
"required": [
"new_password"
],
"title": "GuardianCredentialResetPayload",
"type": "object"
},
"GuardianMaterialsPayload": {
"properties": {
"book_ids": {
"items": {
"type": "string"
},
"title": "Book Ids",
"type": "array"
}
},
"required": [
"book_ids"
],
"title": "GuardianMaterialsPayload",
"type": "object"
},
"GuardianRestrictionsPayload": {
"properties": {
"age_band": {
"title": "Age Band",
"type": "string"
},
"allow_upload": {
"title": "Allow Upload",
"type": "boolean"
},
"allowed_surfaces": {
"items": {
"type": "string"
},
"title": "Allowed Surfaces",
"type": "array"
},
"extensions": {
"items": {
"type": "string"
},
"title": "Extensions",
"type": "array"
}
},
"required": [
"age_band",
"allow_upload",
"allowed_surfaces",
"extensions"
],
"title": "GuardianRestrictionsPayload",
"type": "object"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
},
"ImaConfigUpdate": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"client_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Client Id"
}
},
"title": "ImaConfigUpdate",
"type": "object"
},
"ImaKnowledgeBaseSummary": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "ImaKnowledgeBaseSummary",
"type": "object"
},
"ImageDescriptionModelSelection": {
"additionalProperties": false,
"description": "Reference a configured vision model without changing the chat default.",
"properties": {
"model_id": {
"minLength": 1,
"title": "Model Id",
"type": "string"
},
"profile_id": {
"minLength": 1,
"title": "Profile Id",
"type": "string"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "ImageDescriptionModelSelection",
"type": "object"
},
"ImportFromBookRequest": {
"properties": {
"chapters": {
"items": {
"$ref": "#/components/schemas/ChapterImport"
},
"title": "Chapters",
"type": "array"
}
},
"required": [
"chapters"
],
"title": "ImportFromBookRequest",
"type": "object"
},
"ImportedMessage": {
"properties": {
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"created_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Created At"
},
"metadata": {
"additionalProperties": true,
"title": "Metadata",
"type": "object"
},
"role": {
"pattern": "^(user|assistant)$",
"title": "Role",
"type": "string"
}
},
"required": [
"role"
],
"title": "ImportedMessage",
"type": "object"
},
"ImportedSession": {
"properties": {
"created_at": {
"title": "Created At",
"type": "number"
},
"external_id": {
"maxLength": 256,
"minLength": 1,
"title": "External Id",
"type": "string"
},
"messages": {
"items": {
"$ref": "#/components/schemas/ImportedMessage"
},
"title": "Messages",
"type": "array"
},
"source_cwd": {
"default": "",
"title": "Source Cwd",
"type": "string"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"external_id",
"created_at",
"updated_at"
],
"title": "ImportedSession",
"type": "object"
},
"IndexingLLMSelectionRequest": {
"description": "Secret-free catalog identity for an empty LightRAG knowledge base.",
"properties": {
"model_id": {
"minLength": 1,
"title": "Model Id",
"type": "string"
},
"profile_id": {
"minLength": 1,
"title": "Profile Id",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "IndexingLLMSelectionRequest",
"type": "object"
},
"InitModulesRequest": {
"properties": {
"modules": {
"items": {
"$ref": "#/components/schemas/ModuleInput"
},
"title": "Modules",
"type": "array"
}
},
"required": [
"modules"
],
"title": "InitModulesRequest",
"type": "object"
},
"InsertBlockRequest": {
"properties": {
"block_type": {
"title": "Block Type",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"compile_now": {
"default": true,
"title": "Compile Now",
"type": "boolean"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Params"
},
"position": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Position"
}
},
"required": [
"book_id",
"page_id",
"block_type"
],
"title": "InsertBlockRequest",
"type": "object"
},
"InstallPayload": {
"description": "Install a catalog entry, optionally under a different local name.",
"properties": {
"name": {
"default": "",
"title": "Name",
"type": "string"
},
"secrets": {
"additionalProperties": {
"type": "string"
},
"title": "Secrets",
"type": "object"
}
},
"title": "InstallPayload",
"type": "object"
},
"InstallRequest": {
"properties": {
"allow_deprecated": {
"default": false,
"title": "Allow Deprecated",
"type": "boolean"
},
"version": {
"default": "latest",
"maxLength": 64,
"title": "Version",
"type": "string"
}
},
"title": "InstallRequest",
"type": "object"
},
"InstallSkillRequest": {
"description": "Install a hub skill into the caller's own skill layer.\n\n``ref`` is a ``<hub>:<slug>[@version]`` reference (the bare hub prefix\ndefaults to ``eduhub``). The web \"import from EduHub\" flow always builds an\n``eduhub:`` ref so a spoofed bridge message can't redirect the install to an\narbitrary registry.",
"properties": {
"allow_unverified": {
"default": false,
"title": "Allow Unverified",
"type": "boolean"
},
"force": {
"default": false,
"title": "Force",
"type": "boolean"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"ref": {
"maxLength": 256,
"minLength": 1,
"title": "Ref",
"type": "string"
}
},
"required": [
"ref"
],
"title": "InstallSkillRequest",
"type": "object"
},
"InvidiousSettings": {
"properties": {
"api_base_url": {
"default": "",
"maxLength": 2048,
"title": "Api Base Url",
"type": "string"
},
"public_base_url": {
"default": "",
"maxLength": 2048,
"title": "Public Base Url",
"type": "string"
}
},
"title": "InvidiousSettings",
"type": "object"
},
"KiwixConnectionRequest": {
"properties": {
"server_url": {
"title": "Server Url",
"type": "string"
},
"zim_name": {
"title": "Zim Name",
"type": "string"
}
},
"required": [
"server_url",
"zim_name"
],
"title": "KiwixConnectionRequest",
"type": "object"
},
"KnowledgeBaseInfo": {
"properties": {
"assigned": {
"default": false,
"title": "Assigned",
"type": "boolean"
},
"available": {
"default": true,
"title": "Available",
"type": "boolean"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"is_default": {
"title": "Is Default",
"type": "boolean"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"name": {
"title": "Name",
"type": "string"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
},
"progress": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Progress"
},
"provenance_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provenance Label"
},
"read_only": {
"default": false,
"title": "Read Only",
"type": "boolean"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"statistics": {
"additionalProperties": true,
"title": "Statistics",
"type": "object"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
"required": [
"name",
"is_default",
"statistics"
],
"title": "KnowledgeBaseInfo",
"type": "object"
},
"KnowledgeMovePayload": {
"properties": {
"source_id": {
"minLength": 1,
"title": "Source Id",
"type": "string"
},
"target_workspace_id": {
"default": "",
"title": "Target Workspace Id",
"type": "string"
}
},
"required": [
"source_id"
],
"title": "KnowledgeMovePayload",
"type": "object"
},
"KnowledgePointInput": {
"properties": {
"client_ref": {
"default": "",
"title": "Client Ref",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"module_id": {
"default": "",
"title": "Module Id",
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prerequisite_ids": {
"items": {
"type": "string"
},
"title": "Prerequisite Ids",
"type": "array"
},
"prerequisite_refs": {
"items": {
"type": "string"
},
"title": "Prerequisite Refs",
"type": "array"
},
"topic_source_ids": {
"items": {
"type": "string"
},
"title": "Topic Source Ids",
"type": "array"
},
"topic_source_refs": {
"items": {
"type": "string"
},
"title": "Topic Source Refs",
"type": "array"
},
"type": {
"$ref": "#/components/schemas/KnowledgeType",
"default": "concept"
}
},
"required": [
"name"
],
"title": "KnowledgePointInput",
"type": "object"
},
"KnowledgeType": {
"enum": [
"memory",
"concept",
"procedure",
"design"
],
"title": "KnowledgeType",
"type": "string"
},
"LLMSelection": {
"additionalProperties": false,
"properties": {
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "LLMSelection",
"type": "object"
},
"LanguageUpdate": {
"properties": {
"language": {
"enum": [
"en",
"zh",
"fr",
"de",
"uk",
"pl"
],
"title": "Language",
"type": "string"
}
},
"required": [
"language"
],
"title": "LanguageUpdate",
"type": "object"
},
"LearnerOverrideRequest": {
"properties": {
"mastered": {
"title": "Mastered",
"type": "boolean"
},
"note": {
"default": "",
"maxLength": 500,
"title": "Note",
"type": "string"
}
},
"required": [
"mastered"
],
"title": "LearnerOverrideRequest",
"type": "object"
},
"LearnerProfileRequest": {
"properties": {
"age": {
"anyOf": [
{
"maximum": 120.0,
"minimum": 3.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Age"
},
"curriculum": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Curriculum"
},
"explanation_style": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Explanation Style"
},
"grade_level": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Grade Level"
},
"language": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"reading_level": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Reading Level"
}
},
"title": "LearnerProfileRequest",
"type": "object"
},
"LearningCaptureCreateRequest": {
"properties": {
"block_id": {
"default": "",
"title": "Block Id",
"type": "string"
},
"book_title": {
"default": "",
"title": "Book Title",
"type": "string"
},
"chapter_title": {
"default": "",
"title": "Chapter Title",
"type": "string"
},
"context_after": {
"default": "",
"title": "Context After",
"type": "string"
},
"context_before": {
"default": "",
"title": "Context Before",
"type": "string"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"source_locator": {
"default": "",
"title": "Source Locator",
"type": "string"
},
"source_text": {
"title": "Source Text",
"type": "string"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"user_note": {
"default": "",
"title": "User Note",
"type": "string"
}
},
"required": [
"page_id",
"source_text"
],
"title": "LearningCaptureCreateRequest",
"type": "object"
},
"LearningCaptureUpdateRequest": {
"properties": {
"rejected_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rejected Reason"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"user_note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Note"
}
},
"title": "LearningCaptureUpdateRequest",
"type": "object"
},
"LightRagConfigUpdate": {
"description": "Partial update for LightRAG query + indexing knobs (omitted fields kept).",
"properties": {
"entity_extract_max_gleaning": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Entity Extract Max Gleaning"
},
"llm_model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Llm Model Id"
},
"llm_model_max_async": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Llm Model Max Async"
},
"llm_profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Llm Profile Id"
},
"llm_timeout": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Llm Timeout"
},
"max_concurrent_files": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Concurrent Files"
},
"response_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Response Type"
},
"role_models": {
"anyOf": [
{
"$ref": "#/components/schemas/LightRagRoleModels"
},
{
"type": "null"
}
]
},
"top_k": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Top K"
}
},
"title": "LightRagConfigUpdate",
"type": "object"
},
"LightRagIndexingSelection": {
"additionalProperties": false,
"description": "Resolved create/rebuild overrides, without mutable engine inheritance.",
"properties": {
"extract": {
"$ref": "#/components/schemas/LightRagModelSelection"
},
"vlm": {
"$ref": "#/components/schemas/LightRagIndexingVision"
}
},
"required": [
"extract"
],
"title": "LightRagIndexingSelection",
"type": "object"
},
"LightRagIndexingVision": {
"additionalProperties": false,
"description": "Represent an explicitly enabled or disabled indexing vision model.",
"properties": {
"mode": {
"default": "disabled",
"enum": [
"disabled",
"enabled"
],
"title": "Mode",
"type": "string"
},
"selection": {
"anyOf": [
{
"$ref": "#/components/schemas/LightRagModelSelection"
},
{
"type": "null"
}
]
}
},
"title": "LightRagIndexingVision",
"type": "object"
},
"LightRagModelSelection": {
"additionalProperties": false,
"description": "Identify a catalog model and its optional reasoning selection.",
"properties": {
"model_id": {
"maxLength": 128,
"minLength": 1,
"title": "Model Id",
"type": "string"
},
"profile_id": {
"maxLength": 128,
"minLength": 1,
"title": "Profile Id",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max",
"adaptive"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "LightRagModelSelection",
"type": "object"
},
"LightRagRoleModel": {
"additionalProperties": false,
"description": "Configure a text role through base inheritance or an explicit model.",
"properties": {
"max_async": {
"default": 4,
"maximum": 32.0,
"minimum": 1.0,
"title": "Max Async",
"type": "integer"
},
"mode": {
"default": "inherit",
"enum": [
"inherit",
"model"
],
"title": "Mode",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max",
"adaptive"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
},
"selection": {
"anyOf": [
{
"$ref": "#/components/schemas/LightRagModelSelection"
},
{
"type": "null"
}
]
},
"timeout": {
"default": 240,
"maximum": 3600.0,
"minimum": 1.0,
"title": "Timeout",
"type": "integer"
}
},
"title": "LightRagRoleModel",
"type": "object"
},
"LightRagRoleModels": {
"additionalProperties": false,
"description": "Group the independent base model and its four role overrides.",
"properties": {
"base": {
"$ref": "#/components/schemas/LightRagModelSelection"
},
"extract": {
"$ref": "#/components/schemas/LightRagRoleModel"
},
"keyword": {
"$ref": "#/components/schemas/LightRagRoleModel"
},
"query": {
"$ref": "#/components/schemas/LightRagRoleModel"
},
"vlm": {
"$ref": "#/components/schemas/LightRagVisionModel"
}
},
"required": [
"base"
],
"title": "LightRagRoleModels",
"type": "object"
},
"LightRagServerConfigUpdate": {
"description": "Reusable LightRAG Server defaults (individual KBs may override them).",
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"server_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Server Url"
}
},
"title": "LightRagServerConfigUpdate",
"type": "object"
},
"LightRagVisionModel": {
"additionalProperties": false,
"description": "Configure disabled, inherited, or explicit vision model execution.",
"properties": {
"max_async": {
"default": 4,
"maximum": 32.0,
"minimum": 1.0,
"title": "Max Async",
"type": "integer"
},
"mode": {
"default": "disabled",
"enum": [
"disabled",
"inherit",
"model"
],
"title": "Mode",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max",
"adaptive"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
},
"selection": {
"anyOf": [
{
"$ref": "#/components/schemas/LightRagModelSelection"
},
{
"type": "null"
}
]
},
"timeout": {
"default": 240,
"maximum": 3600.0,
"minimum": 1.0,
"title": "Timeout",
"type": "integer"
}
},
"title": "LightRagVisionModel",
"type": "object"
},
"LinkFolderRequest": {
"description": "Request model for linking a local folder to a KB.",
"properties": {
"folder_path": {
"title": "Folder Path",
"type": "string"
}
},
"required": [
"folder_path"
],
"title": "LinkFolderRequest",
"type": "object"
},
"LinkStatus": {
"additionalProperties": false,
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"workspace_id": {
"default": "",
"maxLength": 200,
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"enabled"
],
"title": "LinkStatus",
"type": "object"
},
"LinkTasks": {
"additionalProperties": false,
"properties": {
"task_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Task Ids",
"type": "array"
},
"workspace_id": {
"default": "",
"maxLength": 200,
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"task_ids"
],
"title": "LinkTasks",
"type": "object"
},
"LinkedFolderInfo": {
"description": "Response model for linked folder information.",
"properties": {
"added_at": {
"title": "Added At",
"type": "string"
},
"file_count": {
"title": "File Count",
"type": "integer"
},
"id": {
"title": "Id",
"type": "string"
},
"last_sync": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Sync"
},
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"id",
"path",
"added_at",
"file_count"
],
"title": "LinkedFolderInfo",
"type": "object"
},
"ListImaRequest": {
"properties": {
"api_key": {
"default": "",
"title": "Api Key",
"type": "string"
},
"client_id": {
"default": "",
"title": "Client Id",
"type": "string"
},
"cursor": {
"default": "",
"title": "Cursor",
"type": "string"
},
"limit": {
"default": 20,
"maximum": 50.0,
"minimum": 1.0,
"title": "Limit",
"type": "integer"
}
},
"title": "ListImaRequest",
"type": "object"
},
"ListImaResponse": {
"properties": {
"is_end": {
"title": "Is End",
"type": "boolean"
},
"knowledge_bases": {
"items": {
"$ref": "#/components/schemas/ImaKnowledgeBaseSummary"
},
"title": "Knowledge Bases",
"type": "array"
},
"next_cursor": {
"title": "Next Cursor",
"type": "string"
}
},
"required": [
"knowledge_bases",
"next_cursor",
"is_end"
],
"title": "ListImaResponse",
"type": "object"
},
"LlamaIndexConfigUpdate": {
"description": "Partial update for the LlamaIndex engine knobs (omitted fields kept).",
"properties": {
"bm25_top_k_multiplier": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Bm25 Top K Multiplier"
},
"chunk_overlap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Chunk Overlap"
},
"chunk_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Chunk Size"
},
"hnsw_ef_construction": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Hnsw Ef Construction"
},
"hnsw_ef_search": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Hnsw Ef Search"
},
"hnsw_m": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Hnsw M"
},
"image_description_batch_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Image Description Batch Size"
},
"image_description_concurrency": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Image Description Concurrency"
},
"image_description_timeout_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Image Description Timeout Seconds"
},
"rerank_top_k": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rerank Top K"
},
"reranker_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reranker Model"
},
"retrieval_profile": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Retrieval Profile"
},
"top_k": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Top K"
},
"vector_index_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Vector Index Type"
},
"vector_top_k_multiplier": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Vector Top K Multiplier"
}
},
"title": "LlamaIndexConfigUpdate",
"type": "object"
},
"LoginRequest": {
"description": "Payload for the POST /login endpoint.",
"properties": {
"password": {
"title": "Password",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "LoginRequest",
"type": "object"
},
"MCPServerConfig": {
"description": "One MCP server entry.\n\n``type`` is auto-detected when omitted: ``command`` ⇒ stdio; a ``url``\nending in ``/sse`` ⇒ sse; any other ``url`` ⇒ streamableHttp.",
"properties": {
"allow_private_network": {
"default": false,
"title": "Allow Private Network",
"type": "boolean"
},
"args": {
"items": {
"type": "string"
},
"title": "Args",
"type": "array"
},
"auth": {
"default": "",
"enum": [
"",
"oauth"
],
"title": "Auth",
"type": "string"
},
"catalog_entry": {
"default": "",
"title": "Catalog Entry",
"type": "string"
},
"command": {
"default": "",
"title": "Command",
"type": "string"
},
"cwd": {
"default": "",
"title": "Cwd",
"type": "string"
},
"disabled_tools": {
"items": {
"type": "string"
},
"title": "Disabled Tools",
"type": "array"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"enabled_tools": {
"items": {
"type": "string"
},
"title": "Enabled Tools",
"type": "array"
},
"env": {
"additionalProperties": {
"type": "string"
},
"title": "Env",
"type": "object"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"title": "Headers",
"type": "object"
},
"tool_timeout": {
"default": 30,
"maximum": 600.0,
"minimum": 1.0,
"title": "Tool Timeout",
"type": "integer"
},
"type": {
"anyOf": [
{
"enum": [
"stdio",
"sse",
"streamableHttp"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
},
"url": {
"default": "",
"title": "Url",
"type": "string"
}
},
"title": "MCPServerConfig",
"type": "object"
},
"MCPSettingsPayload": {
"properties": {
"servers": {
"additionalProperties": {
"$ref": "#/components/schemas/MCPServerConfig"
},
"title": "Servers",
"type": "object"
}
},
"title": "MCPSettingsPayload",
"type": "object"
},
"ManagedUpdateRequest": {
"properties": {
"confirmation": {
"const": "update-and-restart",
"title": "Confirmation",
"type": "string"
}
},
"required": [
"confirmation"
],
"title": "ManagedUpdateRequest",
"type": "object"
},
"MarkCreateRequest": {
"properties": {
"end_locator": {
"default": 0,
"minimum": 0.0,
"title": "End Locator",
"type": "integer"
},
"end_seconds": {
"maximum": 86400.0,
"minimum": 0.0,
"title": "End Seconds",
"type": "number"
},
"kind": {
"maxLength": 32,
"minLength": 1,
"title": "Kind",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"title": "Metadata",
"type": "object"
},
"note": {
"default": "",
"maxLength": 2000,
"title": "Note",
"type": "string"
},
"quote": {
"default": "",
"maxLength": 4000,
"title": "Quote",
"type": "string"
},
"start_locator": {
"default": 0,
"minimum": 0.0,
"title": "Start Locator",
"type": "integer"
},
"start_seconds": {
"maximum": 86400.0,
"minimum": 0.0,
"title": "Start Seconds",
"type": "number"
}
},
"required": [
"kind",
"start_seconds",
"end_seconds"
],
"title": "MarkCreateRequest",
"type": "object"
},
"MarkPatchRequest": {
"properties": {
"end_locator": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "End Locator"
},
"end_seconds": {
"anyOf": [
{
"maximum": 86400.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "End Seconds"
},
"kind": {
"anyOf": [
{
"maxLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"title": "Kind"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"note": {
"anyOf": [
{
"maxLength": 2000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"quote": {
"anyOf": [
{
"maxLength": 4000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Quote"
},
"reviewed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Reviewed"
},
"start_locator": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Locator"
},
"start_seconds": {
"anyOf": [
{
"maximum": 86400.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Start Seconds"
}
},
"title": "MarkPatchRequest",
"type": "object"
},
"MarkSuggestionRequest": {
"properties": {
"time_seconds": {
"default": 0.0,
"maximum": 86400.0,
"minimum": 0.0,
"title": "Time Seconds",
"type": "number"
}
},
"title": "MarkSuggestionRequest",
"type": "object"
},
"MasteryCardAnswer": {
"additionalProperties": false,
"description": "An answer submitted from a mastery question card.\n\nThe card outlives the turn that posed it — posing a question ends that\nturn — so the answer arrives as the next turn's message. This says which\nquestion the message is answering, letting the runtime commit it to the\nengine before the tutor's first token instead of asking the model to\nrecover the pairing from prose.",
"properties": {
"answers": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"maxProperties": 4,
"minProperties": 1,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Answers"
},
"question_id": {
"minLength": 1,
"title": "Question Id",
"type": "string"
},
"text": {
"minLength": 1,
"title": "Text",
"type": "string"
}
},
"required": [
"question_id",
"text"
],
"title": "MasteryCardAnswer",
"type": "object"
},
"MasteryCardSkip": {
"additionalProperties": false,
"description": "A question the learner dropped instead of answering.\n\nThe same shape of problem as :class:`MasteryCardAnswer`: the card outlives\nthe turn that posed it, so \"not this one\" also arrives as the next turn's\nmessage. Naming the question is what keeps the runtime from abandoning\nwhatever happens to be open by the time the turn starts.",
"properties": {
"question_id": {
"minLength": 1,
"title": "Question Id",
"type": "string"
}
},
"required": [
"question_id"
],
"title": "MasteryCardSkip",
"type": "object"
},
"MaterialDetail": {
"properties": {
"annotation_count": {
"default": 0,
"title": "Annotation Count",
"type": "integer"
},
"byte_size": {
"default": 0,
"title": "Byte Size",
"type": "integer"
},
"char_count": {
"default": 0,
"title": "Char Count",
"type": "integer"
},
"content_format": {
"default": "plain_text",
"enum": [
"plain_text",
"web_markdown"
],
"title": "Content Format",
"type": "string"
},
"created_at": {
"default": 0.0,
"title": "Created At",
"type": "number"
},
"extractor": {
"default": "",
"title": "Extractor",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"has_raw_view": {
"default": false,
"title": "Has Raw View",
"type": "boolean"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"mime": {
"default": "",
"title": "Mime",
"type": "string"
},
"outline": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Outline",
"type": "array"
},
"outline_text": {
"default": "",
"title": "Outline Text",
"type": "string"
},
"render_mode": {
"default": "text",
"enum": [
"text",
"pdf",
"epub",
"video",
"audio"
],
"title": "Render Mode",
"type": "string"
},
"revision": {
"default": 1,
"title": "Revision",
"type": "integer"
},
"source_type": {
"default": "upload",
"title": "Source Type",
"type": "string"
},
"source_url": {
"default": "",
"title": "Source Url",
"type": "string"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"unit": {
"title": "Unit",
"type": "string"
},
"unit_count": {
"title": "Unit Count",
"type": "integer"
},
"unit_refs": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Unit Refs",
"type": "array"
}
},
"required": [
"material_id",
"filename",
"unit",
"unit_count"
],
"title": "MaterialDetail",
"type": "object"
},
"MaterialInfo": {
"properties": {
"annotation_count": {
"default": 0,
"title": "Annotation Count",
"type": "integer"
},
"byte_size": {
"default": 0,
"title": "Byte Size",
"type": "integer"
},
"char_count": {
"default": 0,
"title": "Char Count",
"type": "integer"
},
"content_format": {
"default": "plain_text",
"enum": [
"plain_text",
"web_markdown"
],
"title": "Content Format",
"type": "string"
},
"created_at": {
"default": 0.0,
"title": "Created At",
"type": "number"
},
"extractor": {
"default": "",
"title": "Extractor",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"has_raw_view": {
"default": false,
"title": "Has Raw View",
"type": "boolean"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"mime": {
"default": "",
"title": "Mime",
"type": "string"
},
"render_mode": {
"default": "text",
"enum": [
"text",
"pdf",
"epub",
"video",
"audio"
],
"title": "Render Mode",
"type": "string"
},
"revision": {
"default": 1,
"title": "Revision",
"type": "integer"
},
"source_type": {
"default": "upload",
"title": "Source Type",
"type": "string"
},
"source_url": {
"default": "",
"title": "Source Url",
"type": "string"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"unit": {
"title": "Unit",
"type": "string"
},
"unit_count": {
"title": "Unit Count",
"type": "integer"
}
},
"required": [
"material_id",
"filename",
"unit",
"unit_count"
],
"title": "MaterialInfo",
"type": "object"
},
"MinerUModelDownloadPayload": {
"description": "One-click model download request (draft form values, like /test).",
"properties": {
"endpoint": {
"default": "",
"title": "Endpoint",
"type": "string"
},
"local_cli_path": {
"default": "",
"title": "Local Cli Path",
"type": "string"
},
"model_type": {
"default": "pipeline",
"enum": [
"pipeline",
"vlm",
"all"
],
"title": "Model Type",
"type": "string"
},
"source": {
"default": "huggingface",
"enum": [
"huggingface",
"modelscope"
],
"title": "Source",
"type": "string"
}
},
"title": "MinerUModelDownloadPayload",
"type": "object"
},
"MinerUSettingsUpdate": {
"description": "MinerU document-parsing backend settings.\n\n``api_token`` is tri-state: ``None`` keeps the stored token (the UI sends\nNone when the user didn't edit the secret field), ``\"\"`` clears it, and a\nnon-empty string or string array replaces it. The GET payload never echoes\nthe raw token.",
"properties": {
"allow_local_model_download": {
"default": false,
"title": "Allow Local Model Download",
"type": "boolean"
},
"api_base_url": {
"default": "https://mineru.net",
"title": "Api Base Url",
"type": "string"
},
"api_token": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Api Token"
},
"enable_formula": {
"default": true,
"title": "Enable Formula",
"type": "boolean"
},
"enable_table": {
"default": true,
"title": "Enable Table",
"type": "boolean"
},
"is_ocr": {
"default": false,
"title": "Is Ocr",
"type": "boolean"
},
"language": {
"default": "auto",
"title": "Language",
"type": "string"
},
"local_cli_path": {
"default": "",
"title": "Local Cli Path",
"type": "string"
},
"mode": {
"default": "local",
"enum": [
"local",
"cloud"
],
"title": "Mode",
"type": "string"
},
"model_download_endpoint": {
"default": "",
"title": "Model Download Endpoint",
"type": "string"
},
"model_download_source": {
"default": "huggingface",
"enum": [
"huggingface",
"modelscope"
],
"title": "Model Download Source",
"type": "string"
},
"model_version": {
"default": "pipeline",
"enum": [
"pipeline",
"vlm"
],
"title": "Model Version",
"type": "string"
}
},
"title": "MinerUSettingsUpdate",
"type": "object"
},
"ModelCapabilitiesQuery": {
"properties": {
"binding": {
"default": "",
"title": "Binding",
"type": "string"
},
"model": {
"default": "",
"title": "Model",
"type": "string"
}
},
"title": "ModelCapabilitiesQuery",
"type": "object"
},
"ModelUsage": {
"properties": {
"cache_creation_input_tokens": {
"default": 0,
"title": "Cache Creation Input Tokens",
"type": "integer"
},
"cache_hit_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cache Hit Rate"
},
"cache_input_tokens": {
"default": 0,
"title": "Cache Input Tokens",
"type": "integer"
},
"cache_read_input_tokens": {
"default": 0,
"title": "Cache Read Input Tokens",
"type": "integer"
},
"cache_reported_calls": {
"default": 0,
"title": "Cache Reported Calls",
"type": "integer"
},
"completion_tokens": {
"default": 0,
"title": "Completion Tokens",
"type": "integer"
},
"duration_seconds": {
"default": 0,
"title": "Duration Seconds",
"type": "number"
},
"estimated_calls": {
"default": 0,
"title": "Estimated Calls",
"type": "integer"
},
"model": {
"default": "",
"title": "Model",
"type": "string"
},
"prompt_tokens": {
"default": 0,
"title": "Prompt Tokens",
"type": "integer"
},
"provider": {
"default": "",
"title": "Provider",
"type": "string"
},
"tokens_per_second": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Tokens Per Second"
},
"total_calls": {
"default": 0,
"title": "Total Calls",
"type": "integer"
},
"total_tokens": {
"default": 0,
"title": "Total Tokens",
"type": "integer"
},
"ttft_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Ttft Seconds"
}
},
"title": "ModelUsage",
"type": "object"
},
"ModuleInput": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"knowledge_points": {
"items": {
"$ref": "#/components/schemas/KnowledgePointInput"
},
"title": "Knowledge Points",
"type": "array"
},
"name": {
"maxLength": 200,
"minLength": 1,
"title": "Name",
"type": "string"
},
"objective": {
"default": "",
"maxLength": 300,
"title": "Objective",
"type": "string"
},
"order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Order"
},
"pass_threshold": {
"default": 0.7,
"title": "Pass Threshold",
"type": "number"
}
},
"required": [
"name"
],
"title": "ModuleInput",
"type": "object"
},
"MoveBlockRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"new_position": {
"title": "New Position",
"type": "integer"
},
"page_id": {
"title": "Page Id",
"type": "string"
}
},
"required": [
"book_id",
"page_id",
"block_id",
"new_position"
],
"title": "MoveBlockRequest",
"type": "object"
},
"MoveFilePayload": {
"properties": {
"dest_folder": {
"default": "",
"title": "Dest Folder",
"type": "string"
},
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "MoveFilePayload",
"type": "object"
},
"MoveRecordRequest": {
"description": "Move or copy a record into another notebook.",
"properties": {
"target_notebook_id": {
"title": "Target Notebook Id",
"type": "string"
}
},
"required": [
"target_notebook_id"
],
"title": "MoveRecordRequest",
"type": "object"
},
"NavigationSession": {
"properties": {
"kind": {
"enum": [
"partner",
"group"
],
"title": "Kind",
"type": "string"
},
"owner_id": {
"title": "Owner Id",
"type": "string"
},
"owner_name": {
"title": "Owner Name",
"type": "string"
},
"session_key": {
"title": "Session Key",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"kind",
"owner_id",
"owner_name",
"session_key",
"title",
"updated_at"
],
"title": "NavigationSession",
"type": "object"
},
"NetworkSettingsUpdate": {
"properties": {
"backend_port": {
"maximum": 65535.0,
"minimum": 1.0,
"title": "Backend Port",
"type": "integer"
},
"cors_origins": {
"items": {
"type": "string"
},
"title": "Cors Origins",
"type": "array"
},
"frontend_port": {
"maximum": 65535.0,
"minimum": 1.0,
"title": "Frontend Port",
"type": "integer"
},
"public_api_base": {
"default": "",
"title": "Public Api Base",
"type": "string"
}
},
"required": [
"backend_port",
"frontend_port"
],
"title": "NetworkSettingsUpdate",
"type": "object"
},
"NoteGeneration": {
"additionalProperties": false,
"description": "The learning block on the open note page this turn fills in.\n\nSent by the note companion when a block's own \"Generate\" runs. The server\nowns the instructions that follow from it, so the learner's message stays\nexactly what they see in the conversation.",
"properties": {
"block_id": {
"maxLength": 64,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Block Id",
"type": "string"
},
"kind": {
"default": "",
"maxLength": 32,
"title": "Kind",
"type": "string"
}
},
"required": [
"block_id"
],
"title": "NoteGeneration",
"type": "object"
},
"NotebookCaptureRequest": {
"properties": {
"material_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Material Ids",
"type": "array"
},
"notebook_ids": {
"items": {
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"title": "Notebook Ids",
"type": "array"
},
"summary": {
"default": "",
"maxLength": 1000,
"title": "Summary",
"type": "string"
},
"title": {
"default": "",
"maxLength": 300,
"title": "Title",
"type": "string"
}
},
"required": [
"notebook_ids"
],
"title": "NotebookCaptureRequest",
"type": "object"
},
"NotebookEntryItem": {
"properties": {
"ai_judgment": {
"default": "",
"title": "Ai Judgment",
"type": "string"
},
"assessment_type": {
"default": "",
"title": "Assessment Type",
"type": "string"
},
"attempt_count": {
"default": 1,
"title": "Attempt Count",
"type": "integer"
},
"bookmarked": {
"default": false,
"title": "Bookmarked",
"type": "boolean"
},
"categories": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CategoryItem"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Categories"
},
"confidence": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Confidence"
},
"correct_answer": {
"default": "",
"title": "Correct Answer",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "number"
},
"difficulty": {
"default": "",
"title": "Difficulty",
"type": "string"
},
"explanation": {
"default": "",
"title": "Explanation",
"type": "string"
},
"followup_session_id": {
"default": "",
"title": "Followup Session Id",
"type": "string"
},
"hints_used": {
"default": 0,
"title": "Hints Used",
"type": "integer"
},
"id": {
"title": "Id",
"type": "integer"
},
"is_correct": {
"default": false,
"title": "Is Correct",
"type": "boolean"
},
"knowledge_point_id": {
"default": "",
"title": "Knowledge Point Id",
"type": "string"
},
"mastery_path_id": {
"default": "",
"title": "Mastery Path Id",
"type": "string"
},
"material_id": {
"default": "",
"title": "Material Id",
"type": "string"
},
"material_title": {
"default": "",
"title": "Material Title",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Options",
"type": "object"
},
"origin_ref": {
"default": "",
"title": "Origin Ref",
"type": "string"
},
"origin_type": {
"default": "conversation",
"enum": [
"conversation",
"external_import",
"document_analysis"
],
"title": "Origin Type",
"type": "string"
},
"practice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Practice"
},
"quality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quality"
},
"question": {
"title": "Question",
"type": "string"
},
"question_id": {
"default": "",
"title": "Question Id",
"type": "string"
},
"question_type": {
"default": "",
"title": "Question Type",
"type": "string"
},
"resolved": {
"default": false,
"title": "Resolved",
"type": "boolean"
},
"response_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Response Time"
},
"result": {
"anyOf": [
{
"enum": [
"correct",
"incorrect",
"partial",
"ungraded",
"voided"
],
"type": "string"
},
{
"type": "string"
}
],
"default": "",
"title": "Result"
},
"score_trend": {
"default": "new",
"enum": [
"new",
"improved",
"declined",
"unchanged"
],
"title": "Score Trend",
"type": "string"
},
"section_id": {
"default": "",
"title": "Section Id",
"type": "string"
},
"section_title": {
"default": "",
"title": "Section Title",
"type": "string"
},
"session_id": {
"default": "",
"title": "Session Id",
"type": "string"
},
"session_title": {
"default": "",
"title": "Session Title",
"type": "string"
},
"source": {
"default": "deep_question",
"enum": [
"deep_question",
"mastery_path",
"immersive_reading",
"book",
"partner_chat",
"import"
],
"title": "Source",
"type": "string"
},
"turn_id": {
"default": "",
"title": "Turn Id",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
},
"user_answer": {
"default": "",
"title": "User Answer",
"type": "string"
},
"user_answer_images": {
"default": [],
"items": {
"$ref": "#/components/schemas/AnswerImageItem"
},
"title": "User Answer Images",
"type": "array"
}
},
"required": [
"id",
"question",
"created_at",
"updated_at"
],
"title": "NotebookEntryItem",
"type": "object"
},
"NotebookEntryListResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/NotebookEntryItem"
},
"title": "Items",
"type": "array"
},
"total": {
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total"
],
"title": "NotebookEntryListResponse",
"type": "object"
},
"NotebookRecordInput": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"output": {
"default": "",
"title": "Output",
"type": "string"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"type": {
"default": "note",
"title": "Type",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookRecordInput",
"type": "object"
},
"NotebookReference": {
"additionalProperties": false,
"properties": {
"notebook_id": {
"title": "Notebook Id",
"type": "string"
},
"record_ids": {
"items": {
"type": "string"
},
"title": "Record Ids",
"type": "array"
}
},
"required": [
"notebook_id"
],
"title": "NotebookReference",
"type": "object"
},
"Occurrence": {
"description": "One rendered instance of a stored event.",
"properties": {
"all_day": {
"title": "All Day",
"type": "boolean"
},
"calendar_id": {
"title": "Calendar Id",
"type": "string"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"end": {
"title": "End",
"type": "string"
},
"event_id": {
"title": "Event Id",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"occurrence": {
"title": "Occurrence",
"type": "string"
},
"recurring": {
"title": "Recurring",
"type": "boolean"
},
"reminder_times": {
"items": {
"type": "string"
},
"title": "Reminder Times",
"type": "array"
},
"reminders": {
"items": {
"type": "integer"
},
"title": "Reminders",
"type": "array"
},
"rrule": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rrule"
},
"series_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Series Id"
},
"source": {
"default": "user",
"enum": [
"user",
"dito",
"import"
],
"title": "Source",
"type": "string"
},
"start": {
"title": "Start",
"type": "string"
},
"task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"task_workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Workspace Id"
},
"title": {
"title": "Title",
"type": "string"
},
"tzid": {
"title": "Tzid",
"type": "string"
}
},
"required": [
"id",
"event_id",
"series_id",
"occurrence",
"recurring",
"calendar_id",
"title",
"notes",
"location",
"all_day",
"start",
"end",
"tzid",
"rrule",
"reminders",
"color",
"task_id",
"task_workspace_id"
],
"title": "Occurrence",
"type": "object"
},
"OccurrenceList": {
"properties": {
"occurrences": {
"items": {
"$ref": "#/components/schemas/Occurrence"
},
"title": "Occurrences",
"type": "array"
},
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"occurrences",
"revision"
],
"title": "OccurrenceList",
"type": "object"
},
"OrganizeNotesRequest": {
"properties": {
"material_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Material Ids",
"type": "array"
}
},
"title": "OrganizeNotesRequest",
"type": "object"
},
"OutgoingAttachment": {
"additionalProperties": false,
"properties": {
"base64": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Base64"
},
"filename": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filename"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"type": {
"title": "Type",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
}
},
"required": [
"type"
],
"title": "OutgoingAttachment",
"type": "object"
},
"PageChatSessionRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"session_id": {
"title": "Session Id",
"type": "string"
}
},
"required": [
"book_id",
"page_id",
"session_id"
],
"title": "PageChatSessionRequest",
"type": "object"
},
"PageIndexConfigUpdate": {
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key"
}
},
"title": "PageIndexConfigUpdate",
"type": "object"
},
"PairRequest": {
"properties": {
"device_kind": {
"default": "macos",
"maxLength": 32,
"title": "Device Kind",
"type": "string"
},
"device_name": {
"default": "",
"maxLength": 128,
"title": "Device Name",
"type": "string"
}
},
"title": "PairRequest",
"type": "object"
},
"PairResponse": {
"properties": {
"device_id": {
"title": "Device Id",
"type": "string"
},
"device_kind": {
"title": "Device Kind",
"type": "string"
},
"device_name": {
"title": "Device Name",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"device_id",
"token",
"device_name",
"device_kind"
],
"title": "PairResponse",
"type": "object"
},
"PartnerGroupMessageRequest": {
"properties": {
"content": {
"minLength": 1,
"title": "Content",
"type": "string"
},
"mentions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mentions"
},
"session_key": {
"default": "default",
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
"required": [
"content"
],
"title": "PartnerGroupMessageRequest",
"type": "object"
},
"PartnerInvocationActionRequest": {
"properties": {
"session_key": {
"default": "default",
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
"title": "PartnerInvocationActionRequest",
"type": "object"
},
"PartnerNavigation": {
"properties": {
"groups": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Groups",
"type": "array"
},
"partners": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Partners",
"type": "array"
},
"sessions": {
"items": {
"$ref": "#/components/schemas/NavigationSession"
},
"title": "Sessions",
"type": "array"
},
"unavailable": {
"items": {
"type": "string"
},
"title": "Unavailable",
"type": "array"
}
},
"required": [
"partners",
"groups",
"sessions",
"unavailable"
],
"title": "PartnerNavigation",
"type": "object"
},
"PartnerSeatRetryRequest": {
"properties": {
"session_key": {
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
"required": [
"session_key"
],
"title": "PartnerSeatRetryRequest",
"type": "object"
},
"PauseBookRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
}
},
"required": [
"book_id"
],
"title": "PauseBookRequest",
"type": "object"
},
"PositionInfo": {
"properties": {
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"percentage": {
"default": 0.0,
"title": "Percentage",
"type": "number"
},
"source_anchor": {
"default": "",
"maxLength": 4096,
"title": "Source Anchor",
"type": "string"
},
"updated_at": {
"default": 0.0,
"title": "Updated At",
"type": "number"
}
},
"required": [
"locator"
],
"title": "PositionInfo",
"type": "object"
},
"PositionPayload": {
"properties": {
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"percentage": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"title": "Percentage"
},
"source_anchor": {
"default": "",
"maxLength": 4096,
"title": "Source Anchor",
"type": "string"
}
},
"required": [
"locator"
],
"title": "PositionPayload",
"type": "object"
},
"PracticeAnalytics": {
"properties": {
"daily": {
"items": {
"$ref": "#/components/schemas/PracticeDailyCounts"
},
"title": "Daily",
"type": "array"
},
"days": {
"title": "Days",
"type": "integer"
},
"end_date": {
"title": "End Date",
"type": "string"
},
"sources": {
"items": {
"$ref": "#/components/schemas/PracticeSourceCounts"
},
"title": "Sources",
"type": "array"
},
"start_date": {
"title": "Start Date",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
},
"totals": {
"$ref": "#/components/schemas/PracticeCounts"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"timezone",
"days",
"start_date",
"end_date",
"updated_at",
"daily",
"sources",
"totals"
],
"title": "PracticeAnalytics",
"type": "object"
},
"PracticeCounts": {
"properties": {
"mistakes": {
"title": "Mistakes",
"type": "integer"
},
"questions": {
"title": "Questions",
"type": "integer"
},
"reviews": {
"title": "Reviews",
"type": "integer"
}
},
"required": [
"questions",
"mistakes",
"reviews"
],
"title": "PracticeCounts",
"type": "object"
},
"PracticeDailyCounts": {
"properties": {
"date": {
"title": "Date",
"type": "string"
},
"mistakes": {
"title": "Mistakes",
"type": "integer"
},
"questions": {
"title": "Questions",
"type": "integer"
},
"reviews": {
"title": "Reviews",
"type": "integer"
}
},
"required": [
"questions",
"mistakes",
"reviews",
"date"
],
"title": "PracticeDailyCounts",
"type": "object"
},
"PracticeQuestion": {
"properties": {
"content_workspace_id": {
"default": "",
"title": "Content Workspace Id",
"type": "string"
},
"content_workspace_name": {
"default": "",
"title": "Content Workspace Name",
"type": "string"
},
"entry": {
"$ref": "#/components/schemas/NotebookEntryItem"
},
"state": {
"additionalProperties": true,
"title": "State",
"type": "object"
}
},
"required": [
"entry",
"state"
],
"title": "PracticeQuestion",
"type": "object"
},
"PracticeSourceCounts": {
"properties": {
"mistakes": {
"title": "Mistakes",
"type": "integer"
},
"questions": {
"title": "Questions",
"type": "integer"
},
"reviews": {
"title": "Reviews",
"type": "integer"
},
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"questions",
"mistakes",
"reviews",
"source"
],
"title": "PracticeSourceCounts",
"type": "object"
},
"PracticeSummary": {
"properties": {
"day_end": {
"title": "Day End",
"type": "number"
},
"due": {
"title": "Due",
"type": "integer"
},
"mistakes": {
"title": "Mistakes",
"type": "integer"
},
"next_due_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Next Due At"
},
"overdue": {
"title": "Overdue",
"type": "integer"
},
"reviewed_today": {
"title": "Reviewed Today",
"type": "integer"
},
"timezone": {
"title": "Timezone",
"type": "string"
},
"total": {
"title": "Total",
"type": "integer"
}
},
"required": [
"total",
"mistakes",
"due",
"overdue",
"reviewed_today",
"next_due_at",
"day_end",
"timezone"
],
"title": "PracticeSummary",
"type": "object"
},
"ProbeFolderRequest": {
"properties": {
"folder_path": {
"title": "Folder Path",
"type": "string"
},
"rag_provider": {
"default": "llamaindex",
"title": "Rag Provider",
"type": "string"
}
},
"required": [
"folder_path"
],
"title": "ProbeFolderRequest",
"type": "object"
},
"ProbeImaRequest": {
"properties": {
"api_key": {
"default": "",
"title": "Api Key",
"type": "string"
},
"client_id": {
"default": "",
"title": "Client Id",
"type": "string"
},
"knowledge_base_id": {
"title": "Knowledge Base Id",
"type": "string"
}
},
"required": [
"knowledge_base_id"
],
"title": "ProbeImaRequest",
"type": "object"
},
"ProbeLightRagServerRequest": {
"properties": {
"api_key": {
"default": "",
"title": "Api Key",
"type": "string"
},
"server_url": {
"title": "Server Url",
"type": "string"
},
"use_saved_api_key": {
"default": false,
"title": "Use Saved Api Key",
"type": "boolean"
}
},
"required": [
"server_url"
],
"title": "ProbeLightRagServerRequest",
"type": "object"
},
"ProbeWeKnoraRequest": {
"properties": {
"api_key": {
"title": "Api Key",
"type": "string"
},
"knowledge_base_id": {
"title": "Knowledge Base Id",
"type": "string"
},
"server_url": {
"title": "Server Url",
"type": "string"
}
},
"required": [
"server_url",
"api_key",
"knowledge_base_id"
],
"title": "ProbeWeKnoraRequest",
"type": "object"
},
"ProviderEditPayload": {
"properties": {
"activate": {
"default": false,
"title": "Activate",
"type": "boolean"
},
"active_model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Active Model Id"
},
"connection": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Connection"
},
"profile": {
"additionalProperties": true,
"title": "Profile",
"type": "object"
},
"service": {
"enum": [
"llm",
"task",
"embedding",
"search",
"tts",
"stt",
"imagegen",
"videogen"
],
"title": "Service",
"type": "string"
}
},
"required": [
"service",
"profile"
],
"title": "ProviderEditPayload",
"type": "object"
},
"ProviderModeUpdate": {
"description": "Set an engine's global default retrieval mode (from its engine card).",
"properties": {
"mode": {
"title": "Mode",
"type": "string"
}
},
"required": [
"mode"
],
"title": "ProviderModeUpdate",
"type": "object"
},
"ProviderProbePayload": {
"properties": {
"api_format": {
"default": "auto",
"title": "Api Format",
"type": "string"
},
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Api Key"
},
"api_version": {
"default": "",
"title": "Api Version",
"type": "string"
},
"base_url": {
"default": "",
"title": "Base Url",
"type": "string"
},
"binding": {
"default": "openai",
"title": "Binding",
"type": "string"
},
"connection_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Connection Id"
},
"extra_headers": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extra Headers"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
},
"proxy": {
"default": "",
"title": "Proxy",
"type": "string"
},
"service": {
"default": "llm",
"enum": [
"llm",
"task",
"embedding",
"search",
"tts",
"stt",
"imagegen",
"videogen"
],
"title": "Service",
"type": "string"
}
},
"title": "ProviderProbePayload",
"type": "object"
},
"QuestionBankMaterial": {
"properties": {
"entry_count": {
"title": "Entry Count",
"type": "integer"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"material_title": {
"title": "Material Title",
"type": "string"
},
"source": {
"title": "Source",
"type": "string"
},
"unresolved_count": {
"title": "Unresolved Count",
"type": "integer"
}
},
"required": [
"source",
"material_id",
"material_title",
"entry_count",
"unresolved_count"
],
"title": "QuestionBankMaterial",
"type": "object"
},
"QuestionBankStats": {
"properties": {
"bookmarked": {
"default": 0,
"title": "Bookmarked",
"type": "integer"
},
"total": {
"default": 0,
"title": "Total",
"type": "integer"
},
"uncategorized": {
"default": 0,
"title": "Uncategorized",
"type": "integer"
},
"unresolved": {
"default": 0,
"title": "Unresolved",
"type": "integer"
},
"wrong": {
"default": 0,
"title": "Wrong",
"type": "integer"
}
},
"title": "QuestionBankStats",
"type": "object"
},
"QuizAnswerItem": {
"properties": {
"question_id": {
"minLength": 1,
"title": "Question Id",
"type": "string"
},
"selected_index": {
"minimum": 0.0,
"title": "Selected Index",
"type": "integer"
}
},
"required": [
"question_id",
"selected_index"
],
"title": "QuizAnswerItem",
"type": "object"
},
"QuizAnswersPayload": {
"properties": {
"answers": {
"items": {
"$ref": "#/components/schemas/QuizAnswerItem"
},
"minItems": 1,
"title": "Answers",
"type": "array"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"section_title": {
"default": "",
"maxLength": 500,
"title": "Section Title",
"type": "string"
},
"session_id": {
"default": "",
"title": "Session Id",
"type": "string"
},
"source_anchor": {
"default": "",
"maxLength": 2000,
"title": "Source Anchor",
"type": "string"
},
"submission_id": {
"default": "",
"maxLength": 200,
"title": "Submission Id",
"type": "string"
},
"turn_id": {
"default": "",
"title": "Turn Id",
"type": "string"
}
},
"required": [
"locator",
"answers"
],
"title": "QuizAnswersPayload",
"type": "object"
},
"QuizAttemptRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"is_correct": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Correct"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"question_id": {
"default": "",
"title": "Question Id",
"type": "string"
},
"submission_id": {
"default": "",
"maxLength": 200,
"title": "Submission Id",
"type": "string"
},
"user_answer": {
"default": "",
"title": "User Answer",
"type": "string"
}
},
"required": [
"book_id",
"page_id",
"block_id"
],
"title": "QuizAttemptRequest",
"type": "object"
},
"QuizResultItem": {
"properties": {
"correct_answer": {
"default": "",
"title": "Correct Answer",
"type": "string"
},
"difficulty": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Difficulty"
},
"explanation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Explanation"
},
"is_correct": {
"title": "Is Correct",
"type": "boolean"
},
"options": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Options"
},
"question": {
"minLength": 1,
"title": "Question",
"type": "string"
},
"question_id": {
"default": "",
"title": "Question Id",
"type": "string"
},
"question_type": {
"default": "",
"title": "Question Type",
"type": "string"
},
"user_answer": {
"default": "",
"title": "User Answer",
"type": "string"
}
},
"required": [
"question",
"is_correct"
],
"title": "QuizResultItem",
"type": "object"
},
"QuizResultsRequest": {
"properties": {
"answers": {
"items": {
"$ref": "#/components/schemas/QuizResultItem"
},
"title": "Answers",
"type": "array"
},
"turn_id": {
"default": "",
"title": "Turn Id",
"type": "string"
}
},
"title": "QuizResultsRequest",
"type": "object"
},
"ReactEditRequest": {
"properties": {
"instruction": {
"default": "",
"maxLength": 10000,
"title": "Instruction",
"type": "string"
},
"kb_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Kb Name"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__co_writer__LLMSelectionPayload"
},
{
"type": "null"
}
]
},
"mode": {
"default": "rewrite",
"enum": [
"rewrite",
"shorten",
"expand",
"none"
],
"title": "Mode",
"type": "string"
},
"selected_text": {
"maxLength": 120000,
"title": "Selected Text",
"type": "string"
},
"tools": {
"default": [],
"items": {
"enum": [
"rag",
"web"
],
"type": "string"
},
"title": "Tools",
"type": "array"
}
},
"required": [
"selected_text"
],
"title": "ReactEditRequest",
"type": "object"
},
"ReactEditResponse": {
"properties": {
"edited_text": {
"title": "Edited Text",
"type": "string"
},
"operation_id": {
"title": "Operation Id",
"type": "string"
},
"tools_used": {
"default": [],
"items": {
"type": "string"
},
"title": "Tools Used",
"type": "array"
}
},
"required": [
"edited_text",
"operation_id"
],
"title": "ReactEditResponse",
"type": "object"
},
"ReadAloudAudioPayload": {
"properties": {
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
}
},
"required": [
"locator"
],
"title": "ReadAloudAudioPayload",
"type": "object"
},
"ReadingActivityRecord": {
"description": "One successful Reading-extension action, without source content.",
"properties": {
"action": {
"title": "Action",
"type": "string"
},
"activity_id": {
"title": "Activity Id",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "number"
},
"extension_id": {
"title": "Extension Id",
"type": "string"
},
"locator": {
"minimum": 1.0,
"title": "Locator",
"type": "integer"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"result_type": {
"enum": [
"card",
"quiz",
"feedback",
"browser_speech"
],
"title": "Result Type",
"type": "string"
}
},
"required": [
"activity_id",
"material_id",
"extension_id",
"action",
"locator",
"result_type"
],
"title": "ReadingActivityRecord",
"type": "object"
},
"ReadingLearningRecords": {
"description": "Account-scoped Reading summary for reporting surfaces.",
"properties": {
"activities": {
"items": {
"$ref": "#/components/schemas/ReadingActivityRecord"
},
"title": "Activities",
"type": "array"
},
"progress": {
"items": {
"$ref": "#/components/schemas/ReadingProgressRecord"
},
"title": "Progress",
"type": "array"
}
},
"title": "ReadingLearningRecords",
"type": "object"
},
"ReadingProgressRecord": {
"description": "One material's Reading progress in an account's learning records.",
"properties": {
"furthest_locator": {
"minimum": 1.0,
"title": "Furthest Locator",
"type": "integer"
},
"furthest_percentage": {
"maximum": 1.0,
"minimum": 0.0,
"title": "Furthest Percentage",
"type": "number"
},
"latest_locator": {
"minimum": 1.0,
"title": "Latest Locator",
"type": "integer"
},
"latest_percentage": {
"maximum": 1.0,
"minimum": 0.0,
"title": "Latest Percentage",
"type": "number"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "number"
}
},
"required": [
"material_id",
"latest_locator",
"latest_percentage",
"furthest_locator",
"furthest_percentage"
],
"title": "ReadingProgressRecord",
"type": "object"
},
"ReadingReference": {
"additionalProperties": false,
"properties": {
"locators": {
"items": {
"type": "integer"
},
"title": "Locators",
"type": "array"
},
"material_id": {
"title": "Material Id",
"type": "string"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"material_id",
"revision"
],
"title": "ReadingReference",
"type": "object"
},
"ReadingSessionCreateRequest": {
"properties": {
"active_material_id": {
"default": "",
"title": "Active Material Id",
"type": "string"
},
"title": {
"default": "New reading conversation",
"maxLength": 100,
"title": "Title",
"type": "string"
}
},
"title": "ReadingSessionCreateRequest",
"type": "object"
},
"ReadingSessionLinkRequest": {
"properties": {
"target_session_id": {
"title": "Target Session Id",
"type": "string"
}
},
"required": [
"target_session_id"
],
"title": "ReadingSessionLinkRequest",
"type": "object"
},
"ReadingSessionRenameRequest": {
"properties": {
"title": {
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title"
],
"title": "ReadingSessionRenameRequest",
"type": "object"
},
"ReadingViewport": {
"additionalProperties": false,
"properties": {
"locator": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Locator"
},
"selection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Selection"
},
"time_seconds": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Time Seconds"
}
},
"title": "ReadingViewport",
"type": "object"
},
"RebuildBookRequest": {
"properties": {
"auto_compile": {
"default": true,
"title": "Auto Compile",
"type": "boolean"
},
"block_types": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Block Types"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
}
},
"required": [
"book_id"
],
"title": "RebuildBookRequest",
"type": "object"
},
"RegenerateBlockRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"params_override": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Params Override"
}
},
"required": [
"book_id",
"page_id",
"block_id"
],
"title": "RegenerateBlockRequest",
"type": "object"
},
"RegisterRequest": {
"description": "Payload for the POST /register endpoint.",
"properties": {
"password": {
"title": "Password",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
}
},
"required": [
"username",
"password"
],
"title": "RegisterRequest",
"type": "object"
},
"RegistryEditPayload": {
"properties": {
"config": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Config"
},
"delete": {
"default": false,
"title": "Delete",
"type": "boolean"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Fields"
},
"kind": {
"enum": [
"provider",
"model",
"default",
"task_choice"
],
"title": "Kind",
"type": "string"
},
"model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Model"
},
"model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
},
"profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile Id"
},
"ref": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Ref"
},
"service": {
"anyOf": [
{
"enum": [
"llm",
"task",
"embedding",
"search",
"tts",
"stt",
"imagegen",
"videogen"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Service"
},
"task": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Task"
}
},
"required": [
"kind"
],
"title": "RegistryEditPayload",
"type": "object"
},
"RenamePathRequest": {
"description": "An empty name is a valid request: it restores the derived display name.",
"properties": {
"name": {
"default": "",
"title": "Name",
"type": "string"
}
},
"title": "RenamePathRequest",
"type": "object"
},
"RenameTagRequest": {
"properties": {
"rename_to": {
"maxLength": 32,
"minLength": 1,
"title": "Rename To",
"type": "string"
}
},
"required": [
"rename_to"
],
"title": "RenameTagRequest",
"type": "object"
},
"ResolveRequest": {
"properties": {
"language": {
"default": "",
"maxLength": 32,
"title": "Language",
"type": "string"
},
"provider_override": {
"anyOf": [
{
"maxLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Override"
},
"url": {
"maxLength": 2048,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "ResolveRequest",
"type": "object"
},
"ResumeBookRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
}
},
"required": [
"book_id"
],
"title": "ResumeBookRequest",
"type": "object"
},
"ReviewCardRequest": {
"properties": {
"card_id": {
"maxLength": 200,
"minLength": 1,
"title": "Card Id",
"type": "string"
},
"remembered": {
"title": "Remembered",
"type": "boolean"
}
},
"required": [
"card_id",
"remembered"
],
"title": "ReviewCardRequest",
"type": "object"
},
"ReviewDay": {
"properties": {
"date": {
"title": "Date",
"type": "string"
},
"mastery": {
"default": 0,
"title": "Mastery",
"type": "integer"
},
"paths": {
"items": {
"$ref": "#/components/schemas/ReviewPathCount"
},
"title": "Paths",
"type": "array"
},
"practice": {
"default": 0,
"title": "Practice",
"type": "integer"
}
},
"required": [
"date"
],
"title": "ReviewDay",
"type": "object"
},
"ReviewPathCount": {
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"id": {
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"title",
"count"
],
"title": "ReviewPathCount",
"type": "object"
},
"ReviewRequest": {
"properties": {
"answer": {
"default": "",
"maxLength": 20000,
"title": "Answer",
"type": "string"
},
"rating": {
"enum": [
"again",
"hard",
"good",
"easy"
],
"title": "Rating",
"type": "string"
},
"request_id": {
"maxLength": 100,
"minLength": 16,
"pattern": "^[a-zA-Z0-9_-]+$",
"title": "Request Id",
"type": "string"
},
"self_report": {
"default": false,
"title": "Self Report",
"type": "boolean"
},
"version": {
"minimum": 0.0,
"title": "Version",
"type": "integer"
}
},
"required": [
"request_id",
"version",
"rating"
],
"title": "ReviewRequest",
"type": "object"
},
"ReviewSettingsRequest": {
"description": "A per-path recall target; higher values schedule shorter intervals.",
"properties": {
"desired_retention": {
"maximum": 0.99,
"minimum": 0.7,
"title": "Desired Retention",
"type": "number"
}
},
"required": [
"desired_retention"
],
"title": "ReviewSettingsRequest",
"type": "object"
},
"ReviewSuggestionRequest": {
"properties": {
"accept": {
"title": "Accept",
"type": "boolean"
},
"blocks": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Blocks"
}
},
"required": [
"accept"
],
"title": "ReviewSuggestionRequest",
"type": "object"
},
"RoundSummaryRequest": {
"properties": {
"partner_id": {
"maxLength": 80,
"minLength": 1,
"title": "Partner Id",
"type": "string"
},
"session_key": {
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
"required": [
"session_key",
"partner_id"
],
"title": "RoundSummaryRequest",
"type": "object"
},
"RunStartRequest": {
"properties": {
"budget": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Budget"
},
"iterations": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Iterations"
},
"key": {
"title": "Key",
"type": "string"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"layer": {
"title": "Layer",
"type": "string"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__memory__LLMSelectionPayload"
},
{
"type": "null"
}
]
},
"mode": {
"enum": [
"update",
"audit",
"dedup",
"merge"
],
"title": "Mode",
"type": "string"
}
},
"required": [
"layer",
"key",
"mode"
],
"title": "RunStartRequest",
"type": "object"
},
"RuntimeStatus": {
"additionalProperties": false,
"properties": {
"coordination_mode": {
"enum": [
"memory",
"redis"
],
"title": "Coordination Mode",
"type": "string"
},
"leader_healthy": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leader Healthy"
},
"leader_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Leader Id"
},
"lease_ttl_seconds": {
"minimum": 1,
"title": "Lease Ttl Seconds",
"type": "integer"
},
"minimum_web_protocol_version": {
"const": "2.0",
"default": "2.0",
"title": "Minimum Web Protocol Version",
"type": "string"
},
"owner_turn_count": {
"default": 0,
"minimum": 0,
"title": "Owner Turn Count",
"type": "integer"
},
"protocol_version": {
"const": "2.0",
"default": "2.0",
"title": "Protocol Version",
"type": "string"
},
"recovery_backlog": {
"default": 0,
"minimum": 0,
"title": "Recovery Backlog",
"type": "integer"
},
"recovery_interval_seconds": {
"minimum": 1,
"title": "Recovery Interval Seconds",
"type": "integer"
},
"redis_configured": {
"title": "Redis Configured",
"type": "boolean"
},
"redis_status": {
"enum": [
"ok",
"unavailable",
"not_configured"
],
"title": "Redis Status",
"type": "string"
},
"renew_interval_seconds": {
"minimum": 1,
"title": "Renew Interval Seconds",
"type": "integer"
},
"worker_count": {
"minimum": 1,
"title": "Worker Count",
"type": "integer"
},
"worker_id": {
"title": "Worker Id",
"type": "string"
}
},
"required": [
"worker_id",
"worker_count",
"coordination_mode",
"redis_configured",
"redis_status",
"lease_ttl_seconds",
"renew_interval_seconds",
"recovery_interval_seconds"
],
"title": "RuntimeStatus",
"type": "object"
},
"ServerPayload": {
"description": "A server definition plus the credential values to store beside it.",
"properties": {
"config": {
"$ref": "#/components/schemas/MCPServerConfig"
},
"secrets": {
"additionalProperties": {
"type": "string"
},
"title": "Secrets",
"type": "object"
}
},
"required": [
"config"
],
"title": "ServerPayload",
"type": "object"
},
"ServicePreviewPayload": {
"properties": {
"audio": {
"default": "",
"maxLength": 11184812,
"title": "Audio",
"type": "string"
},
"catalog": {
"additionalProperties": true,
"title": "Catalog",
"type": "object"
},
"content_type": {
"default": "",
"title": "Content Type",
"type": "string"
},
"model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
},
"text": {
"default": "",
"maxLength": 2000,
"title": "Text",
"type": "string"
}
},
"required": [
"catalog",
"profile_id"
],
"title": "ServicePreviewPayload",
"type": "object"
},
"SessionBranchBody": {
"properties": {
"new_key": {
"minLength": 1,
"title": "New Key",
"type": "string"
},
"source_key": {
"minLength": 1,
"title": "Source Key",
"type": "string"
}
},
"required": [
"source_key",
"new_key"
],
"title": "SessionBranchBody",
"type": "object"
},
"SessionDetail": {
"additionalProperties": false,
"properties": {
"active_turn": {
"anyOf": [
{
"$ref": "#/components/schemas/TurnSummary"
},
{
"type": "null"
}
],
"default": null
},
"created_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"id": {
"title": "Id",
"type": "string"
},
"messages": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Messages",
"type": "array"
},
"preferences": {
"additionalProperties": true,
"title": "Preferences",
"type": "object"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id",
"title"
],
"title": "SessionDetail",
"type": "object"
},
"SessionHandoffCompleteRequest": {
"description": "Public request that trades a JWE ticket for the normal cookie.",
"properties": {
"ticket": {
"maxLength": 8192,
"minLength": 32,
"title": "Ticket",
"type": "string"
}
},
"required": [
"ticket"
],
"title": "SessionHandoffCompleteRequest",
"type": "object"
},
"SessionHandoffCreateRequest": {
"description": "Private request that starts a one-time public handoff.",
"properties": {
"public_origin": {
"maxLength": 2048,
"minLength": 8,
"title": "Public Origin",
"type": "string"
}
},
"required": [
"public_origin"
],
"title": "SessionHandoffCreateRequest",
"type": "object"
},
"SessionHandoffExchangeRequest": {
"description": "Public request that trades a pairing code for a JWE ticket.",
"properties": {
"code": {
"maxLength": 256,
"minLength": 16,
"title": "Code",
"type": "string"
}
},
"required": [
"code"
],
"title": "SessionHandoffExchangeRequest",
"type": "object"
},
"SessionKeyBody": {
"properties": {
"session_key": {
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
"required": [
"session_key"
],
"title": "SessionKeyBody",
"type": "object"
},
"SessionOrganizationRequest": {
"description": "User-controlled organization metadata stored with the conversation.",
"properties": {
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Archived"
},
"parent_session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Session Id"
},
"pinned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Pinned"
},
"session_kind": {
"anyOf": [
{
"enum": [
"chat",
"selection_tutor",
"immersive_reading"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Kind"
},
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
"title": "SessionOrganizationRequest",
"type": "object"
},
"SessionRenameRequest": {
"properties": {
"title": {
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title"
],
"title": "SessionRenameRequest",
"type": "object"
},
"SessionReplyLanguageRequest": {
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
}
},
"required": [
"language"
],
"title": "SessionReplyLanguageRequest",
"type": "object"
},
"SessionStoreCapabilities": {
"properties": {
"submission_replacement": {
"title": "Submission Replacement",
"type": "boolean"
}
},
"required": [
"submission_replacement"
],
"title": "SessionStoreCapabilities",
"type": "object"
},
"SessionSummary": {
"additionalProperties": false,
"properties": {
"active_turn": {
"anyOf": [
{
"$ref": "#/components/schemas/TurnSummary"
},
{
"type": "null"
}
],
"default": null
},
"created_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"id": {
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id",
"title"
],
"title": "SessionSummary",
"type": "object"
},
"SessionTaskLinks": {
"properties": {
"session_id": {
"title": "Session Id",
"type": "string"
},
"status_link_enabled": {
"default": true,
"title": "Status Link Enabled",
"type": "boolean"
},
"task_ids": {
"items": {
"type": "string"
},
"title": "Task Ids",
"type": "array"
},
"workspace_id": {
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"workspace_id",
"session_id"
],
"title": "SessionTaskLinks",
"type": "object"
},
"SetRoleRequest": {
"description": "Payload for the PUT /users/{username}/role endpoint.",
"properties": {
"role": {
"title": "Role",
"type": "string"
}
},
"required": [
"role"
],
"title": "SetRoleRequest",
"type": "object"
},
"SetSessionModeRequest": {
"properties": {
"mode": {
"maxLength": 32,
"title": "Mode",
"type": "string"
}
},
"required": [
"mode"
],
"title": "SetSessionModeRequest",
"type": "object"
},
"SettingsDraftPayload": {
"description": "The unapplied settings envelope, as the settings UI holds it.",
"properties": {
"catalog": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Catalog"
},
"extensions": {
"additionalProperties": true,
"title": "Extensions",
"type": "object"
}
},
"title": "SettingsDraftPayload",
"type": "object"
},
"SettingsPresetDraftRequest": {
"description": "The current draft envelope submitted alongside a named preset.",
"properties": {
"catalog": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Catalog"
},
"extensions": {
"additionalProperties": true,
"title": "Extensions",
"type": "object"
}
},
"title": "SettingsPresetDraftRequest",
"type": "object"
},
"SettingsProfileImportPayload": {
"description": "An exported value-free settings profile submitted for review only.",
"properties": {
"profile": {
"additionalProperties": true,
"title": "Profile",
"type": "object"
},
"schema_version": {
"title": "Schema Version",
"type": "string"
}
},
"required": [
"schema_version",
"profile"
],
"title": "SettingsProfileImportPayload",
"type": "object"
},
"SidebarDescriptionUpdate": {
"properties": {
"description": {
"title": "Description",
"type": "string"
}
},
"required": [
"description"
],
"title": "SidebarDescriptionUpdate",
"type": "object"
},
"SidebarNavOrder": {
"properties": {
"learnResearch": {
"items": {
"type": "string"
},
"title": "Learnresearch",
"type": "array"
},
"start": {
"items": {
"type": "string"
},
"title": "Start",
"type": "array"
}
},
"required": [
"start",
"learnResearch"
],
"title": "SidebarNavOrder",
"type": "object"
},
"SidebarNavOrderUpdate": {
"properties": {
"nav_order": {
"$ref": "#/components/schemas/SidebarNavOrder"
}
},
"required": [
"nav_order"
],
"title": "SidebarNavOrderUpdate",
"type": "object"
},
"SkillInstallPayload": {
"properties": {
"allow_unverified": {
"default": false,
"title": "Allow Unverified",
"type": "boolean"
},
"force": {
"default": false,
"title": "Force",
"type": "boolean"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"ref": {
"title": "Ref",
"type": "string"
}
},
"required": [
"ref"
],
"title": "SkillInstallPayload",
"type": "object"
},
"SoulCreateRequest": {
"properties": {
"content": {
"title": "Content",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"content"
],
"title": "SoulCreateRequest",
"type": "object"
},
"SoulSpec": {
"description": "Where a new partner's soul comes from.",
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"source": {
"default": "default",
"enum": [
"default",
"library",
"persona",
"custom"
],
"title": "Source",
"type": "string"
}
},
"title": "SoulSpec",
"type": "object"
},
"SoulTemplateUpdateRequest": {
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"title": "SoulTemplateUpdateRequest",
"type": "object"
},
"SoulUpdateBody": {
"properties": {
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"content"
],
"title": "SoulUpdateBody",
"type": "object"
},
"StatusColors": {
"additionalProperties": false,
"properties": {
"doing": {
"default": "#a16207",
"pattern": "^#[0-9a-fA-F]{6}$",
"title": "Doing",
"type": "string"
},
"done": {
"default": "#15803d",
"pattern": "^#[0-9a-fA-F]{6}$",
"title": "Done",
"type": "string"
},
"todo": {
"default": "#2563eb",
"pattern": "^#[0-9a-fA-F]{6}$",
"title": "Todo",
"type": "string"
}
},
"title": "StatusColors",
"type": "object"
},
"SubagentMessageRequest": {
"properties": {
"chat_session_id": {
"default": "",
"title": "Chat Session Id",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
}
},
"required": [
"message"
],
"title": "SubagentMessageRequest",
"type": "object"
},
"SubagentSettingsPayload": {
"properties": {
"backends": {
"anyOf": [
{
"additionalProperties": {
"additionalProperties": true,
"type": "object"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Backends"
},
"consult_budget": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Consult Budget"
}
},
"title": "SubagentSettingsPayload",
"type": "object"
},
"SubmissionReplacementRequest": {
"properties": {
"original_submission_id": {
"maxLength": 100,
"minLength": 1,
"title": "Original Submission Id",
"type": "string"
},
"request": {
"$ref": "#/components/schemas/TurnRequest"
}
},
"required": [
"original_submission_id",
"request"
],
"title": "SubmissionReplacementRequest",
"type": "object"
},
"SubmissionReplacementResponse": {
"properties": {
"session_id": {
"title": "Session Id",
"type": "string"
},
"status": {
"const": "started",
"title": "Status",
"type": "string"
},
"submission_id": {
"title": "Submission Id",
"type": "string"
},
"turn": {
"additionalProperties": true,
"title": "Turn",
"type": "object"
}
},
"required": [
"status",
"session_id",
"submission_id",
"turn"
],
"title": "SubmissionReplacementResponse",
"type": "object"
},
"SupplementRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"topic": {
"title": "Topic",
"type": "string"
}
},
"required": [
"book_id",
"page_id",
"topic"
],
"title": "SupplementRequest",
"type": "object"
},
"SupportedFileTypesInfo": {
"description": "Upload constraints exposed to the web client.",
"properties": {
"accept": {
"title": "Accept",
"type": "string"
},
"allow_any_extension": {
"default": false,
"title": "Allow Any Extension",
"type": "boolean"
},
"extensions": {
"items": {
"type": "string"
},
"title": "Extensions",
"type": "array"
},
"max_file_size_bytes": {
"title": "Max File Size Bytes",
"type": "integer"
}
},
"required": [
"extensions",
"accept",
"max_file_size_bytes"
],
"title": "SupportedFileTypesInfo",
"type": "object"
},
"SupportedFormats": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"title": "Extensions",
"type": "array"
},
"max_bytes": {
"title": "Max Bytes",
"type": "integer"
},
"raw_view_extensions": {
"items": {
"type": "string"
},
"title": "Raw View Extensions",
"type": "array"
}
},
"required": [
"extensions",
"max_bytes",
"raw_view_extensions"
],
"title": "SupportedFormats",
"type": "object"
},
"SyncFolderResponse": {
"description": "Response model for a linked-folder sync request.",
"properties": {
"file_count": {
"title": "File Count",
"type": "integer"
},
"files": {
"items": {
"type": "string"
},
"title": "Files",
"type": "array"
},
"folder_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Folder Path"
},
"message": {
"title": "Message",
"type": "string"
},
"modified_files": {
"title": "Modified Files",
"type": "integer"
},
"new_files": {
"title": "New Files",
"type": "integer"
},
"task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Id"
}
},
"required": [
"message",
"files",
"new_files",
"modified_files",
"file_count",
"task_id"
],
"title": "SyncFolderResponse",
"type": "object"
},
"SyncObjectIn": {
"properties": {
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"content": {
"default": "",
"title": "Content",
"type": "string"
},
"created_at": {
"default": "",
"title": "Created At",
"type": "string"
},
"document_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Document Id"
},
"document_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Document Title"
},
"excerpt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Excerpt"
},
"links": {
"items": {
"type": "string"
},
"title": "Links",
"type": "array"
},
"object_id": {
"title": "Object Id",
"type": "string"
},
"object_type": {
"title": "Object Type",
"type": "string"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Page"
},
"raw": {
"additionalProperties": true,
"title": "Raw",
"type": "object"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"updated_at": {
"default": "",
"title": "Updated At",
"type": "string"
}
},
"required": [
"object_id",
"object_type"
],
"title": "SyncObjectIn",
"type": "object"
},
"SyncRequest": {
"properties": {
"cursor": {
"default": "",
"maxLength": 256,
"title": "Cursor",
"type": "string"
},
"deleted_ids": {
"items": {
"type": "string"
},
"maxItems": 2000,
"title": "Deleted Ids",
"type": "array"
},
"objects": {
"items": {
"$ref": "#/components/schemas/SyncObjectIn"
},
"maxItems": 2000,
"title": "Objects",
"type": "array"
}
},
"title": "SyncRequest",
"type": "object"
},
"SyncResponse": {
"properties": {
"deleted": {
"title": "Deleted",
"type": "integer"
},
"new_cursor": {
"title": "New Cursor",
"type": "string"
},
"stored": {
"title": "Stored",
"type": "integer"
},
"updated": {
"title": "Updated",
"type": "integer"
}
},
"required": [
"stored",
"updated",
"deleted",
"new_cursor"
],
"title": "SyncResponse",
"type": "object"
},
"TTSRequest": {
"description": "Text-to-speech request body.",
"properties": {
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Format"
},
"text": {
"minLength": 1,
"title": "Text",
"type": "string"
},
"voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voice"
}
},
"required": [
"text"
],
"title": "TTSRequest",
"type": "object"
},
"TaskBoard": {
"properties": {
"cards": {
"items": {
"$ref": "#/components/schemas/TaskCard"
},
"title": "Cards",
"type": "array"
},
"colors": {
"$ref": "#/components/schemas/StatusColors"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"session_links": {
"items": {
"$ref": "#/components/schemas/SessionTaskLinks"
},
"title": "Session Links",
"type": "array"
}
},
"required": [
"cards"
],
"title": "TaskBoard",
"type": "object"
},
"TaskCard": {
"additionalProperties": false,
"properties": {
"archived": {
"title": "Archived",
"type": "boolean"
},
"created_at": {
"title": "Created At",
"type": "string"
},
"due_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"id": {
"title": "Id",
"type": "string"
},
"note": {
"default": "",
"maxLength": 2000,
"title": "Note",
"type": "string"
},
"status": {
"enum": [
"todo",
"doing",
"done"
],
"title": "Status",
"type": "string"
},
"title": {
"maxLength": 160,
"minLength": 1,
"title": "Title",
"type": "string"
},
"updated_at": {
"title": "Updated At",
"type": "string"
},
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
"required": [
"title",
"id",
"status",
"archived",
"created_at",
"updated_at"
],
"title": "TaskCard",
"type": "object"
},
"TestResponse": {
"properties": {
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
},
"message": {
"title": "Message",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model"
},
"response_time_ms": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Response Time Ms"
},
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success",
"message"
],
"title": "TestResponse",
"type": "object"
},
"TextPositionSelectorPayload": {
"properties": {
"end": {
"exclusiveMinimum": 0.0,
"title": "End",
"type": "integer"
},
"start": {
"minimum": 0.0,
"title": "Start",
"type": "integer"
},
"type": {
"const": "TextPositionSelector",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"start",
"end"
],
"title": "TextPositionSelectorPayload",
"type": "object"
},
"TextQuoteSelectorPayload": {
"properties": {
"exact": {
"maxLength": 2000,
"minLength": 1,
"title": "Exact",
"type": "string"
},
"prefix": {
"default": "",
"maxLength": 128,
"title": "Prefix",
"type": "string"
},
"suffix": {
"default": "",
"maxLength": 128,
"title": "Suffix",
"type": "string"
},
"type": {
"const": "TextQuoteSelector",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"exact"
],
"title": "TextQuoteSelectorPayload",
"type": "object"
},
"ThemeUpdate": {
"properties": {
"theme": {
"enum": [
"light",
"dark",
"glass",
"snow"
],
"title": "Theme",
"type": "string"
}
},
"required": [
"theme"
],
"title": "ThemeUpdate",
"type": "object"
},
"TikaRemoteTest": {
"description": "Draft Tika server test. Tests the unsaved URL so the user can verify\nbefore saving.",
"properties": {
"server_url": {
"default": "http://localhost:9998",
"title": "Server Url",
"type": "string"
}
},
"title": "TikaRemoteTest",
"type": "object"
},
"TimedMediaViewport": {
"additionalProperties": false,
"properties": {
"time_seconds": {
"minimum": 0,
"title": "Time Seconds",
"type": "number"
}
},
"required": [
"time_seconds"
],
"title": "TimedMediaViewport",
"type": "object"
},
"ToolAliasPayload": {
"properties": {
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"input_format": {
"default": "",
"title": "Input Format",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"phase": {
"default": "",
"title": "Phase",
"type": "string"
},
"when_to_use": {
"default": "",
"title": "When To Use",
"type": "string"
}
},
"required": [
"name"
],
"title": "ToolAliasPayload",
"type": "object"
},
"ToolHintsPayload": {
"properties": {
"aliases": {
"default": [],
"items": {
"$ref": "#/components/schemas/ToolAliasPayload"
},
"title": "Aliases",
"type": "array"
},
"guideline": {
"default": "",
"title": "Guideline",
"type": "string"
},
"input_format": {
"default": "",
"title": "Input Format",
"type": "string"
},
"note": {
"default": "",
"title": "Note",
"type": "string"
},
"phase": {
"default": "",
"title": "Phase",
"type": "string"
},
"short_description": {
"default": "",
"title": "Short Description",
"type": "string"
},
"when_to_use": {
"default": "",
"title": "When To Use",
"type": "string"
}
},
"title": "ToolHintsPayload",
"type": "object"
},
"ToolParameterPayload": {
"properties": {
"default": {
"title": "Default"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"enum": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Enum"
},
"name": {
"title": "Name",
"type": "string"
},
"required": {
"default": true,
"title": "Required",
"type": "boolean"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "ToolParameterPayload",
"type": "object"
},
"ToolsListResponse": {
"properties": {
"enabled_optional_tools": {
"items": {
"type": "string"
},
"title": "Enabled Optional Tools",
"type": "array"
},
"tools": {
"items": {
"$ref": "#/components/schemas/BuiltinToolPayload"
},
"title": "Tools",
"type": "array"
}
},
"required": [
"tools",
"enabled_optional_tools"
],
"title": "ToolsListResponse",
"type": "object"
},
"TopicSourceKind": {
"description": "What a learner may point a mastery goal at.\n\nEverything DeepTutor already holds for them is fair game: their library\n(``BOOK``), their notes (``NOTEBOOK``), an indexed corpus or one document\ninside it (``KNOWLEDGE_BASE`` / ``FILE``), and — added with the mastery\ngoal rework — the working history that shows what they have actually been\ndoing: past conversations, their own wrong answers, drafts they are\nwriting, and study partner transcripts.",
"enum": [
"goal",
"book",
"notebook",
"knowledge_base",
"file",
"chat",
"question_bank",
"cowriter",
"partner_group"
],
"title": "TopicSourceKind",
"type": "string"
},
"TopicSourceRequest": {
"properties": {
"available": {
"default": true,
"title": "Available",
"type": "boolean"
},
"client_ref": {
"default": "",
"title": "Client Ref",
"type": "string"
},
"excerpt": {
"default": "",
"maxLength": 8000,
"title": "Excerpt",
"type": "string"
},
"id": {
"default": "",
"title": "Id",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/TopicSourceKind"
},
"label": {
"maxLength": 200,
"minLength": 1,
"title": "Label",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"title": "Metadata",
"type": "object"
},
"source_id": {
"default": "",
"title": "Source Id",
"type": "string"
}
},
"required": [
"kind",
"label"
],
"title": "TopicSourceRequest",
"type": "object"
},
"TourCompletePayload": {
"properties": {
"catalog": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Catalog"
},
"test_results": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Test Results"
}
},
"title": "TourCompletePayload",
"type": "object"
},
"TurnFailureCode": {
"enum": [
"worker_lost",
"lease_lost",
"coordination_unavailable",
"provider_error",
"internal_error",
"rejected",
"server_shutdown"
],
"title": "TurnFailureCode",
"type": "string"
},
"TurnQueryState": {
"description": "Client observation state, including server-side recovery windows.",
"enum": [
"queued",
"running",
"waiting_input",
"recovering",
"completed",
"failed",
"cancelled"
],
"title": "TurnQueryState",
"type": "string"
},
"TurnRequest": {
"additionalProperties": false,
"description": "Validated turn input; ``config`` contains capability options only.\n\nThe model keeps the historical keyword construction style. Runtime-only\nkeys nested in ``config`` are translated for one major version so older\nclients continue to work while receiving a deprecation warning.",
"properties": {
"answer_by": {
"anyOf": [
{
"pattern": "^(partner|subagent):\\S.*$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Answer By"
},
"attachments": {
"items": {
"$ref": "#/components/schemas/OutgoingAttachment"
},
"title": "Attachments",
"type": "array"
},
"auto_route": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Auto Route"
},
"book_references": {
"items": {
"$ref": "#/components/schemas/BookReference"
},
"title": "Book References",
"type": "array"
},
"capability": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "chat",
"title": "Capability"
},
"capability_once": {
"default": false,
"title": "Capability Once",
"type": "boolean"
},
"client_submission_id": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Client Submission Id"
},
"config": {
"additionalProperties": true,
"title": "Config",
"type": "object"
},
"consult_partner_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Consult Partner Id"
},
"content": {
"title": "Content",
"type": "string"
},
"followup_question_context": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Followup Question Context"
},
"history_references": {
"items": {
"type": "string"
},
"title": "History References",
"type": "array"
},
"knowledge_bases": {
"items": {
"type": "string"
},
"title": "Knowledge Bases",
"type": "array"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/LLMSelection"
},
{
"type": "null"
}
],
"default": null
},
"mastery_answer": {
"anyOf": [
{
"$ref": "#/components/schemas/MasteryCardAnswer"
},
{
"type": "null"
}
],
"default": null
},
"mastery_path_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mastery Path Id"
},
"mastery_path_lease_managed": {
"default": false,
"title": "Mastery Path Lease Managed",
"type": "boolean"
},
"mastery_session_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mastery Session Mode"
},
"mastery_skip": {
"anyOf": [
{
"$ref": "#/components/schemas/MasteryCardSkip"
},
{
"type": "null"
}
],
"default": null
},
"mcp": {
"items": {
"type": "string"
},
"title": "Mcp",
"type": "array"
},
"memory_references": {
"items": {
"enum": [
"recent",
"profile",
"scope",
"preferences",
"summary"
],
"type": "string"
},
"title": "Memory References",
"type": "array"
},
"note_document_id": {
"anyOf": [
{
"pattern": "^[0-9a-f]{8,32}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note Document Id"
},
"note_generation": {
"anyOf": [
{
"$ref": "#/components/schemas/NoteGeneration"
},
{
"type": "null"
}
],
"default": null
},
"notebook_references": {
"items": {
"$ref": "#/components/schemas/NotebookReference"
},
"title": "Notebook References",
"type": "array"
},
"parent_message_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent Message Id"
},
"partner_discussion_group_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Partner Discussion Group Id"
},
"partner_group_references": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Partner Group References",
"type": "array"
},
"persist_user_message": {
"default": true,
"title": "Persist User Message",
"type": "boolean"
},
"persona": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Persona"
},
"preserve_session_preferences": {
"default": false,
"title": "Preserve Session Preferences",
"type": "boolean"
},
"question_notebook_references": {
"items": {
"type": "integer"
},
"title": "Question Notebook References",
"type": "array"
},
"reading_material_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reading Material Id"
},
"reading_material_revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Reading Material Revision"
},
"reading_references": {
"items": {
"$ref": "#/components/schemas/ReadingReference"
},
"title": "Reading References",
"type": "array"
},
"reading_viewport": {
"anyOf": [
{
"$ref": "#/components/schemas/ReadingViewport"
},
{
"type": "null"
}
],
"default": null
},
"reading_workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reading Workspace Id"
},
"regenerate": {
"default": false,
"title": "Regenerate",
"type": "boolean"
},
"regenerated_from_message_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Regenerated From Message Id"
},
"reply_language_override": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reply Language Override"
},
"selection_tutor_context": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Selection Tutor Context"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Session Id"
},
"skills": {
"items": {
"type": "string"
},
"title": "Skills",
"type": "array"
},
"subagent_consult_budget": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Subagent Consult Budget"
},
"superseded_turn_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Superseded Turn Id"
},
"timed_media_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Timed Media Id"
},
"timed_media_viewport": {
"anyOf": [
{
"$ref": "#/components/schemas/TimedMediaViewport"
},
{
"type": "null"
}
],
"default": null
},
"tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tools"
},
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workspace Id"
},
"workspace_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workspace Mode"
}
},
"required": [
"content"
],
"title": "TurnRequest",
"type": "object"
},
"TurnStatus": {
"enum": [
"queued",
"running",
"waiting_input",
"completed",
"failed",
"cancelled"
],
"title": "TurnStatus",
"type": "string"
},
"TurnSummary": {
"additionalProperties": false,
"properties": {
"capability": {
"default": "",
"title": "Capability",
"type": "string"
},
"created_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"error": {
"default": "",
"title": "Error",
"type": "string"
},
"error_code": {
"anyOf": [
{
"$ref": "#/components/schemas/TurnFailureCode"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"title": "Id",
"type": "string"
},
"last_seq": {
"default": 0,
"minimum": 0,
"title": "Last Seq",
"type": "integer"
},
"owner_id": {
"default": "",
"title": "Owner Id",
"type": "string"
},
"query_state": {
"anyOf": [
{
"$ref": "#/components/schemas/TurnQueryState"
},
{
"type": "null"
}
],
"default": null
},
"retryable": {
"default": false,
"title": "Retryable",
"type": "boolean"
},
"session_id": {
"title": "Session Id",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TurnStatus"
},
"updated_at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id",
"session_id",
"status"
],
"title": "TurnSummary",
"type": "object"
},
"UISettingsUpdate": {
"description": "Partial UI settings for user-initiated PATCH/PUT updates via /api/settings/ui.\n\nAll fields have None defaults so `model_dump(exclude_unset=True)` naturally\nexcludes fields not provided in the frontend payload, while explicitly provided\ndefaults (e.g., `theme: \"snow\"`) still update the backend. This separates\nthe semantic contract: `/ui` endpoint only merges whatever explicitly arrives\nfrom the frontend.",
"properties": {
"code_block_show_line_numbers": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Code Block Show Line Numbers"
},
"code_block_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Block Theme"
},
"code_block_wrap_long_lines": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Code Block Wrap Long Lines"
},
"language": {
"anyOf": [
{
"enum": [
"en",
"zh",
"fr",
"de",
"uk",
"pl"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"response_language": {
"anyOf": [
{
"enum": [
"en",
"zh",
"zh-tw",
"ja",
"ko",
"es",
"fr",
"de",
"ru",
"pt",
"it",
"ar",
"pl",
"uk",
"ms"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Response Language"
},
"sidebar_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sidebar Description"
},
"sidebar_nav_order": {
"anyOf": [
{
"$ref": "#/components/schemas/SidebarNavOrder"
},
{
"type": "null"
}
]
},
"theme": {
"anyOf": [
{
"enum": [
"light",
"dark",
"glass",
"snow"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Theme"
}
},
"title": "UISettingsUpdate",
"type": "object"
},
"UnitText": {
"properties": {
"locator": {
"title": "Locator",
"type": "integer"
},
"text": {
"title": "Text",
"type": "string"
},
"unit": {
"title": "Unit",
"type": "string"
}
},
"required": [
"locator",
"unit",
"text"
],
"title": "UnitText",
"type": "object"
},
"UpdateBlockRequest": {
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"book_id": {
"title": "Book Id",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"page_id": {
"title": "Page Id",
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"required": [
"book_id",
"page_id",
"block_id"
],
"title": "UpdateBlockRequest",
"type": "object"
},
"UpdateCalendar": {
"additionalProperties": false,
"properties": {
"color": {
"anyOf": [
{
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"name": {
"anyOf": [
{
"maxLength": 80,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"position": {
"anyOf": [
{
"maximum": 100000.0,
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Position"
},
"visible": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Visible"
}
},
"title": "UpdateCalendar",
"type": "object"
},
"UpdateCard": {
"additionalProperties": false,
"properties": {
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Archived"
},
"due_date": {
"anyOf": [
{
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"note": {
"anyOf": [
{
"maxLength": 2000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"status": {
"anyOf": [
{
"enum": [
"todo",
"doing",
"done"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"title": {
"anyOf": [
{
"maxLength": 160,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"workspace_id": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
"title": "UpdateCard",
"type": "object"
},
"UpdateDocumentRequest": {
"properties": {
"blocks": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Blocks"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"cover": {
"default": "",
"maxLength": 2000,
"title": "Cover",
"type": "string"
},
"expected_revision": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
},
"icon": {
"default": "",
"maxLength": 100,
"title": "Icon",
"type": "string"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"pinned": {
"default": false,
"title": "Pinned",
"type": "boolean"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"title": "UpdateDocumentRequest",
"type": "object"
},
"UpdateNotebookRequest": {
"description": "Update notebook request",
"properties": {
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Icon"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"title": "UpdateNotebookRequest",
"type": "object"
},
"UpdatePartnerGroupRequest": {
"properties": {
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"discussion_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Discussion Mode"
},
"emoji": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Emoji"
},
"member_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Member Ids"
},
"name": {
"anyOf": [
{
"maxLength": 80,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"shared_memory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Shared Memory"
}
},
"title": "UpdatePartnerGroupRequest",
"type": "object"
},
"UpdatePartnerRequest": {
"properties": {
"avatar": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Avatar"
},
"backup_llm_selection": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Backup Llm Selection"
},
"builtin_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Builtin Tools"
},
"channels": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Channels"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"emoji": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Emoji"
},
"enabled_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Enabled Tools"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Language"
},
"llm_selection": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Llm Selection"
},
"mcp_tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Mcp Tools"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workspace Id"
}
},
"title": "UpdatePartnerRequest",
"type": "object"
},
"UpdatePersonaRequest": {
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"rename_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rename To"
}
},
"title": "UpdatePersonaRequest",
"type": "object"
},
"UpdateProfileRequest": {
"description": "Payload for the PUT /profile endpoint.",
"properties": {
"avatar": {
"title": "Avatar",
"type": "string"
}
},
"required": [
"avatar"
],
"title": "UpdateProfileRequest",
"type": "object"
},
"UpdateRecordRequest": {
"description": "Update an existing notebook record.\n\nOnly the fields the client actually sends are forwarded (see\n``exclude_unset`` at the call site), which is what keeps ``kb_name``\nfrom being wiped by a request that merely renames the record.",
"properties": {
"kb_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Kb Name"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"output": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"user_query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Query"
}
},
"title": "UpdateRecordRequest",
"type": "object"
},
"UpdateRequest": {
"properties": {
"budget": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Budget"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"llm_selection": {
"anyOf": [
{
"$ref": "#/components/schemas/deeptutor__api__routers__memory__LLMSelectionPayload"
},
{
"type": "null"
}
]
}
},
"title": "UpdateRequest",
"type": "object"
},
"UpdateSettingsRequest": {
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "UpdateSettingsRequest",
"type": "object"
},
"UpdateSkillRequest": {
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"rename_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rename To"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags"
}
},
"title": "UpdateSkillRequest",
"type": "object"
},
"UpdateVideoNoteRequest": {
"properties": {
"body": {
"maxLength": 20000,
"minLength": 1,
"title": "Body",
"type": "string"
}
},
"required": [
"body"
],
"title": "UpdateVideoNoteRequest",
"type": "object"
},
"UpdateWorkspacePayload": {
"properties": {
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Archived"
},
"instructions": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions"
},
"name": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"resources": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkspaceResources"
},
{
"type": "null"
}
]
}
},
"title": "UpdateWorkspacePayload",
"type": "object"
},
"UpsertEntryRequest": {
"properties": {
"assessment_type": {
"default": "",
"title": "Assessment Type",
"type": "string"
},
"attempt_count": {
"default": 1,
"title": "Attempt Count",
"type": "integer"
},
"confidence": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Confidence"
},
"correct_answer": {
"default": "",
"title": "Correct Answer",
"type": "string"
},
"difficulty": {
"default": "",
"title": "Difficulty",
"type": "string"
},
"explanation": {
"default": "",
"title": "Explanation",
"type": "string"
},
"hints_used": {
"default": 0,
"title": "Hints Used",
"type": "integer"
},
"is_correct": {
"default": false,
"title": "Is Correct",
"type": "boolean"
},
"knowledge_point_id": {
"default": "",
"title": "Knowledge Point Id",
"type": "string"
},
"mastery_path_id": {
"default": "",
"title": "Mastery Path Id",
"type": "string"
},
"material_id": {
"default": "",
"title": "Material Id",
"type": "string"
},
"material_title": {
"default": "",
"title": "Material Title",
"type": "string"
},
"options": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Options"
},
"origin_ref": {
"default": "",
"title": "Origin Ref",
"type": "string"
},
"origin_type": {
"default": "conversation",
"enum": [
"conversation",
"external_import",
"document_analysis"
],
"title": "Origin Type",
"type": "string"
},
"quality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quality"
},
"question": {
"title": "Question",
"type": "string"
},
"question_id": {
"title": "Question Id",
"type": "string"
},
"question_type": {
"default": "",
"title": "Question Type",
"type": "string"
},
"response_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Response Time"
},
"result": {
"default": "",
"title": "Result",
"type": "string"
},
"section_id": {
"default": "",
"title": "Section Id",
"type": "string"
},
"section_title": {
"default": "",
"title": "Section Title",
"type": "string"
},
"session_id": {
"default": "",
"title": "Session Id",
"type": "string"
},
"source": {
"default": "deep_question",
"enum": [
"deep_question",
"mastery_path",
"immersive_reading",
"book",
"partner_chat",
"import"
],
"title": "Source",
"type": "string"
},
"turn_id": {
"default": "",
"title": "Turn Id",
"type": "string"
},
"user_answer": {
"default": "",
"title": "User Answer",
"type": "string"
},
"user_answer_images": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AnswerImageUpload"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "User Answer Images"
}
},
"required": [
"question_id",
"question"
],
"title": "UpsertEntryRequest",
"type": "object"
},
"UrlImportRequest": {
"properties": {
"urls": {
"items": {
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"title": "Urls",
"type": "array"
},
"workspace_id": {
"default": "",
"title": "Workspace Id",
"type": "string"
},
"workspace_title": {
"default": "",
"title": "Workspace Title",
"type": "string"
}
},
"required": [
"urls"
],
"title": "UrlImportRequest",
"type": "object"
},
"UsageStatistics": {
"properties": {
"active_days": {
"title": "Active Days",
"type": "integer"
},
"days": {
"items": {
"$ref": "#/components/schemas/DailyUsage"
},
"title": "Days",
"type": "array"
},
"models": {
"items": {
"$ref": "#/components/schemas/ModelUsage"
},
"title": "Models",
"type": "array"
},
"sessions": {
"title": "Sessions",
"type": "integer"
},
"timezone": {
"title": "Timezone",
"type": "string"
},
"totals": {
"$ref": "#/components/schemas/UsageTotals"
},
"tracked_turns": {
"title": "Tracked Turns",
"type": "integer"
},
"turns": {
"title": "Turns",
"type": "integer"
},
"updated_at": {
"title": "Updated At",
"type": "number"
},
"year": {
"title": "Year",
"type": "integer"
}
},
"required": [
"year",
"timezone",
"totals",
"days",
"models",
"active_days",
"sessions",
"turns",
"tracked_turns",
"updated_at"
],
"title": "UsageStatistics",
"type": "object"
},
"UsageTotals": {
"properties": {
"cache_creation_input_tokens": {
"default": 0,
"title": "Cache Creation Input Tokens",
"type": "integer"
},
"cache_hit_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cache Hit Rate"
},
"cache_input_tokens": {
"default": 0,
"title": "Cache Input Tokens",
"type": "integer"
},
"cache_read_input_tokens": {
"default": 0,
"title": "Cache Read Input Tokens",
"type": "integer"
},
"cache_reported_calls": {
"default": 0,
"title": "Cache Reported Calls",
"type": "integer"
},
"completion_tokens": {
"default": 0,
"title": "Completion Tokens",
"type": "integer"
},
"duration_seconds": {
"default": 0,
"title": "Duration Seconds",
"type": "number"
},
"estimated_calls": {
"default": 0,
"title": "Estimated Calls",
"type": "integer"
},
"prompt_tokens": {
"default": 0,
"title": "Prompt Tokens",
"type": "integer"
},
"tokens_per_second": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Tokens Per Second"
},
"total_calls": {
"default": 0,
"title": "Total Calls",
"type": "integer"
},
"total_tokens": {
"default": 0,
"title": "Total Tokens",
"type": "integer"
},
"ttft_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Ttft Seconds"
}
},
"title": "UsageTotals",
"type": "object"
},
"UserInfo": {
"description": "Single user record returned by the GET /users and /profile endpoints.",
"properties": {
"avatar": {
"default": "",
"title": "Avatar",
"type": "string"
},
"created_at": {
"title": "Created At",
"type": "string"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"id": {
"default": "",
"title": "Id",
"type": "string"
},
"preset": {
"default": "standard",
"enum": [
"standard",
"learner",
"custom"
],
"title": "Preset",
"type": "string"
},
"role": {
"title": "Role",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
}
},
"required": [
"username",
"role",
"created_at"
],
"title": "UserInfo",
"type": "object"
},
"ValidationError": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"VideoLearningSettingsRequest": {
"properties": {
"default_provider": {
"default": "youtube",
"maxLength": 32,
"title": "Default Provider",
"type": "string"
},
"invidious": {
"$ref": "#/components/schemas/InvidiousSettings"
},
"version": {
"default": 1,
"title": "Version",
"type": "integer"
},
"youtube": {
"$ref": "#/components/schemas/YouTubeSettings"
}
},
"title": "VideoLearningSettingsRequest",
"type": "object"
},
"VoiceAutoplayUpdate": {
"properties": {
"voice_autoplay": {
"title": "Voice Autoplay",
"type": "boolean"
}
},
"required": [
"voice_autoplay"
],
"title": "VoiceAutoplayUpdate",
"type": "object"
},
"VoiceDiscoveryPayload": {
"properties": {
"catalog": {
"additionalProperties": true,
"title": "Catalog",
"type": "object"
},
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"catalog",
"profile_id",
"model_id"
],
"title": "VoiceDiscoveryPayload",
"type": "object"
},
"VoiceMathSpeakUpdate": {
"properties": {
"voice_math_speak": {
"title": "Voice Math Speak",
"type": "boolean"
}
},
"required": [
"voice_math_speak"
],
"title": "VoiceMathSpeakUpdate",
"type": "object"
},
"VoicePreviewPayload": {
"properties": {
"catalog": {
"additionalProperties": true,
"title": "Catalog",
"type": "object"
},
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
},
"text": {
"maxLength": 500,
"minLength": 1,
"title": "Text",
"type": "string"
}
},
"required": [
"catalog",
"profile_id",
"model_id",
"text"
],
"title": "VoicePreviewPayload",
"type": "object"
},
"WebContinuityBody": {
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"session_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Key"
}
},
"required": [
"enabled"
],
"title": "WebContinuityBody",
"type": "object"
},
"WebSourceInfo": {
"properties": {
"added_at": {
"default": "",
"title": "Added At",
"type": "string"
},
"auto_sync_enabled": {
"default": true,
"title": "Auto Sync Enabled",
"type": "boolean"
},
"bilingual_pairings": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Bilingual Pairings",
"type": "array"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"id": {
"title": "Id",
"type": "string"
},
"last_sync_error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Sync Error"
},
"last_sync_status": {
"default": "pending",
"title": "Last Sync Status",
"type": "string"
},
"last_synced_at": {
"default": "",
"title": "Last Synced At",
"type": "string"
},
"max_depth": {
"default": 3,
"title": "Max Depth",
"type": "integer"
},
"max_pages": {
"default": 200,
"title": "Max Pages",
"type": "integer"
},
"navigation": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Navigation"
},
"page_count": {
"default": 0,
"title": "Page Count",
"type": "integer"
},
"sync_interval_hours": {
"default": 24,
"maximum": 168.0,
"minimum": 1.0,
"title": "Sync Interval Hours",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"url"
],
"title": "WebSourceInfo",
"type": "object"
},
"WebSourceScheduleUpdate": {
"properties": {
"auto_sync_enabled": {
"title": "Auto Sync Enabled",
"type": "boolean"
},
"sync_interval_hours": {
"default": 24,
"maximum": 168.0,
"minimum": 1.0,
"title": "Sync Interval Hours",
"type": "integer"
}
},
"required": [
"auto_sync_enabled"
],
"title": "WebSourceScheduleUpdate",
"type": "object"
},
"WebSourceSyncJobInfo": {
"properties": {
"attempt": {
"default": 0,
"title": "Attempt",
"type": "integer"
},
"cancel_requested": {
"default": false,
"title": "Cancel Requested",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
},
"kb_name": {
"title": "Kb Name",
"type": "string"
},
"last_run_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Last Run At"
},
"next_run_at": {
"title": "Next Run At",
"type": "integer"
},
"owner_id": {
"title": "Owner Id",
"type": "string"
},
"source_id": {
"title": "Source Id",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"owner_id",
"kb_name",
"source_id",
"state",
"next_run_at"
],
"title": "WebSourceSyncJobInfo",
"type": "object"
},
"WhiteboardPinRequest": {
"properties": {
"event_id": {
"maxLength": 128,
"minLength": 1,
"title": "Event Id",
"type": "string"
}
},
"required": [
"event_id"
],
"title": "WhiteboardPinRequest",
"type": "object"
},
"WorkspaceCreateRequest": {
"properties": {
"color": {
"default": "",
"maxLength": 32,
"title": "Color",
"type": "string"
},
"description": {
"default": "",
"maxLength": 2000,
"title": "Description",
"type": "string"
},
"material_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Material Ids",
"type": "array"
},
"title": {
"default": "Untitled collection",
"maxLength": 300,
"title": "Title",
"type": "string"
}
},
"title": "WorkspaceCreateRequest",
"type": "object"
},
"WorkspaceMaterialRequest": {
"properties": {
"make_active": {
"default": false,
"title": "Make Active",
"type": "boolean"
},
"material_id": {
"title": "Material Id",
"type": "string"
}
},
"required": [
"material_id"
],
"title": "WorkspaceMaterialRequest",
"type": "object"
},
"WorkspaceMigrationPayload": {
"properties": {
"path": {
"minLength": 1,
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "WorkspaceMigrationPayload",
"type": "object"
},
"WorkspacePathPayload": {
"properties": {
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
}
},
"title": "WorkspacePathPayload",
"type": "object"
},
"WorkspaceReorderRequest": {
"properties": {
"material_ids": {
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Material Ids",
"type": "array"
}
},
"required": [
"material_ids"
],
"title": "WorkspaceReorderRequest",
"type": "object"
},
"WorkspaceResources": {
"additionalProperties": false,
"properties": {
"knowledge_bases": {
"anyOf": [
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"title": "Knowledge Bases"
},
"mcp": {
"anyOf": [
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"title": "Mcp"
},
"skills": {
"anyOf": [
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"title": "Skills"
}
},
"title": "WorkspaceResources",
"type": "object"
},
"WorkspaceUpdateRequest": {
"properties": {
"color": {
"anyOf": [
{
"maxLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"description": {
"anyOf": [
{
"maxLength": 2000,
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"title": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"title": "WorkspaceUpdateRequest",
"type": "object"
},
"YouTubeSettings": {
"properties": {
"transcript_provider": {
"default": "youtube_transcript_api",
"maxLength": 64,
"title": "Transcript Provider",
"type": "string"
}
},
"title": "YouTubeSettings",
"type": "object"
},
"ZimArticleImportRequest": {
"properties": {
"article_path": {
"maxLength": 2048,
"minLength": 1,
"title": "Article Path",
"type": "string"
},
"kb_ref": {
"maxLength": 300,
"minLength": 1,
"title": "Kb Ref",
"type": "string"
},
"title": {
"default": "",
"maxLength": 300,
"title": "Title",
"type": "string"
},
"workspace_id": {
"default": "",
"title": "Workspace Id",
"type": "string"
}
},
"required": [
"kb_ref",
"article_path"
],
"title": "ZimArticleImportRequest",
"type": "object"
},
"deeptutor__api__routers__book__ProgressRequest": {
"properties": {
"book_id": {
"title": "Book Id",
"type": "string"
},
"page_id": {
"title": "Page Id",
"type": "string"
}
},
"required": [
"book_id",
"page_id"
],
"title": "ProgressRequest",
"type": "object"
},
"deeptutor__api__routers__co_writer__LLMSelectionPayload": {
"additionalProperties": false,
"properties": {
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
},
"reasoning_effort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "LLMSelectionPayload",
"type": "object"
},
"deeptutor__api__routers__memory__LLMSelectionPayload": {
"properties": {
"model_id": {
"title": "Model Id",
"type": "string"
},
"profile_id": {
"title": "Profile Id",
"type": "string"
}
},
"required": [
"profile_id",
"model_id"
],
"title": "LLMSelectionPayload",
"type": "object"
},
"deeptutor__api__routers__video_learning__ProgressRequest": {
"properties": {
"duration_seconds": {
"default": 0,
"maximum": 86400.0,
"minimum": 0.0,
"title": "Duration Seconds",
"type": "number"
},
"time_seconds": {
"maximum": 86400.0,
"minimum": 0.0,
"title": "Time Seconds",
"type": "number"
}
},
"required": [
"time_seconds"
],
"title": "ProgressRequest",
"type": "object"
}
}
},
"info": {
"title": "DeepTutor API",
"version": "1.0.0"
},
"openapi": "3.1.0",
"paths": {
"/": {
"get": {
"operationId": "root__get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Root"
}
},
"/api/agent-config/agents": {
"get": {
"description": "Get agent UI configuration.\n\nReturns:\n Dict mapping agent type to UI metadata (icon, color, label_key)",
"operationId": "get_agent_config_api_agent_config_agents_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Agent Config",
"tags": [
"agent-config"
]
}
},
"/api/agent-config/agents/{agent_type}": {
"get": {
"description": "Get UI configuration for a specific agent.\n\nArgs:\n agent_type: Agent type (solve, question, research, etc.)\n\nReturns:\n Agent UI metadata or 404 if not found",
"operationId": "get_single_agent_config_api_agent_config_agents__agent_type__get",
"parameters": [
{
"in": "path",
"name": "agent_type",
"required": true,
"schema": {
"title": "Agent Type",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Single Agent Config",
"tags": [
"agent-config"
]
}
},
"/api/auth/avatar/{user_id}": {
"get": {
"description": "Serve a stored avatar image. Any authenticated user may view avatars\n(they appear in the admin table and next to the viewer's own profile).",
"operationId": "get_avatar_image_api_auth_avatar__user_id__get",
"parameters": [
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"title": "User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Avatar Image",
"tags": [
"auth"
]
}
},
"/api/auth/device-login": {
"post": {
"description": "Exchange a device pairing code and PIN for the account's normal cookie.",
"operationId": "device_login_api_auth_device_login_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceLoginRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Device Login Api Auth Device Login Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Device Login",
"tags": [
"auth"
]
}
},
"/api/auth/device/heartbeat": {
"post": {
"description": "Refresh a device lease and account bounded daily usage.",
"operationId": "device_heartbeat_api_auth_device_heartbeat_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Device Heartbeat Api Auth Device Heartbeat Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Device Heartbeat",
"tags": [
"auth"
]
}
},
"/api/auth/devices": {
"get": {
"description": "List local device credential metadata without credential secrets.",
"operationId": "list_devices_api_auth_devices_get",
"parameters": [
{
"in": "query",
"name": "user_id",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Id"
}
},
{
"in": "query",
"name": "include_revoked",
"required": false,
"schema": {
"default": false,
"title": "Include Revoked",
"type": "boolean"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Devices Api Auth Devices Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Devices",
"tags": [
"auth"
]
},
"post": {
"description": "Issue a revocable device credential for an ordinary local account.",
"operationId": "issue_device_api_auth_devices_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceCredentialCreateRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Issue Device Api Auth Devices Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Issue Device",
"tags": [
"auth"
]
}
},
"/api/auth/devices/{device_credential_id}": {
"delete": {
"operationId": "revoke_device_api_auth_devices__device_credential_id__delete",
"parameters": [
{
"in": "path",
"name": "device_credential_id",
"required": true,
"schema": {
"title": "Device Credential Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Revoke Device Api Auth Devices Device Credential Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke Device",
"tags": [
"auth"
]
}
},
"/api/auth/is_first_user": {
"get": {
"description": "Return whether the user store is empty (used by the register UI).",
"operationId": "check_is_first_user_api_auth_is_first_user_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Check Is First User Api Auth Is First User Get",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Check Is First User",
"tags": [
"auth"
]
}
},
"/api/auth/login": {
"post": {
"description": "Validate credentials and set a JWT cookie.",
"operationId": "login_api_auth_login_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Login Api Auth Login Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Login",
"tags": [
"auth"
]
}
},
"/api/auth/logout": {
"post": {
"description": "Clear the JWT cookie.\n\nDeletion attributes mirror ``login`` structurally via ``_cookie_attrs()``\n(see the rationale there and #623).",
"operationId": "logout_api_auth_logout_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Logout Api Auth Logout Post",
"type": "object"
}
}
},
"description": "Successful Response"
}
},
"summary": "Logout",
"tags": [
"auth"
]
}
},
"/api/auth/openai-codex/callback": {
"get": {
"operationId": "receive_codex_oauth_callback_api_auth_openai_codex_callback_get",
"parameters": [
{
"in": "query",
"name": "code",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code"
}
},
{
"in": "query",
"name": "state",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
}
},
{
"in": "query",
"name": "error",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Receive Codex Oauth Callback",
"tags": [
"auth"
]
}
},
"/api/auth/profile": {
"get": {
"description": "Return the current user's own account info.",
"operationId": "get_profile_api_auth_profile_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Profile",
"tags": [
"auth"
]
},
"put": {
"description": "Update the current user's own avatar marker (icon choice or reset).\n\nOnly the validated ``icon:<name>:<color>`` form (or empty string) is\naccepted here; ``img:`` markers are owned by the upload endpoint.",
"operationId": "update_profile_api_auth_profile_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProfileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Update Profile Api Auth Profile Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Profile",
"tags": [
"auth"
]
}
},
"/api/auth/profile/avatar": {
"delete": {
"description": "Remove the current user's uploaded avatar image and reset the marker.",
"operationId": "remove_avatar_api_auth_profile_avatar_delete",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Remove Avatar Api Auth Profile Avatar Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove Avatar",
"tags": [
"auth"
]
},
"put": {
"description": "Upload an avatar image for the current user.\n\nThe client is expected to crop/resize before uploading; the server only\nenforces a size cap and validates the format by magic bytes. Not available\nin PocketBase mode (those identities have no local user record).",
"operationId": "upload_avatar_api_auth_profile_avatar_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_avatar_api_auth_profile_avatar_put"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Upload Avatar Api Auth Profile Avatar Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Upload Avatar",
"tags": [
"auth"
]
}
},
"/api/auth/profile/learner-profile": {
"get": {
"description": "Return the authenticated learner's own profile.",
"operationId": "get_current_learner_profile_api_auth_profile_learner_profile_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Current Learner Profile Api Auth Profile Learner Profile Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Current Learner Profile",
"tags": [
"auth"
]
},
"put": {
"description": "Update only the authenticated learner's own profile.",
"operationId": "put_current_learner_profile_api_auth_profile_learner_profile_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LearnerProfileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put Current Learner Profile Api Auth Profile Learner Profile Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Current Learner Profile",
"tags": [
"auth"
]
}
},
"/api/auth/register": {
"post": {
"description": "Bootstrap-only registration.\n\nPublic endpoint that creates the *first* admin account when the user store\nis empty. Once an admin exists, this endpoint is closed; further accounts\nmust be created by an admin via ``POST /api/auth/users``.\n\nOnly available when AUTH_ENABLED=true.",
"operationId": "register_api_auth_register_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Register Api Auth Register Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Register",
"tags": [
"auth"
]
}
},
"/api/auth/session-handoff": {
"post": {
"description": "Create a host-bound, one-time pairing code from the private origin.",
"operationId": "create_session_handoff_api_auth_session_handoff_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionHandoffCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Create Session Handoff Api Auth Session Handoff Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Session Handoff",
"tags": [
"auth"
]
}
},
"/api/auth/session-handoff/complete": {
"post": {
"description": "Consume a ticket once and issue the normal HttpOnly session cookie.",
"operationId": "complete_session_handoff_api_auth_session_handoff_complete_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionHandoffCompleteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Complete Session Handoff Api Auth Session Handoff Complete Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Complete Session Handoff",
"tags": [
"auth"
]
}
},
"/api/auth/session-handoff/exchange": {
"post": {
"description": "Consume a pairing code and return a short-lived ticket in the response body.",
"operationId": "exchange_session_handoff_api_auth_session_handoff_exchange_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionHandoffExchangeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Exchange Session Handoff Api Auth Session Handoff Exchange Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Exchange Session Handoff",
"tags": [
"auth"
]
}
},
"/api/auth/status": {
"get": {
"description": "Return whether auth is enabled and whether the current request is authenticated.",
"operationId": "auth_status_api_auth_status_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Auth Status",
"tags": [
"auth"
]
}
},
"/api/auth/users": {
"get": {
"description": "List all registered users. Requires admin role.",
"operationId": "get_users_api_auth_users_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/UserInfo"
},
"title": "Response Get Users Api Auth Users Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Users",
"tags": [
"auth"
]
},
"post": {
"description": "Admin-only: create one ordinary user account.",
"operationId": "admin_create_user_api_auth_users_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminCreateUserRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Admin Create User Api Auth Users Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Admin Create User",
"tags": [
"auth"
]
}
},
"/api/auth/users/batch-delete": {
"post": {
"description": "Delete selected users and report each outcome separately.",
"operationId": "batch_remove_users_api_auth_users_batch_delete_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminBatchDeleteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Batch Remove Users Api Auth Users Batch Delete Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Batch Remove Users",
"tags": [
"auth"
]
}
},
"/api/auth/users/import": {
"post": {
"description": "Admin-only: provision ordinary users from a CSV file.\n\nThe response is row-oriented so one invalid record does not erase the\ncontext of the valid records around it. Passwords are never returned.",
"operationId": "admin_import_users_api_auth_users_import_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_admin_import_users_api_auth_users_import_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Admin Import Users Api Auth Users Import Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Admin Import Users",
"tags": [
"auth"
]
}
},
"/api/auth/users/{username}": {
"delete": {
"description": "Delete a user. Admins cannot delete their own account.",
"operationId": "remove_user_api_auth_users__username__delete",
"parameters": [
{
"in": "path",
"name": "username",
"required": true,
"schema": {
"title": "Username",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Remove User Api Auth Users Username Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove User",
"tags": [
"auth"
]
}
},
"/api/auth/users/{username}/learner-profile": {
"get": {
"description": "Return the structured profile managed for an ordinary learner.",
"operationId": "get_learner_profile_api_auth_users__username__learner_profile_get",
"parameters": [
{
"in": "path",
"name": "username",
"required": true,
"schema": {
"title": "Username",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Learner Profile Api Auth Users Username Learner Profile Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Learner Profile",
"tags": [
"auth"
]
},
"put": {
"operationId": "put_learner_profile_api_auth_users__username__learner_profile_put",
"parameters": [
{
"in": "path",
"name": "username",
"required": true,
"schema": {
"title": "Username",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LearnerProfileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put Learner Profile Api Auth Users Username Learner Profile Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Learner Profile",
"tags": [
"auth"
]
}
},
"/api/auth/users/{username}/role": {
"put": {
"description": "Change a user's role. Admins cannot change their own role.",
"operationId": "update_user_role_api_auth_users__username__role_put",
"parameters": [
{
"in": "path",
"name": "username",
"required": true,
"schema": {
"title": "Username",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Update User Role Api Auth Users Username Role Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update User Role",
"tags": [
"auth"
]
}
},
"/api/books": {
"get": {
"operationId": "list_books_api_books_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Books Api Books Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Books",
"tags": [
"books"
]
},
"post": {
"description": "Stage 1: capture inputs + run IdeationAgent.",
"operationId": "create_book_api_books_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Create Book Api Books Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Book",
"tags": [
"books"
]
}
},
"/api/books/block-types": {
"get": {
"operationId": "block_types_api_books_block_types_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"items": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": "object"
},
"type": "array"
},
"title": "Response Block Types Api Books Block Types Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Block Types",
"tags": [
"books"
]
}
},
"/api/books/change-block-type": {
"post": {
"operationId": "change_block_type_api_books_change_block_type_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeBlockTypeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Change Block Type Api Books Change Block Type Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Change Block Type",
"tags": [
"books"
]
}
},
"/api/books/compile-page": {
"post": {
"description": "Drive the compiler for the page the user just opened (current-page priority).",
"operationId": "compile_page_api_books_compile_page_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompilePageRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Compile Page Api Books Compile Page Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Compile Page",
"tags": [
"books"
]
}
},
"/api/books/confirm-proposal": {
"post": {
"description": "Stage 2: user confirms (and possibly edits) the proposal → SpineAgent.",
"operationId": "confirm_proposal_api_books_confirm_proposal_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfirmProposalRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Confirm Proposal Api Books Confirm Proposal Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Confirm Proposal",
"tags": [
"books"
]
}
},
"/api/books/confirm-spine": {
"post": {
"description": "Stage 3: user confirms the spine → create pending page shells.",
"operationId": "confirm_spine_api_books_confirm_spine_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfirmSpineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Confirm Spine Api Books Confirm Spine Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Confirm Spine",
"tags": [
"books"
]
}
},
"/api/books/deep-dive": {
"post": {
"operationId": "deep_dive_api_books_deep_dive_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeepDiveRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Deep Dive Api Books Deep Dive Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Deep Dive",
"tags": [
"books"
]
}
},
"/api/books/delete-block": {
"post": {
"operationId": "delete_block_api_books_delete_block_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBlockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Delete Block Api Books Delete Block Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Block",
"tags": [
"books"
]
}
},
"/api/books/estimate-basis": {
"get": {
"description": "Per-chapter generation cost, keyed by content type.\n\nThe spine editor sums this over whatever chapters currently exist, so the\nestimate stays live while the user edits without a request per keystroke —\nand stays honest, because the numbers come from the same templates the\narchitect plans from.",
"operationId": "estimate_basis_api_books_estimate_basis_get",
"parameters": [
{
"in": "query",
"name": "depth",
"required": false,
"schema": {
"default": "standard",
"title": "Depth",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Estimate Basis Api Books Estimate Basis Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Estimate Basis",
"tags": [
"books"
]
}
},
"/api/books/health": {
"get": {
"operationId": "health_check_api_books_health_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "string"
},
"title": "Response Health Check Api Books Health Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Health Check",
"tags": [
"books"
]
}
},
"/api/books/insert-block": {
"post": {
"operationId": "insert_block_api_books_insert_block_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsertBlockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Insert Block Api Books Insert Block Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Insert Block",
"tags": [
"books"
]
}
},
"/api/books/move-block": {
"post": {
"operationId": "move_block_api_books_move_block_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveBlockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Move Block Api Books Move Block Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Move Block",
"tags": [
"books"
]
}
},
"/api/books/page-chat-session": {
"post": {
"operationId": "set_page_chat_session_api_books_page_chat_session_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageChatSessionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Set Page Chat Session Api Books Page Chat Session Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Page Chat Session",
"tags": [
"books"
]
}
},
"/api/books/pause": {
"post": {
"description": "Persist a manual pause, cancel in-flight work, and keep completed output.",
"operationId": "pause_book_api_books_pause_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PauseBookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Pause Book Api Books Pause Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Pause Book",
"tags": [
"books"
]
}
},
"/api/books/progress/bookmark": {
"post": {
"operationId": "toggle_bookmark_api_books_progress_bookmark_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/deeptutor__api__routers__book__ProgressRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Toggle Bookmark Api Books Progress Bookmark Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Toggle Bookmark",
"tags": [
"books"
]
}
},
"/api/books/progress/visit": {
"post": {
"description": "Remember the reader's position so the book can be resumed later.",
"operationId": "mark_visited_api_books_progress_visit_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/deeptutor__api__routers__book__ProgressRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Mark Visited Api Books Progress Visit Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Mark Visited",
"tags": [
"books"
]
}
},
"/api/books/quiz-attempt": {
"post": {
"operationId": "quiz_attempt_api_books_quiz_attempt_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuizAttemptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Quiz Attempt Api Books Quiz Attempt Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Quiz Attempt",
"tags": [
"books"
]
}
},
"/api/books/rebuild": {
"post": {
"operationId": "rebuild_book_api_books_rebuild_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RebuildBookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Rebuild Book Api Books Rebuild Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Rebuild Book",
"tags": [
"books"
]
}
},
"/api/books/regenerate-block": {
"post": {
"operationId": "regenerate_block_api_books_regenerate_block_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegenerateBlockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Regenerate Block Api Books Regenerate Block Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Regenerate Block",
"tags": [
"books"
]
}
},
"/api/books/resume": {
"post": {
"description": "Re-queue unfinished pages without discarding what already compiled.",
"operationId": "resume_book_api_books_resume_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResumeBookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Resume Book Api Books Resume Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Resume Book",
"tags": [
"books"
]
}
},
"/api/books/supplement": {
"post": {
"operationId": "supplement_api_books_supplement_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplementRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Supplement Api Books Supplement Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Supplement",
"tags": [
"books"
]
}
},
"/api/books/update-block": {
"post": {
"description": "Edit a block's prose in place.\n\nScoped deliberately narrow — title and body only. Fixing a typo shouldn't\nrequire regenerating a whole block and hoping for a better roll, but a book\nis not a document editor either; substantial rewrites belong in Co-Writer.",
"operationId": "update_block_api_books_update_block_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBlockRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Update Block Api Books Update Block Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Block",
"tags": [
"books"
]
}
},
"/api/books/{book_id}": {
"delete": {
"operationId": "delete_book_api_books__book_id__delete",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Delete Book Api Books Book Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Book",
"tags": [
"books"
]
},
"get": {
"operationId": "get_book_api_books__book_id__get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "query",
"name": "include_blocks",
"required": false,
"schema": {
"default": true,
"title": "Include Blocks",
"type": "boolean"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Book Api Books Book Id Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Book",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/export": {
"get": {
"description": "Download the whole book as a single Markdown file.",
"operationId": "export_book_api_books__book_id__export_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Book",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/health": {
"get": {
"operationId": "book_health_api_books__book_id__health_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Book Health Api Books Book Id Health Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Book Health",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/learning-captures": {
"get": {
"operationId": "list_learning_captures_api_books__book_id__learning_captures_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Learning Captures Api Books Book Id Learning Captures Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Learning Captures",
"tags": [
"books"
]
},
"post": {
"operationId": "create_learning_capture_api_books__book_id__learning_captures_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LearningCaptureCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Create Learning Capture Api Books Book Id Learning Captures Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Learning Capture",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/learning-captures/{capture_id}": {
"patch": {
"operationId": "update_learning_capture_api_books__book_id__learning_captures__capture_id__patch",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "path",
"name": "capture_id",
"required": true,
"schema": {
"title": "Capture Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LearningCaptureUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Update Learning Capture Api Books Book Id Learning Captures Capture Id Patch",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Learning Capture",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/pages/{page_id}": {
"get": {
"operationId": "get_page_api_books__book_id__pages__page_id__get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Page Api Books Book Id Pages Page Id Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Page",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/refresh-fingerprints": {
"post": {
"description": "Mark the current KB state as seen.\n\n409s while pages the last drift flagged are still awaiting recompilation.\n``force=true`` dismisses them anyway — stale detection over-marks on\npurpose when an anchor cannot be resolved, so the user needs a way out.",
"operationId": "refresh_fingerprints_api_books__book_id__refresh_fingerprints_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "query",
"name": "force",
"required": false,
"schema": {
"default": false,
"title": "Force",
"type": "boolean"
}
},
{
"in": "query",
"name": "expected_revision",
"required": false,
"schema": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expected Revision"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Refresh Fingerprints Api Books Book Id Refresh Fingerprints Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Refresh Fingerprints",
"tags": [
"books"
]
}
},
"/api/books/{book_id}/spine": {
"get": {
"operationId": "get_spine_api_books__book_id__spine_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Spine Api Books Book Id Spine Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Spine",
"tags": [
"books"
]
}
},
"/api/calendar/automations/{job_id}": {
"delete": {
"operationId": "cancel_automation_api_calendar_automations__job_id__delete",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarOk"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Automation",
"tags": [
"calendar"
]
}
},
"/api/calendar/calendars": {
"get": {
"operationId": "calendars_api_calendar_calendars_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarList"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Calendars",
"tags": [
"calendar"
]
},
"post": {
"operationId": "create_calendar_api_calendar_calendars_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCalendar"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Calendar",
"tags": [
"calendar"
]
}
},
"/api/calendar/calendars/{id}": {
"delete": {
"operationId": "delete_calendar_api_calendar_calendars__id__delete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"title": "Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarRevision"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Calendar",
"tags": [
"calendar"
]
},
"patch": {
"operationId": "update_calendar_api_calendar_calendars__id__patch",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"title": "Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCalendar"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Calendar",
"tags": [
"calendar"
]
}
},
"/api/calendar/events": {
"get": {
"operationId": "events_api_calendar_events_get",
"parameters": [
{
"in": "query",
"name": "start",
"required": true,
"schema": {
"title": "Start",
"type": "string"
}
},
{
"in": "query",
"name": "end",
"required": true,
"schema": {
"title": "End",
"type": "string"
}
},
{
"in": "query",
"name": "tz",
"required": false,
"schema": {
"default": "UTC",
"title": "Tz",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OccurrenceList"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Events",
"tags": [
"calendar"
]
},
"post": {
"operationId": "create_event_api_calendar_events_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventInput"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarEventResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Event",
"tags": [
"calendar"
]
}
},
"/api/calendar/events/{id}": {
"delete": {
"operationId": "delete_event_api_calendar_events__id__delete",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"title": "Id",
"type": "string"
}
},
{
"in": "query",
"name": "scope",
"required": false,
"schema": {
"default": "all",
"enum": [
"this",
"following",
"all"
],
"title": "Scope",
"type": "string"
}
},
{
"in": "query",
"name": "occurrence",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Occurrence"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Event",
"tags": [
"calendar"
]
},
"patch": {
"operationId": "update_event_api_calendar_events__id__patch",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"title": "Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPatchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarRevision"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Event",
"tags": [
"calendar"
]
}
},
"/api/calendar/layers": {
"get": {
"operationId": "layers_api_calendar_layers_get",
"parameters": [
{
"in": "query",
"name": "start",
"required": true,
"schema": {
"title": "Start",
"type": "string"
}
},
{
"in": "query",
"name": "end",
"required": true,
"schema": {
"title": "End",
"type": "string"
}
},
{
"in": "query",
"name": "tz",
"required": false,
"schema": {
"default": "UTC",
"title": "Tz",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarLayers"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Layers",
"tags": [
"calendar"
]
}
},
"/api/calendar/search": {
"get": {
"operationId": "search_api_calendar_search_get",
"parameters": [
{
"in": "query",
"name": "q",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"title": "Q",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarSearchResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Search",
"tags": [
"calendar"
]
}
},
"/api/calendar/stream": {
"get": {
"operationId": "stream_api_calendar_stream_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stream",
"tags": [
"calendar"
]
}
},
"/api/calendar/task-blocks": {
"get": {
"operationId": "task_blocks_api_calendar_task_blocks_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "integer"
},
"title": "Response Task Blocks Api Calendar Task Blocks Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Task Blocks",
"tags": [
"calendar"
]
}
},
"/api/calendar/undo/{token}": {
"post": {
"operationId": "undo_api_calendar_undo__token__post",
"parameters": [
{
"in": "path",
"name": "token",
"required": true,
"schema": {
"title": "Token",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarRevision"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Undo",
"tags": [
"calendar"
]
}
},
"/api/capabilities/registered": {
"get": {
"description": "Describe every turn capability the deployment can execute.",
"operationId": "list_registered_capabilities_api_capabilities_registered_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"title": "Response List Registered Capabilities Api Capabilities Registered Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Registered Capabilities",
"tags": [
"capabilities"
]
}
},
"/api/capabilities/settings": {
"get": {
"operationId": "get_capabilities_settings_endpoint_api_capabilities_settings_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Capabilities Settings Endpoint Api Capabilities Settings Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Capabilities Settings Endpoint",
"tags": [
"capabilities"
]
},
"put": {
"operationId": "put_capabilities_settings_api_capabilities_settings_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Payload",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put Capabilities Settings Api Capabilities Settings Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Capabilities Settings",
"tags": [
"capabilities"
]
}
},
"/api/dashboard/learning-index": {
"get": {
"description": "Read-only entry points into the request's workspace.",
"operationId": "get_learning_index_api_dashboard_learning_index_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Learning Index",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/learning-library/{kind}": {
"get": {
"description": "The request's workspace library of one kind.",
"operationId": "get_learning_library_api_dashboard_learning_library__kind__get",
"parameters": [
{
"in": "path",
"name": "kind",
"required": true,
"schema": {
"title": "Kind",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Learning Library",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/recent": {
"get": {
"operationId": "get_recent_activities_api_dashboard_recent_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "type",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Recent Activities",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/source-library/{kind}": {
"get": {
"description": "Source indexes of the request's workspace, for the topic and book pickers.",
"operationId": "get_source_library_api_dashboard_source_library__kind__get",
"parameters": [
{
"in": "path",
"name": "kind",
"required": true,
"schema": {
"title": "Kind",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Source Library",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/suggestions": {
"get": {
"description": "The three starting points for the home composer.\n\nReturns immediately, even when the set is stale — regeneration happens\nbehind the response. An empty ``suggestions`` list means there is nothing\nin memory to ground a suggestion in, and the client renders nothing.\n\nNo language parameter: the output language is the learner's own\nmodel-output setting, resolved server-side. See\n:mod:`deeptutor.services.suggestions`.",
"operationId": "get_starter_suggestions_api_dashboard_suggestions_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Starter Suggestions",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/suggestions/refresh": {
"post": {
"description": "Generate a new set now. Backs the reroll control.\n\nSynchronous, unlike the read: a human clicked and is waiting for a\ndifferent set.",
"operationId": "refresh_starter_suggestions_api_dashboard_suggestions_refresh_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Refresh Starter Suggestions",
"tags": [
"dashboard"
]
}
},
"/api/dashboard/{entry_id}": {
"get": {
"operationId": "get_activity_entry_api_dashboard__entry_id__get",
"parameters": [
{
"in": "path",
"name": "entry_id",
"required": true,
"schema": {
"title": "Entry Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Activity Entry",
"tags": [
"dashboard"
]
}
},
"/api/documents": {
"get": {
"description": "List all Co-Writer documents (summary view, sorted by recency).",
"operationId": "list_documents_api_documents_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"items": {
"$ref": "#/components/schemas/DocumentSummaryResponse"
},
"type": "array"
},
"title": "Response List Documents Api Documents Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Documents",
"tags": [
"documents"
]
},
"post": {
"description": "Create a new Co-Writer document.",
"operationId": "create_document_api_documents_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Document",
"tags": [
"documents"
]
}
},
"/api/documents/actions/automark": {
"post": {
"description": "AI auto-mark text",
"operationId": "auto_mark_text_api_documents_actions_automark_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoMarkRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoMarkResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Auto Mark Text",
"tags": [
"documents"
]
}
},
"/api/documents/actions/edit": {
"post": {
"operationId": "edit_text_api_documents_actions_edit_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Edit Text",
"tags": [
"documents"
]
}
},
"/api/documents/actions/edit-react": {
"post": {
"operationId": "edit_text_react_api_documents_actions_edit_react_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactEditRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactEditResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Edit Text React",
"tags": [
"documents"
]
}
},
"/api/documents/actions/edit-react/stream": {
"post": {
"operationId": "edit_text_react_stream_api_documents_actions_edit_react_stream_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactEditRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Edit Text React Stream",
"tags": [
"documents"
]
}
},
"/api/documents/export/docx": {
"post": {
"operationId": "export_docx_api_documents_export_docx_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportDocxRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Docx",
"tags": [
"documents"
]
}
},
"/api/documents/history": {
"get": {
"description": "Get all operation history",
"operationId": "get_history_api_documents_history_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get History",
"tags": [
"documents"
]
}
},
"/api/documents/history/{operation_id}": {
"get": {
"description": "Get single operation details",
"operationId": "get_operation_api_documents_history__operation_id__get",
"parameters": [
{
"in": "path",
"name": "operation_id",
"required": true,
"schema": {
"title": "Operation Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Operation",
"tags": [
"documents"
]
}
},
"/api/documents/import/docx": {
"post": {
"operationId": "import_docx_api_documents_import_docx_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_import_docx_api_documents_import_docx_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import Docx",
"tags": [
"documents"
]
}
},
"/api/documents/review/due": {
"get": {
"operationId": "due_note_cards_api_documents_review_due_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Due Note Cards",
"tags": [
"documents"
]
}
},
"/api/documents/tool-calls/{operation_id}": {
"get": {
"description": "Get tool call details",
"operationId": "get_tool_call_api_documents_tool_calls__operation_id__get",
"parameters": [
{
"in": "path",
"name": "operation_id",
"required": true,
"schema": {
"title": "Operation Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Tool Call",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}": {
"delete": {
"description": "Delete a Co-Writer document.",
"operationId": "delete_document_api_documents__doc_id__delete",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "boolean"
},
"title": "Response Delete Document Api Documents Doc Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Document",
"tags": [
"documents"
]
},
"get": {
"description": "Get a single Co-Writer document by id.",
"operationId": "get_document_api_documents__doc_id__get",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Document",
"tags": [
"documents"
]
},
"put": {
"description": "Update a Co-Writer document (title and/or content).",
"operationId": "update_document_api_documents__doc_id__put",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Document",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/assets": {
"post": {
"operationId": "upload_note_asset_api_documents__doc_id__assets_post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_note_asset_api_documents__doc_id__assets_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Upload Note Asset",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/assets/{name}": {
"get": {
"operationId": "read_note_asset_api_documents__doc_id__assets__name__get",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "path",
"name": "name",
"required": true,
"schema": {
"title": "Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Read Note Asset",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/backlinks": {
"get": {
"operationId": "note_backlinks_api_documents__doc_id__backlinks_get",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Note Backlinks",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/clips": {
"post": {
"operationId": "append_note_clip_api_documents__doc_id__clips_post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClipRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Append Note Clip",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/review": {
"post": {
"operationId": "grade_note_card_api_documents__doc_id__review_post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Grade Note Card",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/suggestions": {
"get": {
"operationId": "note_suggestions_api_documents__doc_id__suggestions_get",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Note Suggestions",
"tags": [
"documents"
]
},
"post": {
"operationId": "create_note_suggestion_api_documents__doc_id__suggestions_post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSuggestionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Note Suggestion",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/suggestions/{suggestion_id}": {
"post": {
"operationId": "review_note_suggestion_api_documents__doc_id__suggestions__suggestion_id__post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "path",
"name": "suggestion_id",
"required": true,
"schema": {
"title": "Suggestion Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewSuggestionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Review Note Suggestion",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/threads": {
"get": {
"description": "The page's conversations, each with its anchor and its session's state.",
"operationId": "note_threads_api_documents__doc_id__threads_get",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Note Threads",
"tags": [
"documents"
]
},
"post": {
"operationId": "anchor_note_thread_api_documents__doc_id__threads_post",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnchorThreadRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Anchor Note Thread",
"tags": [
"documents"
]
}
},
"/api/documents/{doc_id}/threads/{session_id}": {
"delete": {
"description": "Delete a page conversation: the session goes to the recycle bin with it.",
"operationId": "delete_note_thread_api_documents__doc_id__threads__session_id__delete",
"parameters": [
{
"in": "path",
"name": "doc_id",
"required": true,
"schema": {
"title": "Doc Id",
"type": "string"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"schema": {
"title": "Session Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Note Thread",
"tags": [
"documents"
]
}
},
"/api/file-preview/pdf": {
"get": {
"description": "Render a file URL that this same authenticated user could open.",
"operationId": "preview_office_source_api_file_preview_pdf_get",
"parameters": [
{
"in": "query",
"name": "source",
"required": true,
"schema": {
"title": "Source",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Office Source",
"tags": [
"file-preview"
]
},
"post": {
"description": "Render a bounded pending Blob/data attachment that has no file URL.",
"operationId": "preview_office_upload_api_file_preview_pdf_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_preview_office_upload_api_file_preview_pdf_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Preview Office Upload",
"tags": [
"file-preview"
]
}
},
"/api/imports/chat-history": {
"get": {
"operationId": "list_imported_chat_history_api_imports_chat_history_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Imported Chat History Api Imports Chat History Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Imported Chat History",
"tags": [
"imports"
]
},
"post": {
"operationId": "import_chat_history_api_imports_chat_history_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatHistoryImportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Import Chat History Api Imports Chat History Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import Chat History",
"tags": [
"imports"
]
}
},
"/api/knowledge-bases": {
"get": {
"description": "Disk probes must not block the async worker or its other requests (#1711).",
"operationId": "list_knowledge_bases_api_knowledge_bases_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/KnowledgeBaseInfo"
},
"title": "Response List Knowledge Bases Api Knowledge Bases Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Knowledge Bases",
"tags": [
"knowledge-bases"
]
},
"post": {
"operationId": "create_knowledge_base_api_knowledge_bases_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_knowledge_base_api_knowledge_bases_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Knowledge Base",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/configs": {
"get": {
"description": "Get all knowledge base configurations from centralized config file.",
"operationId": "get_all_kb_configs_api_knowledge_bases_configs_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get All Kb Configs",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/configs/sync": {
"post": {
"description": "Sync all KB configurations from their metadata.json files to centralized config.",
"operationId": "sync_configs_from_metadata_api_knowledge_bases_configs_sync_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sync Configs From Metadata",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-folder": {
"post": {
"description": "Mount an existing engine index as a read-only ``linked`` knowledge base.\n\nRe-probes server-side (never trusts the client's verdict), then registers a\npointer to the folder. Retrieval reads the index in place — no copy, no\nre-index. Embedding-mismatch warnings do not block the link (the user may\nswitch embedding models later); a missing/invalid index does.",
"operationId": "connect_linked_folder_route_api_knowledge_bases_connect_folder_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectFolderRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Linked Folder Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-ima": {
"post": {
"description": "Connect a Tencent IMA knowledge base as a retrieval-only knowledge base.\n\nRe-probes server-side (never trusts the client's verdict), then registers a\npointer (``type: ima``). Retrieval is offloaded to IMA's ``search_knowledge``\nOpenAPI — no copy, no local index.\n\nCredentials the request omits come from the account-level settings and are\n*not* copied onto the KB, so rotating them there keeps this KB working.",
"operationId": "connect_ima_route_api_knowledge_bases_connect_ima_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectImaRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Ima Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-kiwix": {
"post": {
"description": "Bind a KB to a kiwix-serve archive; no ingest or index is created.",
"operationId": "connect_kiwix_route_api_knowledge_bases_connect_kiwix_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectKiwixRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Connect Kiwix Route Api Knowledge Bases Connect Kiwix Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Kiwix Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-lightrag-server": {
"post": {
"description": "Connect an external LightRAG server as a retrieval-only knowledge base.\n\nRe-probes server-side (never trusts the client's verdict), then registers a\npointer (``type: lightrag_server``). Retrieval is offloaded to the server's\n``/query`` endpoint — no copy, no local index.",
"operationId": "connect_lightrag_server_route_api_knowledge_bases_connect_lightrag_server_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectLightRagServerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Lightrag Server Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-marginnote4": {
"post": {
"description": "Register a connected MarginNote 4 library as a knowledge base.\n\nCreates a ``type: marginnote4`` pointer so the MarginNote capability can\nbind to it on turns where the user selects this KB. When ``db_path`` is\nomitted the capability derives a default SQLite path from the KB name.",
"operationId": "connect_marginnote4_api_knowledge_bases_connect_marginnote4_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectMarginNote4Request"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Marginnote4",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-obsidian": {
"post": {
"description": "Connect an existing Obsidian vault as a knowledge base.\n\nRegisters a pointer to the user's vault directory (``type: obsidian``) — no\nupload, no index. The vault must be a directory the server can reach (i.e. a\nlocal/self-hosted deployment); the Obsidian capability reads it live.",
"operationId": "connect_obsidian_vault_api_knowledge_bases_connect_obsidian_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectObsidianRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Obsidian Vault",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/connect-weknora": {
"post": {
"description": "Connect a self-hosted WeKnora knowledge base for retrieval only.",
"operationId": "connect_weknora_route_api_knowledge_bases_connect_weknora_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectWeKnoraRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Connect Weknora Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/default": {
"get": {
"description": "Get the default knowledge base.",
"operationId": "get_default_kb_api_knowledge_bases_default_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Default Kb",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/default/{kb_name}": {
"put": {
"description": "Set the default knowledge base.",
"operationId": "set_default_kb_api_knowledge_bases_default__kb_name__put",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Default Kb",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/delete": {
"post": {
"description": "Delete a knowledge base named in the body rather than in the path.\n\nThe path route below cannot reach every registered name. A name is a\n``kb_config.json`` key, and until the ``register_*`` methods validated it\nthe connect-* endpoints wrote whatever the user typed — including a ``/``.\nuvicorn percent-decodes the path before routing, so ``%2F`` becomes a real\nseparator and ``{kb_name}`` (compiled to ``[^/]+``) cannot span it: every\nper-KB route 404s and the KB is visible in the list but unreachable.\n\nA body is never split into path segments, so this reaches those entries.\nWidening the path route to ``{kb_name:path}`` would not do — it is\ndeclared ahead of the DELETE routes for linked folders, GitHub sources and\nweb sources, and a greedy converter would silently swallow all three.",
"operationId": "delete_knowledge_base_by_name_api_knowledge_bases_delete_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteKnowledgeBaseRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Knowledge Base By Name",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/embedding-usage": {
"get": {
"description": "References in this account's workspaces; no provider secrets or other users' KBs.",
"operationId": "get_embedding_usage_api_knowledge_bases_embedding_usage_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Embedding Usage",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/health": {
"get": {
"description": "Count registered KBs without constructing/probing the catalog (#1711).",
"operationId": "health_check_api_knowledge_bases_health_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Health Check",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/kiwix-articles": {
"get": {
"description": "List bounded article matches for Knowledge Center and Reading import.",
"operationId": "search_kiwix_articles_api_knowledge_bases_kiwix_articles_get",
"parameters": [
{
"in": "query",
"name": "kb_ref",
"required": true,
"schema": {
"maxLength": 300,
"minLength": 1,
"title": "Kb Ref",
"type": "string"
}
},
{
"in": "query",
"name": "q",
"required": true,
"schema": {
"maxLength": 500,
"minLength": 1,
"title": "Q",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Search Kiwix Articles Api Knowledge Bases Kiwix Articles Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Search Kiwix Articles",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/kiwix-catalog": {
"get": {
"description": "List exact ZIM names from legacy OPDS; v2 can omit loaded archives.",
"operationId": "list_kiwix_catalog_api_knowledge_bases_kiwix_catalog_get",
"parameters": [
{
"in": "query",
"name": "server_url",
"required": true,
"schema": {
"maxLength": 2048,
"minLength": 1,
"title": "Server Url",
"type": "string"
}
},
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"default": "",
"maxLength": 100,
"title": "Q",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Kiwix Catalog Api Knowledge Bases Kiwix Catalog Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Kiwix Catalog",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/list-ima": {
"post": {
"description": "List IMA knowledge bases without storing or echoing credentials.",
"operationId": "list_ima_route_api_knowledge_bases_list_ima_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListImaRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListImaResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Ima Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/probe-folder": {
"post": {
"description": "Inspect a local folder for a ready engine index before linking it.\n\nReturns the probe verdict (ready index? embedding compatible? warnings?) so\nthe UI can present and confirm before any registration happens. Does not\ncreate a knowledge base.",
"operationId": "probe_linked_folder_route_api_knowledge_bases_probe_folder_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProbeFolderRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe Linked Folder Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/probe-ima": {
"post": {
"description": "Test-connect to a Tencent IMA knowledge base before binding a KB to it.\n\nReturns the verdict (credentials accepted? does the library id resolve, and\nwhat is it called?) so the UI can confirm before any registration happens.\nCreates nothing.",
"operationId": "probe_ima_route_api_knowledge_bases_probe_ima_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProbeImaRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe Ima Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/probe-kiwix": {
"post": {
"description": "Verify that one archive is readable without copying its ZIM file.",
"operationId": "probe_kiwix_route_api_knowledge_bases_probe_kiwix_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KiwixConnectionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Probe Kiwix Route Api Knowledge Bases Probe Kiwix Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe Kiwix Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/probe-lightrag-server": {
"post": {
"description": "Test-connect to an external LightRAG server before binding a KB to it.\n\nReturns the verdict (reachable? is it a LightRAG server? API key accepted?)\nso the UI can confirm before any registration happens. Creates nothing.",
"operationId": "probe_lightrag_server_route_api_knowledge_bases_probe_lightrag_server_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProbeLightRagServerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe Lightrag Server Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/probe-weknora": {
"post": {
"description": "Validate a WeKnora server and knowledge-base binding without registering.",
"operationId": "probe_weknora_route_api_knowledge_bases_probe_weknora_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProbeWeKnoraRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Probe Weknora Route",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/active-model": {
"put": {
"description": "Set the active model for an engine's required kind, applied immediately.\n\nThis is the same active selection the model catalog manages; switching it\nhere affects every engine that uses that kind (the active model is global).",
"operationId": "set_rag_active_model_api_knowledge_bases_rag_pipelines_active_model_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActiveModelUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Rag Active Model",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/graphrag/config": {
"get": {
"description": "Read GraphRAG's query knobs (response style, community granularity).",
"operationId": "get_graphrag_pipeline_config_api_knowledge_bases_rag_pipelines_graphrag_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Graphrag Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist GraphRAG's query knobs. Takes effect on the next query.",
"operationId": "update_graphrag_pipeline_config_api_knowledge_bases_rag_pipelines_graphrag_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphRagConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Graphrag Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/graphrag/model-compatibility": {
"post": {
"description": "Test GraphRAG structured output without changing the active chat model.",
"operationId": "test_graphrag_model_compatibility_api_knowledge_bases_rag_pipelines_graphrag_model_compatibility_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GraphRagModelCompatibilityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Test Graphrag Model Compatibility",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/ima/config": {
"get": {
"description": "Read the account-level IMA credentials (key redacted to a boolean).",
"operationId": "get_ima_pipeline_config_api_knowledge_bases_rag_pipelines_ima_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Ima Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist the account-level IMA Client ID / API key.",
"operationId": "update_ima_pipeline_config_api_knowledge_bases_rag_pipelines_ima_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImaConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Ima Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/lightrag-server/config": {
"get": {
"description": "Read reusable server defaults with the API key redacted.",
"operationId": "get_lightrag_server_pipeline_config_api_knowledge_bases_rag_pipelines_lightrag_server_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Lightrag Server Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist reusable defaults without changing existing KB bindings.",
"operationId": "update_lightrag_server_pipeline_config_api_knowledge_bases_rag_pipelines_lightrag_server_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LightRagServerConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Lightrag Server Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/lightrag/config": {
"get": {
"description": "Read LightRAG's query knobs plus its indexing concurrency/extraction knobs.",
"operationId": "get_lightrag_pipeline_config_api_knowledge_bases_rag_pipelines_lightrag_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Lightrag Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist LightRAG's knobs.\n\nQuery knobs (``top_k``, ``response_type``) take effect on the next query;\nthe indexing knobs shape how a KB is built, so they apply to the next\nbuild or rebuild.",
"operationId": "update_lightrag_pipeline_config_api_knowledge_bases_rag_pipelines_lightrag_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LightRagConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Lightrag Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/lightrag/model-options": {
"get": {
"description": "Return accessible catalog models with supported role capabilities.",
"operationId": "get_lightrag_model_options_api_knowledge_bases_rag_pipelines_lightrag_model_options_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Lightrag Model Options",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/llamaindex/config": {
"get": {
"description": "Read the LlamaIndex engine's retrieval + chunking knobs.\n\n``retrieval_profile`` is what is *configured*; ``effective_retrieval_profile``\nis what would actually run — a hybrid configuration degrades to vector-only\nwhen the BM25 package is missing (e.g. Python 3.14 installs, #1792).",
"operationId": "get_llamaindex_pipeline_config_api_knowledge_bases_rag_pipelines_llamaindex_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Llamaindex Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist the LlamaIndex engine knobs.\n\nRetrieval knobs take effect on the next query; indexing knobs only affect\ndocuments processed after the save.",
"operationId": "update_llamaindex_pipeline_config_api_knowledge_bases_rag_pipelines_llamaindex_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LlamaIndexConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Llamaindex Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/model-options": {
"get": {
"description": "List configured models (secret-free) for the requested model kinds.",
"operationId": "get_rag_model_options_api_knowledge_bases_rag_pipelines_model_options_get",
"parameters": [
{
"in": "query",
"name": "kinds",
"required": false,
"schema": {
"default": "llm,embedding",
"title": "Kinds",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Rag Model Options",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/pageindex/config": {
"get": {
"description": "Read the PageIndex credential state (key redacted to a boolean).",
"operationId": "get_pageindex_pipeline_config_api_knowledge_bases_rag_pipelines_pageindex_config_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Pageindex Pipeline Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Persist the deployment-level PageIndex Cloud credential.",
"operationId": "update_pageindex_pipeline_config_api_knowledge_bases_rag_pipelines_pageindex_config_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageIndexConfigUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Pageindex Pipeline Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-pipelines/{provider}/preflight": {
"get": {
"description": "Check whether ``provider`` can run in the current environment.\n\nReturns ``{ok, checks:[{key,label,ok,detail,optional}]}`` — package\ninstall, API key, and active model requirements per engine.",
"operationId": "get_rag_pipeline_preflight_api_knowledge_bases_rag_pipelines__provider__preflight_get",
"parameters": [
{
"in": "path",
"name": "provider",
"required": true,
"schema": {
"title": "Provider",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Rag Pipeline Preflight",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-providers": {
"get": {
"description": "Get list of available RAG providers (with the active per-engine mode).",
"operationId": "get_rag_providers_api_knowledge_bases_rag_providers_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Rag Providers",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/rag-providers/{provider}/mode": {
"put": {
"description": "Persist the default retrieval mode for a mode-aware engine.\n\nThe mode must be one the engine supports; a KB's own ``search_mode`` still\noverrides this per-KB default.",
"operationId": "set_rag_provider_mode_api_knowledge_bases_rag_providers__provider__mode_put",
"parameters": [
{
"in": "path",
"name": "provider",
"required": true,
"schema": {
"title": "Provider",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderModeUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Rag Provider Mode",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/supported-file-types": {
"get": {
"description": "Return the current upload policy so the web client stays in sync.",
"operationId": "get_supported_file_types_api_knowledge_bases_supported_file_types_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupportedFileTypesInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Supported File Types",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/tasks/{task_id}/stream": {
"get": {
"description": "Stream task-specific logs for knowledge-base operations.",
"operationId": "stream_task_logs_api_knowledge_bases_tasks__task_id__stream_get",
"parameters": [
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stream Task Logs",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}": {
"delete": {
"description": "Delete a knowledge base.",
"operationId": "delete_knowledge_base_api_knowledge_bases__kb_name__delete",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Knowledge Base",
"tags": [
"knowledge-bases"
]
},
"get": {
"description": "Get detailed info for a specific KB.",
"operationId": "get_knowledge_base_details_api_knowledge_bases__kb_name__get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Knowledge Base Details",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/config": {
"get": {
"description": "Get configuration for a specific knowledge base.",
"operationId": "get_kb_config_api_knowledge_bases__kb_name__config_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Kb Config",
"tags": [
"knowledge-bases"
]
},
"put": {
"description": "Update configuration for a specific knowledge base.",
"operationId": "update_kb_config_api_knowledge_bases__kb_name__config_put",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Config",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Kb Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/file-preview-text/{filename}": {
"get": {
"description": "Serve extracted plain text for a raw KB document preview.",
"operationId": "serve_kb_raw_file_text_preview_api_knowledge_bases__kb_name__file_preview_text__filename__get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Serve Kb Raw File Text Preview",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/files": {
"get": {
"description": "List raw documents under <kb>/raw/, recursing into folders.\n\n``name`` is the POSIX path relative to ``raw/`` so the web client can\nrebuild the folder tree. Folders (including empty ones) are returned as\n``type: \"folder\"`` entries so user-created/uploaded structure shows even\nbefore it holds any files. Folders are purely organizational and have no\neffect on indexing or retrieval.",
"operationId": "list_kb_raw_files_api_knowledge_bases__kb_name__files_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Kb Raw Files",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/files/move": {
"post": {
"description": "Move a file/folder between organizational folders (display only).\n\nMoving never re-indexes: folders don't affect retrieval, so this is a pure\nfilesystem relocation under ``raw/``.",
"operationId": "move_kb_file_api_knowledge_bases__kb_name__files_move_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveFilePayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Move Kb File",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/files/{filename}": {
"delete": {
"description": "Remove a single raw document from a knowledge base.\n\nUnlike deleting the whole KB, this works while the KB is in an *error*\nstate — that is the point: a file that failed to parse (e.g. one that\nexceeds the cloud parser's page limit) can be dropped without deleting and\nrebuilding everything. Connected (read-only) and legacy KBs are still\nrejected. Vectors are not pruned here; ``was_indexed`` tells the caller\nwhether a re-index is needed to purge the file from retrieval.",
"operationId": "delete_kb_file_api_knowledge_bases__kb_name__files__filename__delete",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Kb File",
"tags": [
"knowledge-bases"
]
},
"get": {
"description": "Serve a single raw document for inline preview / download.\n\nResolution is sandboxed to the KB's raw/ directory; any path that\nescapes via traversal yields 403.",
"operationId": "serve_kb_raw_file_api_knowledge_bases__kb_name__files__filename__get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "filename",
"required": true,
"schema": {
"title": "Filename",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Serve Kb Raw File",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/folders": {
"post": {
"description": "Create an (organizational) folder under <kb>/raw/. No retrieval effect.",
"operationId": "create_kb_folder_api_knowledge_bases__kb_name__folders_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Kb Folder",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/github-source": {
"post": {
"operationId": "add_github_source_api_knowledge_bases__kb_name__github_source_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddGitHubSourceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GitHubSourceInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Github Source",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/github-source/{source_id}": {
"delete": {
"operationId": "remove_github_source_api_knowledge_bases__kb_name__github_source__source_id__delete",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove Github Source",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/github-sources": {
"get": {
"operationId": "get_github_sources_api_knowledge_bases__kb_name__github_sources_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GitHubSourceInfo"
},
"title": "Response Get Github Sources Api Knowledge Bases Kb Name Github Sources Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Github Sources",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/indexing-policy": {
"put": {
"description": "Reject obsolete model edits instead of saving a policy that will not apply.",
"operationId": "update_pending_indexing_policy_api_knowledge_bases__kb_name__indexing_policy_put",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/LightRagIndexingSelection"
},
{
"$ref": "#/components/schemas/IndexingLLMSelectionRequest"
}
],
"title": "Payload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Update Pending Indexing Policy Api Knowledge Bases Kb Name Indexing Policy Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Pending Indexing Policy",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/indexing-readiness": {
"get": {
"operationId": "get_indexing_readiness_api_knowledge_bases__kb_name__indexing_readiness_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Indexing Readiness",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/indexing-run": {
"get": {
"description": "Pure durable diagnostics; reading never recreates a task or retries work.",
"operationId": "get_indexing_run_api_knowledge_bases__kb_name__indexing_run_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Indexing Run",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/indexing-run/{task_id}/cancel": {
"post": {
"operationId": "cancel_indexing_run_api_knowledge_bases__kb_name__indexing_run__task_id__cancel_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Indexing Run",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/link-folder": {
"post": {
"description": "Link a local folder to a knowledge base.\n\nThis allows syncing documents from a local folder (which can be\nsynced with SharePoint, Google Drive, OneLake, etc.) to the KB.\n\nThe folder path supports:\n- Absolute paths: /Users/name/Documents or C:\\Users\\name\\Documents\n- Home directory: ~/Documents\n- Relative paths (resolved from server working directory)",
"operationId": "link_folder_api_knowledge_bases__kb_name__link_folder_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkFolderRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkedFolderInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Link Folder",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/linked-folders": {
"get": {
"description": "Get list of linked folders for a knowledge base.",
"operationId": "get_linked_folders_api_knowledge_bases__kb_name__linked_folders_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/LinkedFolderInfo"
},
"title": "Response Get Linked Folders Api Knowledge Bases Kb Name Linked Folders Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Linked Folders",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/linked-folders/{folder_id}": {
"delete": {
"description": "Unlink a folder from a knowledge base.",
"operationId": "unlink_folder_api_knowledge_bases__kb_name__linked_folders__folder_id__delete",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "folder_id",
"required": true,
"schema": {
"title": "Folder Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Unlink Folder",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/progress": {
"get": {
"description": "Get initialization progress for a knowledge base",
"operationId": "get_progress_api_knowledge_bases__kb_name__progress_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/progress/clear": {
"post": {
"description": "Clear progress file for a knowledge base (useful for stuck states)",
"operationId": "clear_progress_api_knowledge_bases__kb_name__progress_clear_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Progress",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/reindex": {
"post": {
"description": "Re-index ``kb_name`` through its bound RAG provider.\n\nLlamaIndex keys versions by the selected embedding model. The other\nproviders keep synthetic provider-keyed versions, so they should rebuild\nwithout requiring an embedding-signature precheck.",
"operationId": "reindex_knowledge_base_api_knowledge_bases__kb_name__reindex_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_reindex_knowledge_base_api_knowledge_bases__kb_name__reindex_post"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Reindex Knowledge Base Api Knowledge Bases Kb Name Reindex Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reindex Knowledge Base",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/reindex-config": {
"get": {
"description": "Read selected embedding and current role defaults for rebuild confirmation.",
"operationId": "get_reindex_config_api_knowledge_bases__kb_name__reindex_config_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "query",
"name": "embedding_model",
"required": false,
"schema": {
"default": "",
"title": "Embedding Model",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Reindex Config Api Knowledge Bases Kb Name Reindex Config Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Reindex Config",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/retry": {
"post": {
"description": "Retry a failed KB initialization/indexing run from its stored raw files.",
"operationId": "retry_knowledge_base_api_knowledge_bases__kb_name__retry_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Retry Knowledge Base Api Knowledge Bases Kb Name Retry Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Retry Knowledge Base",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/source-page": {
"get": {
"operationId": "kb_source_page_api_knowledge_bases__kb_name__source_page_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "query",
"name": "source_path",
"required": true,
"schema": {
"title": "Source Path",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"minimum": 1,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "source_hash",
"required": false,
"schema": {
"default": "",
"title": "Source Hash",
"type": "string"
}
},
{
"in": "query",
"name": "region",
"required": false,
"schema": {
"default": "",
"title": "Region",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Kb Source Page",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/sync-folder/{folder_id}": {
"post": {
"description": "Sync files from a linked folder to the knowledge base.\n\nThis scans the linked folder for supported documents and processes\nany new files that haven't been added yet.",
"operationId": "sync_folder_api_knowledge_bases__kb_name__sync_folder__folder_id__post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "folder_id",
"required": true,
"schema": {
"title": "Folder Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncFolderResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sync Folder",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/sync-github": {
"post": {
"operationId": "sync_github_sources_api_knowledge_bases__kb_name__sync_github_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sync Github Sources",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/sync-web": {
"post": {
"description": "Run one bounded crawl-and-sync pass for every enabled web source.",
"operationId": "sync_web_sources_api_knowledge_bases__kb_name__sync_web_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sync Web Sources",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/upload": {
"post": {
"description": "Upload files to a knowledge base and process them in background.\n\n``dest_subdir`` places the whole batch under that folder inside the KB.\nA browser folder pick reports each file's path relative to the chosen\ndirectory, so the directory's own ancestors never reach the server; this\nis how a caller adding one subtree at a time re-attaches it where it\nbelongs instead of piling every batch at the root (#866).",
"operationId": "upload_files_api_knowledge_bases__kb_name__upload_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_files_api_knowledge_bases__kb_name__upload_post"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Upload Files",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/visual-assets/{asset_id}": {
"get": {
"description": "Serve a verified source image from an access checked local KB.",
"operationId": "serve_kb_visual_asset_api_knowledge_bases__kb_name__visual_assets__asset_id__get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "asset_id",
"required": true,
"schema": {
"title": "Asset Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Serve Kb Visual Asset",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/visual-coverage": {
"get": {
"operationId": "kb_visual_coverage_api_knowledge_bases__kb_name__visual_coverage_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "query",
"name": "source_path",
"required": false,
"schema": {
"default": "",
"title": "Source Path",
"type": "string"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Kb Visual Coverage",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source": {
"post": {
"operationId": "add_web_source_api_knowledge_bases__kb_name__web_source_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddWebSourceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSourceInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Web Source",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source-sync": {
"get": {
"operationId": "get_web_source_sync_jobs_api_knowledge_bases__kb_name__web_source_sync_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/WebSourceSyncJobInfo"
},
"title": "Response Get Web Source Sync Jobs Api Knowledge Bases Kb Name Web Source Sync Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Web Source Sync Jobs",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source/{source_id}": {
"delete": {
"operationId": "remove_web_source_api_knowledge_bases__kb_name__web_source__source_id__delete",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove Web Source",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source/{source_id}/cancel": {
"post": {
"operationId": "cancel_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__cancel_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Web Source Sync",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source/{source_id}/pairings": {
"get": {
"operationId": "get_web_source_pairings_api_knowledge_bases__kb_name__web_source__source_id__pairings_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/BilingualPairingInfo"
},
"title": "Response Get Web Source Pairings Api Knowledge Bases Kb Name Web Source Source Id Pairings Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Web Source Pairings",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source/{source_id}/retry": {
"post": {
"operationId": "retry_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__retry_post",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Retry Web Source Sync",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-source/{source_id}/schedule": {
"put": {
"operationId": "update_web_source_schedule_api_knowledge_bases__kb_name__web_source__source_id__schedule_put",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "path",
"name": "source_id",
"required": true,
"schema": {
"title": "Source Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSourceScheduleUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebSourceInfo"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Web Source Schedule",
"tags": [
"knowledge-bases"
]
}
},
"/api/knowledge-bases/{kb_name}/web-sources": {
"get": {
"operationId": "get_web_sources_api_knowledge_bases__kb_name__web_sources_get",
"parameters": [
{
"in": "path",
"name": "kb_name",
"required": true,
"schema": {
"title": "Kb Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/WebSourceInfo"
},
"title": "Response Get Web Sources Api Knowledge Bases Kb Name Web Sources Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Web Sources",
"tags": [
"knowledge-bases"
]
}
},
"/api/learning-journal": {
"get": {
"operationId": "overview_api_learning_journal_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Overview",
"tags": [
"learning-journal"
]
}
},
"/api/marginnote4/devices": {
"get": {
"description": "List all paired devices.",
"operationId": "list_devices_api_marginnote4_devices_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/DeviceInfo"
},
"title": "Response List Devices Api Marginnote4 Devices Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Devices",
"tags": [
"marginnote4"
]
}
},
"/api/marginnote4/devices/{device_id}": {
"delete": {
"description": "Revoke a paired device.",
"operationId": "revoke_device_api_marginnote4_devices__device_id__delete",
"parameters": [
{
"in": "path",
"name": "device_id",
"required": true,
"schema": {
"title": "Device Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "string"
},
"title": "Response Revoke Device Api Marginnote4 Devices Device Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke Device",
"tags": [
"marginnote4"
]
}
},
"/api/marginnote4/heartbeat": {
"post": {
"description": "Lightweight liveness check. Updates last_seen for the device.",
"operationId": "heartbeat_api_marginnote4_heartbeat_post",
"parameters": [
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Heartbeat Api Marginnote4 Heartbeat Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Heartbeat",
"tags": [
"marginnote4"
]
}
},
"/api/marginnote4/pair": {
"post": {
"description": "Pair a new MN4 device. Requires a DeepTutor session.\n\nReturns a one-time token the Add-on stores and presents on every sync.",
"operationId": "pair_device_api_marginnote4_pair_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PairRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PairResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Pair Device",
"tags": [
"marginnote4"
]
}
},
"/api/marginnote4/status": {
"get": {
"description": "Health check and summary stats.",
"operationId": "status_api_marginnote4_status_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Status Api Marginnote4 Status Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Status",
"tags": [
"marginnote4"
]
}
},
"/api/marginnote4/sync": {
"post": {
"description": "Receive an incremental sync batch from a paired MN4 device.",
"operationId": "sync_objects_api_marginnote4_sync_post",
"parameters": [
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Sync Objects",
"tags": [
"marginnote4"
]
}
},
"/api/mastery-paths/progress": {
"get": {
"operationId": "list_all_progress_api_mastery_paths_progress_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List All Progress",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}": {
"delete": {
"operationId": "delete_progress_api_mastery_paths_progress__book_id__delete",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Progress",
"tags": [
"mastery-path"
]
},
"get": {
"operationId": "get_progress_api_mastery_paths_progress__book_id__get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress",
"tags": [
"mastery-path"
]
},
"patch": {
"description": "Rename a path — the only edit that is the learner's rather than the tutor's.\n\nGuarded like every other path mutation so a rename cannot interleave with a\ntutoring turn's own commit, and emitted as an event so the activity feed\nrecords who called it what.",
"operationId": "rename_progress_api_mastery_paths_progress__book_id__patch",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenamePathRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Rename Progress",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/board": {
"get": {
"description": "The visual learning board: every knowledge point as a card, enriched\nwith its next review time and a deterministic grid position derived from\nthe module order. A read-only projection of the same mastery data the\ntutor and the map view use.",
"operationId": "get_progress_board_api_mastery_paths_progress__book_id__board_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress Board",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/events": {
"get": {
"description": "Ordered, redacted domain events for reconnect and incremental UI sync.",
"operationId": "get_progress_events_api_mastery_paths_progress__book_id__events_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "query",
"name": "after_revision",
"required": false,
"schema": {
"default": 0,
"title": "After Revision",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress Events",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/generate-from-notebook": {
"post": {
"operationId": "generate_from_notebook_api_mastery_paths_progress__book_id__generate_from_notebook_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateFromNotebookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate From Notebook",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/generate-from-reading": {
"post": {
"description": "Create a mastery curriculum from a private reading workspace.",
"operationId": "generate_from_reading_api_mastery_paths_progress__book_id__generate_from_reading_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateFromReadingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate From Reading",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/import-from-book": {
"post": {
"operationId": "import_from_book_api_mastery_paths_progress__book_id__import_from_book_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportFromBookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Import From Book",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/init-modules": {
"post": {
"operationId": "init_modules_api_mastery_paths_progress__book_id__init_modules_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitModulesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Init Modules",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/map": {
"get": {
"description": "The dashboard view of a path: the gate-decided next step plus a map of\nevery objective's status (new / learning / mastered). The per-type gate\nlives in ``learning.policy`` so the dashboard and the tutor agree.",
"operationId": "get_progress_map_api_mastery_paths_progress__book_id__map_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress Map",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/objectives/{kp_id}": {
"get": {
"description": "The evidence behind one objective: attempts, schedule, errors, prompts.\n\n``policy.objective_report`` is pure over the aggregate, so the questions\nthemselves — which live in the durable interaction log, not the aggregate —\nare joined on here, redacted of their answer keys.",
"operationId": "get_objective_report_api_mastery_paths_progress__book_id__objectives__kp_id__get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "path",
"name": "kp_id",
"required": true,
"schema": {
"title": "Kp Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Objective Report",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/redo": {
"post": {
"operationId": "redo_progress_api_mastery_paths_progress__book_id__redo_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Redo Progress",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/sessions": {
"get": {
"description": "Expose the explicit conversation associations for this path.",
"operationId": "get_progress_sessions_api_mastery_paths_progress__book_id__sessions_get",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Progress Sessions",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/progress/{book_id}/skip-question": {
"post": {
"description": "Drop an outstanding question the learner can no longer answer.\n\nThe narrow escape hatch for a path stalled on ``answer_pending``; unlike\n``redo`` it keeps every mastery level and review the learner has earned.",
"operationId": "skip_pending_question_api_mastery_paths_progress__book_id__skip_question_post",
"parameters": [
{
"in": "path",
"name": "book_id",
"required": true,
"schema": {
"title": "Book Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Skip Pending Question",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/reading/records": {
"get": {
"description": "Reading progress and extension activity for the current account.",
"operationId": "list_reading_learning_records_api_mastery_paths_reading_records_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadingLearningRecords"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Reading Learning Records",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics": {
"get": {
"operationId": "list_topics_api_mastery_paths_topics_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Topics",
"tags": [
"mastery-path"
]
},
"post": {
"operationId": "create_topic_api_mastery_paths_topics_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfirmTopicRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Topic",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/draft": {
"post": {
"operationId": "generate_topic_route_api_mastery_paths_topics_draft_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateTopicDraftRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate Topic Route",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/index": {
"get": {
"description": "Just enough to *name* a topic: id, title, emoji.\n\nThe sidebar groups study conversations under their topic, and it refreshes\non every stream end. ``/topics`` answers with each path's whole knowledge\nmap, review queue and source excerpts — kilobytes per topic, none of which\na group header renders. This is the same walk with the payload cut to what\na label needs.\n\nDeclared above ``/topics/{path_id}``: that route matches any single\nsegment, so a literal path below it would never be reached.",
"operationId": "list_topic_index_api_mastery_paths_topics_index_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Topic Index",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}": {
"get": {
"operationId": "get_topic_api_mastery_paths_topics__path_id__get",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Topic",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/ask-hint": {
"get": {
"description": "One question the learner could ask here, for the composer placeholder.\n\nWritten by the task model, never blocking: an empty ``hint`` means the\ncomposer keeps the static placeholder it has always had.",
"operationId": "get_topic_ask_hint_api_mastery_paths_topics__path_id__ask_hint_get",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "query",
"name": "session_id",
"required": false,
"schema": {
"default": "",
"title": "Session Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Topic Ask Hint",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/map": {
"put": {
"operationId": "edit_topic_map_api_mastery_paths_topics__path_id__map_put",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditTopicMapRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Edit Topic Map",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/objectives/{kp_id}/override": {
"post": {
"operationId": "set_learner_override_api_mastery_paths_topics__path_id__objectives__kp_id__override_post",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "path",
"name": "kp_id",
"required": true,
"schema": {
"title": "Kp Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LearnerOverrideRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Learner Override",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/review-settings": {
"get": {
"operationId": "get_review_settings_api_mastery_paths_topics__path_id__review_settings_get",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Review Settings",
"tags": [
"mastery-path"
]
},
"put": {
"operationId": "update_review_settings_api_mastery_paths_topics__path_id__review_settings_put",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReviewSettingsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Review Settings",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/sessions": {
"get": {
"operationId": "list_topic_sessions_api_mastery_paths_topics__path_id__sessions_get",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Topic Sessions",
"tags": [
"mastery-path"
]
}
},
"/api/mastery-paths/topics/{path_id}/sessions/{session_id}/mode": {
"put": {
"description": "Change what a conversation is doing, from the learner's own buttons.\n\nThe same move the tutor makes with ``mastery_mode``, through the same\nadmission rule — so pressing \"Study\" on a goal with no outline is refused\nwith the sentence the tutor would have said, rather than silently putting\nthe conversation somewhere its tools will then refuse to work.",
"operationId": "set_session_mode_api_mastery_paths_topics__path_id__sessions__session_id__mode_put",
"parameters": [
{
"in": "path",
"name": "path_id",
"required": true,
"schema": {
"title": "Path Id",
"type": "string"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"schema": {
"title": "Session Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetSessionModeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Set Session Mode",
"tags": [
"mastery-path"
]
}
},
"/api/memory/backup": {
"get": {
"operationId": "list_backups_api_memory_backup_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Backups",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}": {
"get": {
"operationId": "get_doc_api_memory_doc__layer___key__get",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Doc",
"tags": [
"memory"
]
},
"put": {
"operationId": "put_doc_api_memory_doc__layer___key__put",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocWriteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Doc",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/apply": {
"post": {
"description": "Commit a list of previously-previewed ops to a doc atomically.",
"operationId": "apply_doc_ops_api_memory_doc__layer___key__apply_post",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyOpsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Apply Doc Ops",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/audit": {
"post": {
"operationId": "audit_doc_api_memory_doc__layer___key__audit_post",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/AuditRequest"
},
{
"type": "null"
}
],
"title": "Payload"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Audit Doc",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/dedup": {
"post": {
"operationId": "dedup_doc_api_memory_doc__layer___key__dedup_post",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DedupRequest"
},
{
"type": "null"
}
],
"title": "Payload"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Dedup Doc",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/entry/{entry_id}": {
"delete": {
"operationId": "delete_entry_api_memory_doc__layer___key__entry__entry_id__delete",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "path",
"name": "entry_id",
"required": true,
"schema": {
"title": "Entry Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Entry",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/lines": {
"get": {
"description": "Return the line-numbered, footnote-stripped view of a doc.\n\nUsed by the workbench's \"show line numbers\" toggle so the same line\nindices the audit/dedup LLMs see are visible to the user. Footnote\nblock is omitted because edit ops never reference it directly.",
"operationId": "get_doc_lines_api_memory_doc__layer___key__lines_get",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Doc Lines",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/reset": {
"post": {
"description": "Wipe the doc + its meta sidecar so the next update starts fresh.\n\nDestructive — the caller has confirmed. After this returns the .md\nfile is gone *and* the ``seen_entity_refs`` set is cleared, so a\nsubsequent ``run_update`` re-ingests every L1 entity instead of\ntreating them as already-seen.\n\nRefuses while a consolidator run is active on this doc; the caller\ncan cancel first.",
"operationId": "reset_doc_api_memory_doc__layer___key__reset_post",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reset Doc",
"tags": [
"memory"
]
}
},
"/api/memory/doc/{layer}/{key}/update": {
"post": {
"operationId": "update_doc_api_memory_doc__layer___key__update_post",
"parameters": [
{
"in": "path",
"name": "layer",
"required": true,
"schema": {
"title": "Layer",
"type": "string"
}
},
{
"in": "path",
"name": "key",
"required": true,
"schema": {
"title": "Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/UpdateRequest"
},
{
"type": "null"
}
],
"title": "Payload"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Doc",
"tags": [
"memory"
]
}
},
"/api/memory/overview": {
"get": {
"operationId": "get_overview_api_memory_overview_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Overview",
"tags": [
"memory"
]
}
},
"/api/memory/resolve_entry/{entry_id}": {
"get": {
"description": "Find which L2 doc owns this entry id.\n\nL3 docs cite L2 entries by their ``m_<ULID>`` entry id; the workbench\nUI uses this resolver to turn an L3 footnote click into a navigation\nto the right L2 surface + scroll-to anchor.\n\nScans the seven L2 mds in order; first hit wins. 404 if no L2 doc\ncontains the id (e.g. the entry was deleted or the id is stale).",
"operationId": "resolve_entry_api_memory_resolve_entry__entry_id__get",
"parameters": [
{
"in": "path",
"name": "entry_id",
"required": true,
"schema": {
"title": "Entry Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Resolve Entry",
"tags": [
"memory"
]
}
},
"/api/memory/runs": {
"get": {
"operationId": "list_runs_api_memory_runs_get",
"parameters": [
{
"in": "query",
"name": "layer",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Layer"
}
},
{
"in": "query",
"name": "key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Runs",
"tags": [
"memory"
]
}
},
"/api/memory/runs/start": {
"post": {
"description": "Start one consolidator mode and return a run handle.\n\nThe run survives client disconnects; reconnect via\n``GET /runs/{id}/events?since=N``.",
"operationId": "start_run_api_memory_runs_start_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunStartRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Start Run",
"tags": [
"memory"
]
}
},
"/api/memory/runs/{run_id}": {
"get": {
"operationId": "get_run_api_memory_runs__run_id__get",
"parameters": [
{
"in": "path",
"name": "run_id",
"required": true,
"schema": {
"title": "Run Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Run",
"tags": [
"memory"
]
}
},
"/api/memory/runs/{run_id}/cancel": {
"post": {
"operationId": "cancel_run_api_memory_runs__run_id__cancel_post",
"parameters": [
{
"in": "path",
"name": "run_id",
"required": true,
"schema": {
"title": "Run Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Cancel Run",
"tags": [
"memory"
]
}
},
"/api/memory/runs/{run_id}/events": {
"get": {
"description": "SSE-replay events from the next sequence cursor until the run ends.\n\nReconnecting after a refresh: pass ``last_seen_seq + 1``. The manager\nreplays the buffered tail, then blocks on new events until the run reaches\na terminal state.",
"operationId": "stream_run_events_api_memory_runs__run_id__events_get",
"parameters": [
{
"in": "path",
"name": "run_id",
"required": true,
"schema": {
"title": "Run Id",
"type": "string"
}
},
{
"in": "query",
"name": "since",
"required": false,
"schema": {
"default": 0,
"title": "Since",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Stream Run Events",
"tags": [
"memory"
]
}
},
"/api/memory/runs/{run_id}/undo": {
"post": {
"operationId": "undo_run_edit_api_memory_runs__run_id__undo_post",
"parameters": [
{
"in": "path",
"name": "run_id",
"required": true,
"schema": {
"title": "Run Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Undo Run Edit",
"tags": [
"memory"
]
}
},
"/api/memory/settings": {
"get": {
"description": "Return the current ``memory:`` subtree (defaults merged in).",
"operationId": "get_memory_settings_endpoint_api_memory_settings_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Memory Settings Endpoint",
"tags": [
"memory"
]
},
"put": {
"description": "Merge the payload into the ``memory:`` subtree and persist.",
"operationId": "put_memory_settings_api_memory_settings_put",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Payload",
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Memory Settings",
"tags": [
"memory"
]
}
},
"/api/memory/snapshot/{surface}": {
"get": {
"description": "Return the current entity list for ``surface`` from workspace.\n\nSnapshot is always derived live from workspace at call time. The response\nalso includes ``pending_changes`` — the diff vs the last persisted state.\nRefresh commits these pending changes into ``changes.jsonl``.",
"operationId": "get_snapshot_api_memory_snapshot__surface__get",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Snapshot",
"tags": [
"memory"
]
}
},
"/api/memory/snapshot/{surface}/changes": {
"delete": {
"operationId": "clear_snapshot_changes_api_memory_snapshot__surface__changes_delete",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Snapshot Changes",
"tags": [
"memory"
]
},
"get": {
"operationId": "get_changes_api_memory_snapshot__surface__changes_get",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 200,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Changes",
"tags": [
"memory"
]
}
},
"/api/memory/snapshot/{surface}/refresh": {
"post": {
"description": "Reconcile persisted state with current workspace; record diffs.",
"operationId": "refresh_snapshot_api_memory_snapshot__surface__refresh_post",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Refresh Snapshot",
"tags": [
"memory"
]
}
},
"/api/memory/trace/{surface}": {
"delete": {
"operationId": "clear_trace_api_memory_trace__surface__delete",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Trace",
"tags": [
"memory"
]
},
"get": {
"operationId": "get_trace_api_memory_trace__surface__get",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 200,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Trace",
"tags": [
"memory"
]
}
},
"/api/memory/trace/{surface}/day/{day}": {
"delete": {
"operationId": "clear_trace_day_api_memory_trace__surface__day__day__delete",
"parameters": [
{
"in": "path",
"name": "surface",
"required": true,
"schema": {
"title": "Surface",
"type": "string"
}
},
{
"in": "path",
"name": "day",
"required": true,
"schema": {
"title": "Day",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Clear Trace Day",
"tags": [
"memory"
]
}
},
"/api/multi-user/admin/books": {
"get": {
"operationId": "admin_books_api_multi_user_admin_books_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Admin Books Api Multi User Admin Books Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Admin Books",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/admin/resources": {
"get": {
"description": "Everything an admin can assign to a user: models, KBs, skills, and\nthe tool surface (system tools + MCP tools, same pool partners use).",
"operationId": "admin_resources_api_multi_user_admin_resources_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Admin Resources Api Multi User Admin Resources Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Admin Resources",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/admin/skills/install": {
"post": {
"description": "Install a hub skill into the admin catalog (``<hub>:<slug>[@version]``).\n\nThe skill lands in the admin workspace — the same pool ``/admin/resources``\nlists — so it stays invisible to non-admin users until a grant assigns it.\nThe install pipeline (verdict gate, safe extraction, ``always`` stripping)\nlives in :func:`deeptutor.services.skill.hub.install_from_hub`; this\nendpoint only chooses the target root and audits the action.",
"operationId": "admin_install_skill_api_multi_user_admin_skills_install_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SkillInstallPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Admin Install Skill Api Multi User Admin Skills Install Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Admin Install Skill",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/guardians": {
"get": {
"operationId": "list_guardian_relationships_api_multi_user_guardians_get",
"parameters": [
{
"in": "query",
"name": "include_revoked",
"required": false,
"schema": {
"default": false,
"title": "Include Revoked",
"type": "boolean"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response List Guardian Relationships Api Multi User Guardians Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Guardian Relationships",
"tags": [
"multi-user"
]
},
"post": {
"operationId": "authorize_guardian_relationship_api_multi_user_guardians_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuardianAuthorizationPayload"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Authorize Guardian Relationship Api Multi User Guardians Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Authorize Guardian Relationship",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/guardians/{relationship_id}": {
"delete": {
"operationId": "revoke_guardian_relationship_api_multi_user_guardians__relationship_id__delete",
"parameters": [
{
"in": "path",
"name": "relationship_id",
"required": true,
"schema": {
"title": "Relationship Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Revoke Guardian Relationship Api Multi User Guardians Relationship Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke Guardian Relationship",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/learners/{learner_user_id}/credentials/reset": {
"post": {
"operationId": "reset_learner_credentials_api_multi_user_learners__learner_user_id__credentials_reset_post",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuardianCredentialResetPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Reset Learner Credentials Api Multi User Learners Learner User Id Credentials Reset Post",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reset Learner Credentials",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/learners/{learner_user_id}/guardian-report": {
"get": {
"operationId": "guardian_report_api_multi_user_learners__learner_user_id__guardian_report_get",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Guardian Report Api Multi User Learners Learner User Id Guardian Report Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Guardian Report",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/learners/{learner_user_id}/materials": {
"get": {
"operationId": "guardian_material_catalog_api_multi_user_learners__learner_user_id__materials_get",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Guardian Material Catalog Api Multi User Learners Learner User Id Materials Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Guardian Material Catalog",
"tags": [
"multi-user"
]
},
"put": {
"operationId": "assign_guardian_materials_api_multi_user_learners__learner_user_id__materials_put",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuardianMaterialsPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Assign Guardian Materials Api Multi User Learners Learner User Id Materials Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Assign Guardian Materials",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/learners/{learner_user_id}/restrictions": {
"get": {
"operationId": "get_guardian_restrictions_api_multi_user_learners__learner_user_id__restrictions_get",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get Guardian Restrictions Api Multi User Learners Learner User Id Restrictions Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Guardian Restrictions",
"tags": [
"multi-user"
]
},
"put": {
"operationId": "put_guardian_restrictions_api_multi_user_learners__learner_user_id__restrictions_put",
"parameters": [
{
"in": "path",
"name": "learner_user_id",
"required": true,
"schema": {
"title": "Learner User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuardianRestrictionsPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put Guardian Restrictions Api Multi User Learners Learner User Id Restrictions Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put Guardian Restrictions",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/me/guardianships": {
"get": {
"operationId": "my_guardianships_api_multi_user_me_guardianships_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response My Guardianships Api Multi User Me Guardianships Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "My Guardianships",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/me/guardianships/{relationship_id}": {
"delete": {
"operationId": "revoke_my_guardianship_api_multi_user_me_guardianships__relationship_id__delete",
"parameters": [
{
"in": "path",
"name": "relationship_id",
"required": true,
"schema": {
"title": "Relationship Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Revoke My Guardianship Api Multi User Me Guardianships Relationship Id Delete",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Revoke My Guardianship",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/users": {
"get": {
"operationId": "multi_user_list_users_api_multi_user_users_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Multi User List Users Api Multi User Users Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Multi User List Users",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/users/{user_id}/book-permission": {
"get": {
"operationId": "get_user_book_permission_api_multi_user_users__user_id__book_permission_get",
"parameters": [
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"title": "User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get User Book Permission Api Multi User Users User Id Book Permission Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get User Book Permission",
"tags": [
"multi-user"
]
},
"put": {
"operationId": "put_user_book_permission_api_multi_user_users__user_id__book_permission_put",
"parameters": [
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"title": "User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookPermissionPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put User Book Permission Api Multi User Users User Id Book Permission Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put User Book Permission",
"tags": [
"multi-user"
]
}
},
"/api/multi-user/users/{user_id}/grants": {
"get": {
"operationId": "get_user_grants_api_multi_user_users__user_id__grants_get",
"parameters": [
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"title": "User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Get User Grants Api Multi User Users User Id Grants Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get User Grants",
"tags": [
"multi-user"
]
},
"put": {
"operationId": "put_user_grants_api_multi_user_users__user_id__grants_put",
"parameters": [
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"title": "User Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Put User Grants Api Multi User Users User Id Grants Put",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Put User Grants",
"tags": [
"multi-user"
]
}
},
"/api/notebooks": {
"get": {
"description": "Get all notebook list\n\nReturns:\n Notebook list (includes summary information)",
"operationId": "list_notebooks_api_notebooks_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Notebooks",
"tags": [
"notebooks"
]
},
"post": {
"description": "Create new notebook\n\nArgs:\n request: Create request\n\nReturns:\n Created notebook information",
"operationId": "create_notebook_api_notebooks_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotebookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Notebook",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/actions/add-record": {
"post": {
"description": "Add record to notebook\n\nArgs:\n request: Add record request\n\nReturns:\n Addition result",
"operationId": "add_record_api_notebooks_actions_add_record_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Record",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/actions/add-record-with-summary": {
"post": {
"description": "Add record to notebook and stream generated summary.",
"operationId": "add_record_with_summary_api_notebooks_actions_add_record_with_summary_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Record With Summary",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/health": {
"get": {
"description": "Health check",
"operationId": "health_check_api_notebooks_health_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Health Check",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/records/{record_id}/location": {
"get": {
"description": "Resolve a source citation after a collection move, within the active workspace.",
"operationId": "locate_record_api_notebooks_records__record_id__location_get",
"parameters": [
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"title": "Record Id",
"type": "string"
}
},
{
"in": "query",
"name": "notebook_id",
"required": false,
"schema": {
"default": "",
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Locate Record",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/statistics": {
"get": {
"description": "Get notebook statistics\n\nReturns:\n Statistics information",
"operationId": "get_statistics_api_notebooks_statistics_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Statistics",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/{notebook_id}": {
"delete": {
"description": "Delete notebook\n\nArgs:\n notebook_id: Notebook ID\n\nReturns:\n Deletion result",
"operationId": "delete_notebook_api_notebooks__notebook_id__delete",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Notebook",
"tags": [
"notebooks"
]
},
"get": {
"description": "Get notebook details\n\nArgs:\n notebook_id: Notebook ID\n\nReturns:\n Notebook details (includes all records)",
"operationId": "get_notebook_api_notebooks__notebook_id__get",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Notebook",
"tags": [
"notebooks"
]
},
"put": {
"description": "Update notebook information\n\nArgs:\n notebook_id: Notebook ID\n request: Update request\n\nReturns:\n Updated notebook information",
"operationId": "update_notebook_api_notebooks__notebook_id__put",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotebookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Notebook",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/{notebook_id}/export": {
"get": {
"description": "Render the whole notebook as a single Markdown document.",
"operationId": "export_notebook_api_notebooks__notebook_id__export_get",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Export Notebook",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/{notebook_id}/records/{record_id}": {
"delete": {
"description": "Remove record from notebook\n\nArgs:\n notebook_id: Notebook ID\n record_id: Record ID\n\nReturns:\n Deletion result",
"operationId": "remove_record_api_notebooks__notebook_id__records__record_id__delete",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove Record",
"tags": [
"notebooks"
]
},
"put": {
"description": "Update an existing notebook record in place.",
"operationId": "update_record_api_notebooks__notebook_id__records__record_id__put",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Record",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/{notebook_id}/records/{record_id}/actions/copy": {
"post": {
"description": "Duplicate a record into another notebook under a fresh id.",
"operationId": "copy_record_api_notebooks__notebook_id__records__record_id__actions_copy_post",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Copy Record",
"tags": [
"notebooks"
]
}
},
"/api/notebooks/{notebook_id}/records/{record_id}/actions/move": {
"post": {
"description": "Move a record from this notebook into another one.",
"operationId": "move_record_api_notebooks__notebook_id__records__record_id__actions_move_post",
"parameters": [
{
"in": "path",
"name": "notebook_id",
"required": true,
"schema": {
"title": "Notebook Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveRecordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Move Record",
"tags": [
"notebooks"
]
}
},
"/api/partner-groups": {
"get": {
"operationId": "list_partner_groups_api_partner_groups_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Partner Groups",
"tags": [
"partner-groups"
]
},
"post": {
"operationId": "create_partner_group_api_partner_groups_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartnerGroupRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Partner Group",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/discussion-modes": {
"get": {
"operationId": "list_discussion_modes_api_partner_groups_discussion_modes_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Discussion Modes",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/shared-memory-types": {
"get": {
"operationId": "list_shared_memory_types_api_partner_groups_shared_memory_types_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Shared Memory Types",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}": {
"delete": {
"operationId": "delete_partner_group_api_partner_groups__group_id__delete",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Partner Group",
"tags": [
"partner-groups"
]
},
"get": {
"operationId": "get_partner_group_api_partner_groups__group_id__get",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Partner Group",
"tags": [
"partner-groups"
]
},
"patch": {
"operationId": "update_partner_group_api_partner_groups__group_id__patch",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerGroupRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Partner Group",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/history": {
"get": {
"operationId": "partner_group_history_api_partner_groups__group_id__history_get",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "query",
"name": "session_key",
"required": false,
"schema": {
"default": "default",
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 200,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Partner Group History",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/invocations": {
"get": {
"operationId": "partner_group_invocations_api_partner_groups__group_id__invocations_get",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "query",
"name": "session_key",
"required": false,
"schema": {
"default": "default",
"maxLength": 120,
"minLength": 1,
"title": "Session Key",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 200,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Partner Group Invocations",
"tags": [
"partner-groups"
]
},
"post": {
"operationId": "create_partner_invocation_api_partner_groups__group_id__invocations_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartnerInvocationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Partner Invocation",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/invocations/{invocation_id}/approve": {
"post": {
"operationId": "approve_partner_invocation_api_partner_groups__group_id__invocations__invocation_id__approve_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "invocation_id",
"required": true,
"schema": {
"title": "Invocation Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerInvocationActionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Approve Partner Invocation",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/invocations/{invocation_id}/reject": {
"post": {
"operationId": "reject_partner_invocation_api_partner_groups__group_id__invocations__invocation_id__reject_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "invocation_id",
"required": true,
"schema": {
"title": "Invocation Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerInvocationActionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reject Partner Invocation",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/messages": {
"post": {
"operationId": "send_partner_group_message_api_partner_groups__group_id__messages_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerGroupMessageRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Send Partner Group Message",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/rounds/{turn_id}/summary": {
"post": {
"operationId": "summarize_partner_group_round_api_partner_groups__group_id__rounds__turn_id__summary_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "turn_id",
"required": true,
"schema": {
"title": "Turn Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoundSummaryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Summarize Partner Group Round",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/sessions": {
"get": {
"operationId": "list_partner_group_sessions_api_partner_groups__group_id__sessions_get",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Partner Group Sessions",
"tags": [
"partner-groups"
]
},
"post": {
"operationId": "create_partner_group_session_api_partner_groups__group_id__sessions_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Partner Group Session",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/sessions/{session_key}": {
"delete": {
"operationId": "delete_partner_group_session_api_partner_groups__group_id__sessions__session_key__delete",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "session_key",
"required": true,
"schema": {
"title": "Session Key",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Partner Group Session",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/turns/{turn_id}/partners/{partner_id}/retry": {
"post": {
"operationId": "retry_partner_group_seat_api_partner_groups__group_id__turns__turn_id__partners__partner_id__retry_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "turn_id",
"required": true,
"schema": {
"title": "Turn Id",
"type": "string"
}
},
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerSeatRetryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Retry Partner Group Seat",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/whiteboard": {
"get": {
"operationId": "partner_group_whiteboard_api_partner_groups__group_id__whiteboard_get",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 200,
"maximum": 500,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Partner Group Whiteboard",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/whiteboard/pins": {
"post": {
"operationId": "pin_partner_group_whiteboard_api_partner_groups__group_id__whiteboard_pins_post",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WhiteboardPinRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Pin Partner Group Whiteboard",
"tags": [
"partner-groups"
]
}
},
"/api/partner-groups/{group_id}/whiteboard/pins/{event_id}": {
"delete": {
"operationId": "unpin_partner_group_whiteboard_api_partner_groups__group_id__whiteboard_pins__event_id__delete",
"parameters": [
{
"in": "path",
"name": "group_id",
"required": true,
"schema": {
"title": "Group Id",
"type": "string"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"title": "Event Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Unpin Partner Group Whiteboard",
"tags": [
"partner-groups"
]
}
},
"/api/partners": {
"get": {
"description": "Partners the caller may talk to — theirs in full, assigned ones as cards.",
"operationId": "list_partners_api_partners_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Partners",
"tags": [
"partners"
]
},
"post": {
"description": "Create a partner owned by the caller.\n\nAnyone may build their own companion; the assets it is provisioned with are\nresolved against the creator's own permissions (see ``provision_assets``),\nso this hands nobody access they did not already have.",
"operationId": "create_partner_api_partners_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartnerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Partner",
"tags": [
"partners"
]
}
},
"/api/partners/channels/schema": {
"get": {
"description": "JSON-Schema metadata for every available channel (schema-driven UI).",
"operationId": "list_channel_schemas_api_partners_channels_schema_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Channel Schemas",
"tags": [
"partners"
]
}
},
"/api/partners/commands/palette": {
"get": {
"operationId": "partner_command_palette_api_partners_commands_palette_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Partner Command Palette",
"tags": [
"partners"
]
}
},
"/api/partners/consultation-session": {
"get": {
"description": "Recover native identity for older consultation traces in this user's registry.",
"operationId": "get_partner_consultation_session_api_partners_consultation_session_get",
"parameters": [
{
"in": "query",
"name": "chat_session_id",
"required": true,
"schema": {
"title": "Chat Session Id",
"type": "string"
}
},
{
"in": "query",
"name": "partner_name",
"required": true,
"schema": {
"title": "Partner Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Partner Consultation Session",
"tags": [
"partners"
]
}
},
"/api/partners/drafts/{draft_id}": {
"get": {
"description": "Reload one pending/created draft for the authenticated user.",
"operationId": "get_partner_draft_api_partners_drafts__draft_id__get",
"parameters": [
{
"in": "path",
"name": "draft_id",
"required": true,
"schema": {
"title": "Draft Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Partner Draft",
"tags": [
"partners"
]
}
},
"/api/partners/drafts/{draft_id}/confirm": {
"post": {
"description": "Promote a reviewable Chat draft into a real Partner exactly once.",
"operationId": "confirm_partner_draft_api_partners_drafts__draft_id__confirm_post",
"parameters": [
{
"in": "path",
"name": "draft_id",
"required": true,
"schema": {
"title": "Draft Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfirmPartnerDraftRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Confirm Partner Draft",
"tags": [
"partners"
]
}
},
"/api/partners/navigation": {
"get": {
"description": "Read existing identities and actor-scoped sessions without moving data.\n\nNever enumerate the manager's global partner directories or shared channel\nhistory here. Visibility and transcript ownership match the detail APIs.",
"operationId": "partner_navigation_api_partners_navigation_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerNavigation"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Partner Navigation",
"tags": [
"partners"
]
}
},
"/api/partners/recent": {
"get": {
"operationId": "recent_partners_api_partners_recent_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 3,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Recent Partners",
"tags": [
"partners"
]
}
},
"/api/partners/soul-sources": {
"get": {
"description": "Everything the create-wizard's soul step can start from.",
"operationId": "soul_sources_api_partners_soul_sources_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Soul Sources",
"tags": [
"partners"
]
}
},
"/api/partners/souls": {
"get": {
"operationId": "list_souls_api_partners_souls_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "List Souls",
"tags": [
"partners"
]
},
"post": {
"operationId": "create_soul_api_partners_souls_post",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoulCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Create Soul",
"tags": [
"partners"
]
}
},
"/api/partners/souls/{soul_id}": {
"delete": {
"operationId": "delete_soul_api_partners_souls__soul_id__delete",
"parameters": [
{
"in": "path",
"name": "soul_id",
"required": true,
"schema": {
"title": "Soul Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Soul",
"tags": [
"partners"
]
},
"get": {
"operationId": "get_soul_api_partners_souls__soul_id__get",
"parameters": [
{
"in": "path",
"name": "soul_id",
"required": true,
"schema": {
"title": "Soul Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Soul",
"tags": [
"partners"
]
},
"put": {
"operationId": "update_soul_api_partners_souls__soul_id__put",
"parameters": [
{
"in": "path",
"name": "soul_id",
"required": true,
"schema": {
"title": "Soul Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoulTemplateUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Soul",
"tags": [
"partners"
]
}
},
"/api/partners/tool-options": {
"get": {
"description": "The configurable tool surface for a partner.\n\n``tools`` mirrors the user-toggleable system tools (the same pool the\nchat composer / settings expose); ``builtin_tools`` lists the auto-mounted\nbuilt-in tools (rag / web_fetch / …) the owner can allow or deny;\n``mcp_tools`` lists every configured MCP tool the partner could be allowed\nto load. ``read_memory`` / ``write_memory`` are excluded: partners use the\nmandatory ``partner_read`` / ``partner_memorize`` / ``partner_search`` tools\ninstead, which are always on and not owner-configurable.",
"operationId": "tool_options_api_partners_tool_options_get",
"parameters": [
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Tool Options",
"tags": [
"partners"
]
}
},
"/api/partners/{partner_id}": {
"delete": {
"operationId": "destroy_partner_api_partners__partner_id__delete",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Destroy Partner",
"tags": [
"partners"
]
},
"get": {
"description": "One partner, projected by what the caller may do with it.\n\nSomeone who merely *uses* the partner gets its identity card — enough to\nrender a conversation header — while its owner gets the configuration.",
"operationId": "get_partner_api_partners__partner_id__get",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"description": "Return raw channel secrets (tokens, passwords). Required by the edit form; default response masks all secret-looking fields.",
"in": "query",
"name": "include_secrets",
"required": false,
"schema": {
"default": false,
"description": "Return raw channel secrets (tokens, passwords). Required by the edit form; default response masks all secret-looking fields.",
"title": "Include Secrets",
"type": "boolean"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Partner",
"tags": [
"partners"
]
},
"patch": {
"operationId": "update_partner_api_partners__partner_id__patch",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Update Partner",
"tags": [
"partners"
]
}
},
"/api/partners/{partner_id}/assets": {
"get": {
"operationId": "get_partner_assets_api_partners__partner_id__assets_get",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Partner Assets",
"tags": [
"partners"
]
},
"post": {
"operationId": "add_partner_assets_api_partners__partner_id__assets_post",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetAddRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Add Partner Assets",
"tags": [
"partners"
]
}
},
"/api/partners/{partner_id}/assets/{asset_type}/{name}": {
"delete": {
"operationId": "delete_partner_asset_api_partners__partner_id__assets__asset_type___name__delete",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "path",
"name": "asset_type",
"required": true,
"schema": {
"title": "Asset Type",
"type": "string"
}
},
{
"in": "path",
"name": "name",
"required": true,
"schema": {
"title": "Name",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Delete Partner Asset",
"tags": [
"partners"
]
}
},
"/api/partners/{partner_id}/channel-onboarding/start": {
"post": {
"operationId": "start_partner_channel_onboarding_api_partners__partner_id__channel_onboarding_start_post",
"parameters": [
{
"in": "path",
"name": "partner_id",
"required": true,
"schema": {
"title": "Partner Id",
"type": "string"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "dt_token",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dt Token"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/sFile truncated at 1 MB.