hackthon_project/APIDocumentation.txt at main · codesstar/hackthon_project · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# Unknown Unknown: API Documentation

This document outlines the RESTful API for the Unknown Unknown backend system.

## Authentication

### POST /register

Register a new user.
**Request:**

```json
{
  "username": "john",
  "email": "john@example.com",
  "password": "securepass"
}
```

**Response:** `201 Created`

```json
{
  "msg": "User registered successfully"
}
```

### POST /login

Log in and receive a JWT.
**Request:**

```json
{
  "username": "john",
  "password": "securepass"
}
```

**Response:**

```json
{
  "access_token": "..."
}
```

---

## Topic & Subtopic

### GET /topics

Fetch all available topics.
**Response:**

```json
[
  {
    "id": 1,
    "title": "Deep Learning",
    "description": "A book about neural networks",
    "cover_image": "/uploaded_images/abc.png"
  }
]
```

### GET /subtopics?topic\_id=<id>

Fetch all subtopics under a topic.
**Response:**

```json
[
  {
    "id": 2,
    "topic_id": 1,
    "script": "This is the intro chapter...",
    "image_url": null
  }
]
```

### POST /save-subtopic

Save a subtopic to user's collection. Requires JWT.
**Request:**

```json
{
  "subtopic_id": 2
}
```

**Response:**

```json
{
  "msg": "Subtopic saved"
}
```

### GET /my-subtopics

Get saved subtopics for current user (JWT required).
**Response:** Same format as `/subtopics`.

---

## Chat

### POST /chat-with-subtopic

Send a message related to a subtopic and receive GPT reply.
**Request:**

```json
{
  "subtopic_id": 2,
  "user_input": "Can you summarize this?"
}
```

**Response:**

```json
{
  "reply": "Sure, this chapter explains..."
}
```

---

## Upload

### POST /upload-image

Upload a base64 encoded image.
**Request:**

```json
{
  "base64": "iVBORw0KGgoAAAANS..."
}
```

**Response:**

```json
{
  "image_url": "/uploaded_images/xyz.png"
}
```

---

## Status Codes

| Code | Meaning                   |
| ---- | ------------------------- |
| 200  | OK                        |
| 201  | Created                   |
| 400  | Bad Request               |
| 401  | Unauthorized (JWT needed) |
| 404  | Not Found                 |

## Notes

* All protected routes require `Authorization: Bearer <token>` in headers.
* All routes return JSON responses.
* Base64 uploads are limited to image files only.

This API is designed to support mobile and web frontends that enable interactive microlearning experiences.