Piggyback Learning API

• getList Kids Videos
• getGet Final Questions
• postCheck Answer
• postTranscribe Audio
• getGet Config
• getAdmin Page
• postApi Download
• postApi Extract Frames
• getAdmin List Downloaded Videos
• postSubmit Questions
• getHome Page
• getHome Redirect
• getChildren Page
• postVerify Password
• getExpert Preview
• postSave Expert Annotation
• getList Videos
• getGet Expert Questions
• postSave Expert Question
• postSave Final Questions
• postSynthesize Tts

API docs by Redocly

Piggyback Learning (0.1.0)

Download OpenAPI specification:Download

List Kids Videos

Return JSON of all locally available kids videos

Responses

https://capstone-projects-2026-spring.github.io/api/kids_videos

Response samples

• 200

Content type

application/json

null

Get Final Questions

Loads final_questions.json for the given video_id. Returns the best LLM-ranked question per segment (lowest llm_ranking) that is not trashed. If trashed=True, skip to the next question.

path Parameters

video_id required

string (Video Id)

Responses

https://capstone-projects-2026-spring.github.io/api/final-questions/{video_id}

Response samples

• 200
• 422

Content type

application/json

null

Check Answer

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/check_answer

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null

Transcribe Audio

Accepts audio (webm, wav, mp3, etc), sends to Whisper, no temp file saved (in-memory BytesIO).

Request Body schema: multipart/form-data

file required

string <binary> (File)

Responses

https://capstone-projects-2026-spring.github.io/api/transcribe

Response samples

• 200
• 422

Content type

application/json

null

Get Config

Responses

https://capstone-projects-2026-spring.github.io/api/config

Response samples

• 200

Content type

application/json

null

Admin Page

Responses

https://capstone-projects-2026-spring.github.io/admin/

Api Download

Request Body schema: application/x-www-form-urlencoded

url required

string (Url)

Responses

https://capstone-projects-2026-spring.github.io/api/download

Response samples

• 200
• 422

Content type

application/json

null

Api Extract Frames

path Parameters

video_id required

string (Video Id)

Responses

https://capstone-projects-2026-spring.github.io/api/frames/{video_id}

Response samples

• 200
• 422

Content type

application/json

null

Admin List Downloaded Videos

Provide a lightweight manifest of downloaded videos so admins can reuse them.

query Parameters

include_without_frames

boolean (Include Without Frames) Default: false

Responses

https://capstone-projects-2026-spring.github.io/api/admin/videos

Response samples

• 200
• 422

Content type

application/json

null

Submit Questions

Submit and save finalized questions (admin 'Submit' in UI). Saves to downloads//questions/.json

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/submit-questions

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null

Home Page

Home page with user type selection

Responses

https://capstone-projects-2026-spring.github.io/

Home Redirect

Alternative home page route

Responses

https://capstone-projects-2026-spring.github.io/home

Children Page

Children's learning interface - no password required

Responses

https://capstone-projects-2026-spring.github.io/children

Verify Password

Verify password for admin/expert access

Request Body schema: application/x-www-form-urlencoded

user_type required	string (User Type)
password required	string (Password)

Responses

https://capstone-projects-2026-spring.github.io/api/verify-password

Response samples

• 200
• 422

Content type

application/json

null

Expert Preview

query Parameters

	File (string) or File (null) (File)
	Video (string) or Video (null) (Video)
	Mode (string) or Mode (null) (Mode) Default: "review"

Responses

https://capstone-projects-2026-spring.github.io/expert-preview

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Save Expert Annotation

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/expert-annotations

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null

List Videos

List all downloaded videos with title, thumbnail, duration, and question counts.

Responses

https://capstone-projects-2026-spring.github.io/api/videos-list

Response samples

• 200

Content type

application/json

null

Get Expert Questions

path Parameters

video_id required

string (Video Id)

Responses

https://capstone-projects-2026-spring.github.io/api/expert-questions/{video_id}

Response samples

• 200
• 422

Content type

application/json

null

Save Expert Question

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/expert-questions

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null

Save Final Questions

Save final reviewed questions to a dedicated folder

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/save-final-questions

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null

Synthesize Tts

Generate speech audio via OpenAI TTS.

Request Body schema: application/json

property name* additional property

any

Responses

https://capstone-projects-2026-spring.github.io/api/tts

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

null