Spaces:
Sleeping
Sleeping
File size: 10,864 Bytes
054e65a | 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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | openapi: 3.1.0
info:
title: AIDidact API
version: 1.0.0
description: API contract for the AIDidact AI-powered microlearning ecosystem.
servers:
- url: https://api.aididact.example.com
paths:
/v1/auth/register:
post:
summary: Register a learner
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterLearnerRequest'
responses:
'201':
description: Registered
content:
application/json:
schema:
$ref: '#/components/schemas/LearnerRegistrationResponse'
/v1/learners/{learnerId}/profile:
get:
summary: Get learner profile
parameters:
- $ref: '#/components/parameters/LearnerId'
responses:
'200':
description: Learner profile
content:
application/json:
schema:
$ref: '#/components/schemas/LearnerProfile'
patch:
summary: Update learner goals or preferences
parameters:
- $ref: '#/components/parameters/LearnerId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLearnerProfileRequest'
responses:
'200':
description: Updated
/v1/learners/{learnerId}/diagnostic-assessment:
post:
summary: Submit readiness assessment
parameters:
- $ref: '#/components/parameters/LearnerId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DiagnosticSubmission'
responses:
'202':
description: Accepted
/v1/modules:
get:
summary: List modules
responses:
'200':
description: Module list
/v1/modules/{moduleId}:
get:
summary: Get module detail
parameters:
- $ref: '#/components/parameters/ModuleId'
responses:
'200':
description: Module detail
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleDetail'
/v1/learners/{learnerId}/recommendations:
get:
summary: Get ranked module recommendations
parameters:
- $ref: '#/components/parameters/LearnerId'
responses:
'200':
description: Recommendations
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/RecommendationItem'
/v1/enrollments:
post:
summary: Enroll learner in module
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [learnerId, moduleId]
properties:
learnerId:
type: string
format: uuid
moduleId:
type: string
format: uuid
responses:
'201':
description: Enrolled
/v1/interactions:
post:
summary: Ingest interaction event
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InteractionEvent'
responses:
'202':
description: Accepted
/v1/assessments/{assessmentId}/attempts:
post:
summary: Create unique assessment attempt
parameters:
- $ref: '#/components/parameters/AssessmentId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [learnerId]
properties:
learnerId:
type: string
format: uuid
responses:
'201':
description: Attempt created
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentAttempt'
/v1/assessments/attempts/{attemptId}/responses:
post:
summary: Submit responses
parameters:
- $ref: '#/components/parameters/AttemptId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentResponseSubmission'
responses:
'202':
description: Accepted for grading
/v1/assessments/attempts/{attemptId}:
get:
summary: Get assessment result
parameters:
- $ref: '#/components/parameters/AttemptId'
responses:
'200':
description: Result
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentAttemptResult'
/v1/learners/{learnerId}/dashboard:
get:
summary: Get learner dashboard
parameters:
- $ref: '#/components/parameters/LearnerId'
responses:
'200':
description: Dashboard
content:
application/json:
schema:
$ref: '#/components/schemas/LearnerDashboard'
components:
parameters:
LearnerId:
in: path
name: learnerId
required: true
schema:
type: string
format: uuid
ModuleId:
in: path
name: moduleId
required: true
schema:
type: string
format: uuid
AssessmentId:
in: path
name: assessmentId
required: true
schema:
type: string
format: uuid
AttemptId:
in: path
name: attemptId
required: true
schema:
type: string
format: uuid
schemas:
RegisterLearnerRequest:
type: object
required: [email, firstName, lastName, timezone, educationalLevel, goals, priorLearning]
properties:
email:
type: string
format: email
firstName:
type: string
lastName:
type: string
timezone:
type: string
educationalLevel:
type: string
priorLearning:
type: array
items:
$ref: '#/components/schemas/PriorLearningItem'
goals:
type: array
items:
$ref: '#/components/schemas/LearnerGoal'
preferences:
$ref: '#/components/schemas/LearnerPreferences'
LearnerRegistrationResponse:
type: object
properties:
learnerId:
type: string
format: uuid
nextStep:
type: string
PriorLearningItem:
type: object
properties:
learningType:
type: string
enum: [formal, non_formal, informal]
title:
type: string
provider:
type: string
description:
type: string
LearnerGoal:
type: object
properties:
goalHorizon:
type: string
enum: [short_term, long_term]
goalText:
type: string
targetDate:
type: string
format: date
LearnerPreferences:
type: object
properties:
preferredModalities:
type: array
items:
type: string
preferredSessionLengthMinutes:
type: integer
DiagnosticSubmission:
type: object
properties:
responses:
type: array
items:
type: object
additionalProperties: true
LearnerProfile:
type: object
properties:
learnerId:
type: string
format: uuid
readinessLevel:
type: string
readinessScore:
type: number
masteryMap:
type: object
additionalProperties: true
UpdateLearnerProfileRequest:
type: object
properties:
goals:
type: array
items:
$ref: '#/components/schemas/LearnerGoal'
preferences:
$ref: '#/components/schemas/LearnerPreferences'
ModuleDetail:
type: object
properties:
id:
type: string
format: uuid
title:
type: string
description:
type: string
objectives:
type: array
items:
type: object
additionalProperties: true
units:
type: array
items:
type: object
additionalProperties: true
completionCriteria:
type: object
additionalProperties: true
RecommendationItem:
type: object
properties:
moduleId:
type: string
format: uuid
rank:
type: integer
score:
type: number
reasons:
type: array
items:
type: string
InteractionEvent:
type: object
properties:
learnerId:
type: string
format: uuid
moduleId:
type: string
format: uuid
unitId:
type: string
format: uuid
activityId:
type: string
format: uuid
eventType:
type: string
eventTimestamp:
type: string
format: date-time
durationMs:
type: integer
payload:
type: object
additionalProperties: true
AssessmentAttempt:
type: object
properties:
attemptId:
type: string
format: uuid
assessmentId:
type: string
format: uuid
timeLimitMinutes:
type: integer
items:
type: array
items:
type: object
additionalProperties: true
AssessmentResponseSubmission:
type: object
properties:
responses:
type: array
items:
type: object
additionalProperties: true
AssessmentAttemptResult:
type: object
properties:
attemptId:
type: string
format: uuid
score:
type: number
passStatus:
type: string
integrityStatus:
type: string
humanReviewRequired:
type: boolean
LearnerDashboard:
type: object
properties:
learnerId:
type: string
format: uuid
timeOnTaskMinutes7d:
type: number
dropoutRisk:
type: number
successProbability:
type: number
adaptiveFeedback:
type: array
items:
type: string
|