From 3f270486522df66a993db30c6e474e2776aebeb6 Mon Sep 17 00:00:00 2001
From: Azalea <22280294+hykilpikonna@users.noreply.github.com>
Date: Wed, 22 Nov 2023 02:17:57 -0500
Subject: [PATCH] [+] Create api

---
 API.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..c7ab717
--- /dev/null
+++ b/API.md
@@ -0,0 +1,33 @@
+
+> For the demo, language ∈ {EN_JA, EN_ZH-CN}
+
+POST /ai-mark {
+	question: str, 
+	user_answer: str, 
+	expected: str, 
+	chapter: str,
+	language: str
+}
+-> {correct: bool, reason: str}
+
+POST /human-chat {
+	target_name: str,
+	target_hobbies: list\[str],
+	history: list\[{from\_me: bool, msg: str}],
+	language: str
+}
+-> {msg: str}
+
+> Chat histories will be stored in localStorage
+
+POST /recognize (Body is an audio file)
+-> {text: str}
+
+POST /character-chat {
+	character: str
+	history: list\[{from_me: bool, msg: str}]
+	language: str
+}
+-> {msg: str, audio: UUID}
+
+GET /audio/{UUID}
\ No newline at end of file