Skip to content

HadiHz88/CloudQ-API

Repository files navigation

CloudQ API Documentation

Base URL: http://localhost:3000

Organizations

  • GET /organizations - List all organizations
  • POST /organizations - Create an organization
  • GET /organizations/{orgId} - Get an organization
  • PATCH /organizations/{orgId} - Update an organization
  • DELETE /organizations/{orgId} - Delete an organization

Courses

  • GET /courses - List courses in an organization
  • POST /courses - Create a course in an organization
  • GET /courses/{courseId} - Get course details
  • PATCH /courses/{courseId} - Update a course
  • DELETE /courses/{courseId} - Delete a course

Users

  • GET /auth/me - Get profile
  • DELETE /auth/{subId} - Delete a user by ID
  • POST /auth/invite-learner - Invite learner
  • POST /auth/invite-instructor - Invite instructor

Materials

  • GET /materials/{materialId} - Get material details
  • PATCH /materials/{materialId} - Update a material
  • DELETE /materials/{materialId} - Delete a material
  • GET /courses/{courseId}/materials - List materials for a course
  • POST /courses/{courseId}/materials - Create a material for a course

Flashcards

  • GET /flashcards/{flashcardId} - Get a flashcard
  • PATCH /flashcards/{flashcardId} - Update a flashcard
  • DELETE /flashcards/{flashcardId} - Delete a flashcard
  • POST /flashcards - Create a flashcard
  • GET /courses/{courseId}/flashcards - List flashcards for a course
  • POST /courses/{courseId}/flashcards - Create a flashcard for a course

Quizzes

  • GET /quizzes/{quizId} - Get quiz details
  • PATCH /quizzes/{quizId} - Update a quiz
  • DELETE /quizzes/{quizId} - Delete a quiz
  • GET /courses/{courseId}/quizzes - List quizzes for a course
  • POST /courses/{courseId}/quizzes - Create a quiz

Questions

  • GET /questions/{questionId} - Get a question
  • PATCH /questions/{questionId} - Update a question
  • DELETE /questions/{questionId} - Delete a question
  • POST /quizzes/{quizId}/questions - Create a question

Chats

  • GET /chats/{chatId} - Get a chat
  • DELETE /chats/{chatId} - Delete a chat
  • GET /chats/{chatId}/messages - List chat messages
  • PATCH /chat/{chatId} - Update a chat title

Messages

  • GET /messages/{messageId} - Get a message
  • POST /chats/{chatId}/messages - Send a message
  • PATCH /messages/{messageId} - Update a message
  • DELETE /messages/{messageId} - Delete a message

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •