Quiz API is a powerful, developer-friendly solution designed to seamlessly integrate quiz functionality into any application, regardless of its domain. Whether you're building an educational platform, a gaming app, or a corporate training tool, Quiz API simplifies the process of managing quizzes and questions, so you can focus on delivering value to your users.
\n🚀 Flexible Integration: Designed to adapt to any application or workflow.
\n🛠️ Comprehensive Features: Manage users, questions, and quizzes effortlessly.
\n🔒 Secure: Built with robust authentication and token-based access.
\n🎯 Customizable: Add questions with categories, difficulties, and types to suit your specific needs.
\nSecure Authentication
\nQuiz Management
\nQuestion Types
\nQuiz Attempts and Scoring
\nFiltering and Customization
\nDetailed Analytics
\nError Handling
\nBase URL: https://quizapi.up.railway.app/v1
Authentication:
\nNot All endpoints require a token (Each endpoint have it documented).
\nInclude it in the Authorization header as:
token: YOUR_API_TOKEN
GET /questions/: https://quizapi.up.railway.app/v1
\n| ID | \r","Title | \r","Description | \r","Created At | \r","Updated At | \r","
|---|---|---|---|---|
| {{id}} | \r","{{title}} | \r","{{description}} | \r","{{created_at}} | \r","{{updated_at}} | \r","
This endpoint is used to register a new user.
\nemail (text, required): The email of the user.
\npassword (text, required): The password for the user account.
\npassword_confirm (text, required): The confirmation of the password.
\nis_creator (text, required): Indicates if the user is a creator.
\nis_admin (text, required): Indicates if the user is an admin.
\nThe response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\"type\": \"string\"},\n \"token\": {\"type\": \"string\"},\n \"user\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"},\n \"email\": {\"type\": \"string\"},\n \"is_creator\": {\"type\": \"boolean\"},\n \"number_of_created_quizzes\": {\"type\": \"integer\"},\n \"number_of_created_questions\": {\"type\": \"integer\"}\n }\n }\n }\n}\n\nThe response will include a message, a token that will be used in future requests, and user details such as user ID, email, creator status, and the number of quizzes and questions created by the user.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"This endpoint is used primiraly to get the token for a user.
\nemail (text, required): The email of the user.
\npassword (text, required): The password of the user.
\nrefresh_token (boolean, optional): when provided and the value is true, the token will be updated. This is used if you suspect your token was stolen and someone else is using it.
\nThe response is in JSON format with the following schema:
\n{\n \"user\": {\n \"id\": 0,\n \"email\": \"\",\n \"is_creator\": true\n },\n \"token\": \"\"\n}\n\nuser (object):
\nid (number): The user ID.
\nemail (string): The email of the user.
\nis_creator (boolean): Indicates if the user is a creator.
\ntoken (string): The authentication token.
\nThis endpoint retrieves the information of the user.
\nThere are no request parameters for this endpoint.
\nThe response will be in JSON format and will have the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"is_creator\": {\n \"type\": \"boolean\"\n },\n \"number_of_created_quizzes\": {\n \"type\": \"integer\"\n },\n \"number_of_created_questions\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThis endpoint allows users to change their password.
\nemail (text): The email address of the user.
old_password (text): The user's current password.
new_password (text): The new password to be set.
The user also has to send the token in the header.
\nThe response is in JSON format with the following schema:
\n{\n \"message\": \"\"\n}\n\nmessage (string): A message indicating the result of the password change operation.This endpoint retrieves the created quizzes for the user that is associated with the token.
\nNo request body for this endpoint.
\nThe response will be a JSON array containing the details of the created quizzes. Each quiz object will have the following properties:
\nid (number): The unique identifier of the quiz.
title (string): The title of the quiz.
description (string): The description of the quiz.
category (object): The category of the quiz with properties id (number), name (string), and slug (string).
number_of_questions (number): The total number of questions in the quiz.
questions (array): An array of question objects, each with properties:
id (number): The unique identifier of the question.
text (string): The text of the question.
question_type (string): The type of the question.
choices (array): An array of choices for the question.
matching_pairs (array): An array of matching pairs for the question.
ordering_items (array): An array of ordering items for the question.
tf_correct_answer (boolean): The correct answer for True/False type questions.
category (object): The category of the question with properties id (number), name (string), and slug (string).
explanation (string): The explanation for the question.
difficulty (string): The difficulty level of the question.
Example response:
\n[\n {\n \"id\": 0,\n \"title\": \"\",\n \"description\": \"\",\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"number_of_questions\": 0,\n \"questions\": [\n {\n \"id\": 0,\n \"text\": \"\",\n \"question_type\": \"\",\n \"choices\": [],\n \"matching_pairs\": [],\n \"ordering_items\": [],\n \"tf_correct_answer\": true,\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"explanation\": \"\",\n \"difficulty\": \"\"\n }\n ]\n }\n]\n\nThis folder contains endpoints related to user management and user-specific operations. These endpoints provide functionality for user authentication, profile management, and retrieving user-related data.
\nAll endpoints in this folder are prefixed with /v1/users/.
register/ - Handles user registration.
login/ - Allows users to log in and obtain authentication tokens.
change_password/ - Enables users to update their passwords.
change_role/ - Enables users to change their role.
profile/ - Provides access to the user’s profile information.
creations/ - Returns quizzes and questions created by the user.
makefileCopy code token:
\nResponse Format:
Responses are provided in JSON format. Each endpoint includes both success and error responses with detailed messages and relevant HTTP status codes.
Error Handling:
Common errors include:
401 Unauthorized: When the token is invalid or missing.
\n400 Bad Request: When required fields are missing or invalid.
\n404 Not Found: When the requested resource does not exist.
\nregister/
Registers a new user by accepting their details (e.g., username, email, password).
\nMethod: POST
\nAuthentication: Not required.
\nlogin/
Authenticates the user and provides an API token.
\nMethod: POST
\nAuthentication: Not required.
\nchange_password/
Allows users to update their password.
\nMethod: POST
\nAuthentication: Required (via token header).
profile/
Retrieves the user’s profile information.
\nMethod: GET
\nAuthentication: Required (via token header).
created_quizzes/
Returns a list of quizzes created by the authenticated user.
\nMethod: GET
\nAuthentication: Required (via token header).
created_questions/
Returns a list of questions created by the authenticated user.
\nMethod: GET
\nAuthentication: Required (via token header).
Token Management:
Ensure the token is stored securely and included in every authenticated request.
Data Validation:
Include all required fields in the request payload to avoid validation errors.
API Limits:
Avoid sending large payloads or making excessive requests in a short period for optimal performance.
Versioning:
This API follows versioning (e.g., /v1/users/), ensuring backward compatibility as updates are introduced.
This endpoint allows you to create a new question with the specified details.
\ntext (string, required): The text of the question.
\nquestion_type (string, required): The type of question (e.g., MC for multiple choice).
\nchoices (array, required): An array of choices for the question, each containing text and is_correct fields.
\ncategory (string, required): The category of the question.
\nexplanation (string, required): Explanation for the question.
\ndifficulty (string, required): The difficulty level of the question.
\nExample:
\n{\n \"text\": \"How can you optimize garbage collection in Node.js?\",\n \"question_type\": \"MC\",\n \"choices\": [\n {\n \"text\": \"Adjust the V8 heap size using flags\",\n \"is_correct\": true\n }\n ],\n \"category\": \"nodejs\",\n \"explanation\": \"You can optimize garbage collection by adjusting the V8 heap size.\",\n \"difficulty\": \"Hard\"\n}\n\nid (integer): The ID of the created question.
\ntext (string): The text of the question.
\nquestion_type (string): The type of question.
\nchoices (array): An array of choices for the question, each containing text and is_correct fields.
\nmatching_pairs (array): An array of matching pairs for the question.
\nordering_items (array): An array of ordering items for the question.
\ntf_correct_answer (boolean): Indicates if the true/false question has a correct answer.
\ncategory (object): The category of the question, containing id, name, and slug fields.
\nexplanation (string): Explanation for the question.
\ndifficulty (string): The difficulty level of the question.
\nExample:
\n{\n \"id\": 0,\n \"text\": \"\",\n \"question_type\": \"\",\n \"choices\": [\n {\n \"text\": \"\",\n \"is_correct\": true\n }\n ],\n \"matching_pairs\": [],\n \"ordering_items\": [],\n \"tf_correct_answer\": true,\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"explanation\": \"\",\n \"difficulty\": \"\"\n}\n\nThis endpoint allows you to create a new question. The request should be sent as an HTTP POST to https://quizapi.up.railway.app/v1/questions/create/.
\ntext (text): The text of the question.
question_type (text): The type of the question (e.g., MC for multiple choice).
choices (array): An array of choices for the question, each containing:
text (text): The text of the choice.
is_correct (boolean): Indicates if the choice is correct.
category (text): The category of the question.
explanation (text): An explanation for the question (optional).
difficulty (text): The difficulty level of the question.
The API responds with a status code of 201 and a JSON object with the information of the newly created question.
\nIn case of an error, The API responds with a status code of 400 and a JSON object with a detail key, which may contain additional information about the error.
This endpoint allows you to create a new question.
\nPOST /questions/create/
text (string) : The text of the question.
question_type (string) : The type of question.
ordering_items (array) : An array of objects containing the steps to be ordered.
text (string) : The text of the step.
order (integer) : The order of the step.
category (string) : The category of the question.
The response will contain the details of the newly created question.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"integer\" },\n \"text\": { \"type\": \"string\" },\n \"question_type\": { \"type\": \"string\" },\n \"choices\": { \"type\": \"array\" },\n \"matching_pairs\": { \"type\": \"array\" },\n \"ordering_items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"text\": { \"type\": \"string\" },\n \"order\": { \"type\": \"integer\" }\n }\n }\n },\n \"tf_correct_answer\": { \"type\": \"boolean\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"integer\" },\n \"name\": { \"type\": \"string\" },\n \"slug\": { \"type\": \"string\" }\n }\n },\n \"explanation\": { \"type\": [\"string\", \"null\"] },\n \"difficulty\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint allows you to create a new question.
\ntext (string, required): The text of the question.
\nquestion_type (string, required): The type of the question.
\nmatching_pairs (array, required): An array of matching pairs for the question.
\nitem (string): The item in the matching pair.
\nmatch (string): The matching item in the pair.
\ncategory (string, required): The category of the question.
\ndifficulty (string, required): The difficulty level of the question.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"},\n \"text\": {\"type\": \"string\"},\n \"question_type\": {\"type\": \"string\"},\n \"choices\": {\"type\": \"array\"},\n \"matching_pairs\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\"type\": \"string\"},\n \"match\": {\"type\": \"string\"}\n }\n }\n },\n \"ordering_items\": {\"type\": \"array\"},\n \"tf_correct_answer\": {\"type\": \"boolean\"},\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"},\n \"name\": {\"type\": \"string\"},\n \"slug\": {\"type\": \"string\"}\n }\n },\n \"explanation\": {\"type\": \"string\"},\n \"difficulty\": {\"type\": \"string\"}\n }\n}\n\nThis endpoint allows the user to create a new question with the specified details.
\ntext (string): The text of the question.
question_type (string): The type of the question (e.g., TF for True/False).
tf_correct_answer (boolean): The correct answer for True/False question.
category (integer): The category ID for the question.
explanation (string): Explanation for the question.
The response will be in JSON format and will include the following fields:
\n{\n \"id\": 0,\n \"text\": \"\",\n \"question_type\": \"\",\n \"choices\": [],\n \"matching_pairs\": [],\n \"ordering_items\": [],\n \"tf_correct_answer\": true,\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"explanation\": \"\",\n \"difficulty\": \"\"\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"},\n \"text\": {\"type\": \"string\"},\n \"question_type\": {\"type\": \"string\"},\n \"choices\": {\"type\": \"array\"},\n \"matching_pairs\": {\"type\": \"array\"},\n \"ordering_items\": {\"type\": \"array\"},\n \"tf_correct_answer\": {\"type\": \"boolean\"},\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"},\n \"name\": {\"type\": \"string\"},\n \"slug\": {\"type\": \"string\"}\n }\n },\n \"explanation\": {\"type\": \"string\"},\n \"difficulty\": {\"type\": \"string\"}\n }\n}\n\nHere, we're creating a question but the category is missing.
\nRequest Body
\ntext (string, required): The text of the question.
question_type (string, required): The type of question.
ordering_items (array, required): An array of objects containing the text and order of the ordering items.
Response
\n{\n \"type\": \"object\",\n \"properties\": {\n \"non_field_errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n}\n\nThe response returns a JSON object with a property non_field_errors which is an array of strings. This property is used to indicate any non-field related errors that occurred during the request processing.
difficulty (will have a \"not rated\" value)
\nThe answers for the types not in use.
\nFor example, when creating an mcq question, what will not be requried is:
\nordering_items
\nmatching_pairs
\ntf_correct_answer
\nSame for other cases.
\nThis endpoint retrieves details of a specific question based on the provided question ID.
\nMethod: GET
\nURL: https://quizapi.up.railway.app/v1/questions/question_id/
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"integer\" },\n \"text\": { \"type\": \"string\" },\n \"question_type\": { \"type\": \"string\" },\n \"choices\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"text\": { \"type\": \"string\" },\n \"is_correct\": { \"type\": \"boolean\" }\n }\n }\n },\n \"matching_pairs\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"object\" }\n },\n \"ordering_items\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"object\" }\n },\n \"tf_correct_answer\": { \"type\": \"boolean\" },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"integer\" },\n \"name\": { \"type\": \"string\" },\n \"slug\": { \"type\": \"string\" }\n }\n },\n \"explanation\": { \"type\": \"string\" },\n \"difficulty\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint is used to update a specific question.
\ntext (string, required): The updated text for the question.
\nquestion_type (string, required): The type of question.
\nchoices (array, required): An array of choices for the question, each containing:
\ntext (string, required): The text for the choice.
\nis_correct (boolean, required): Indicates if the choice is correct.
\ncategory (integer, required): The updated category for the question.
\nexplanation (string, required): The explanation for the question.
\ndifficulty (string, required): The updated difficulty level for the question.
\nThe response will be a JSON object with the following schema:
\n{\n \"id\": integer,\n \"text\": string,\n \"question_type\": string,\n \"choices\": [\n {\n \"text\": string,\n \"is_correct\": boolean\n }\n ],\n \"matching_pairs\": array,\n \"ordering_items\": array,\n \"tf_correct_answer\": boolean,\n \"category\": {\n \"id\": integer,\n \"name\": string,\n \"slug\": string\n },\n \"explanation\": string,\n \"difficulty\": string\n}\n\nThis endpoint is used to delete a specific question.
\nThis request does not require a request body.
\nStatus: 204
\nContent-Type: application/json
\n{ \"detail\": \"\"}
The response will include a JSON object with a \"detail\" key, which may contain a message confirming the successful deletion.
This endpoint retrieves a list of questions based on the specified parameters.
\nMethod: GET
\nURL: https://quizapi.up.railway.app/v1/questions/
\nQuery Parameters:
\nlimit (integer, optional): The maximum number of questions to retrieve. Must be between 1 and 100. Default is 25.
\ntype (string, optional): The type of question (e.g., MC for multiple choice).
\nordering (string, optional): The ordering of questions.
\ndifficulty (string, optional): Specify the difficulty wanted (e.g., Medium)
\ncategory (integer or string, optional): Specify the category wanted (e.g., Django for Django related questions.
\nThe response is a JSON array containing question objects with the following schema:
\n[\n {\n \"id\": \"integer\",\n \"text\": \"string\",\n \"question_type\": \"string\",\n \"choices\": [\n {\n \"text\": \"string\",\n \"is_correct\": \"boolean\"\n }\n ],\n \"matching_pairs\": \"array\",\n \"ordering_items\": \"array\",\n \"tf_correct_answer\": \"boolean\",\n \"category\": {\n \"id\": \"integer\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n \"explanation\": \"string\",\n \"difficulty\": \"string\"\n }\n]\n\nid (integer): The unique identifier of the question.
\ntext (string): The text of the question.
\nquestion_type (string): The type of the question.
\nchoices (array): An array of objects representing the choices for the question, where each object contains the text of the choice and a boolean indicating if it is correct.
\nmatching_pairs (array): An array of matching pairs for the question.
\nordering_items (array): An array of ordering items for the question.
\ntf_correct_answer (boolean): A boolean indicating the correctness of the true/false question.
\ncategory (object): An object containing the category details of the question, including id, name, and slug.
\nexplanation (string): The explanation or solution for the question.
\ndifficulty (string): The difficulty level of the question.
\n[\n {\n \"id\": 0,\n \"text\": \"\",\n \"question_type\": \"\",\n \"choices\": [\n {\n \"text\": \"\",\n \"is_correct\": true\n }\n ],\n \"matching_pairs\": [],\n \"ordering_items\": [],\n \"tf_correct_answer\": true,\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"explanation\": \"\",\n \"difficulty\": \"\"\n }\n]\n\nThis folder includes endpoints to manage, retrieve, and create questions. It supports different question types, difficulty levels, and optional quiz association.
\nAll endpoints in this folder are prefixed with /v1/questions/.
/ - Filters and retrieves questions based on specified criteria.
create/ - Creates a new question.
question_id/ - Fetches, updates, or deletes a specific question by ID.
Authentication:
\nRequired for all endpoints except /
token:
\nResponse Format:
\nError Handling:
\n401 Unauthorized: Token is missing or invalid.
\n400 Bad Request: Required fields are missing or invalid.
\n404 Not Found: The requested resource does not exist.
\nThe following types of questions are supported:
\nMultiple Choice (MC): Questions with multiple answer options where one or more may be correct.
\nTrue/False (TF): Questions with a binary answer choice (true/false).
\nMatching (MT): Questions requiring matching between sets of items.
\nOrdering (OR): Questions where the correct order of items must be provided.
\nQuestions can be assigned a difficulty level using the following choices:
\n0: Not rated (default)
\n1: Easy
\n2: Medium
\n3: Hard
\nWhen creating or updating a question, you can optionally include a quizzes key. This key accepts a list of IDs corresponding to quizzes that the question should be associated with. Example:
jsonCopy code{\n ...\n \"quizzes\": [1, 2, 3],\n ...\n}\n\n/
Retrieves a list of questions based on query parameters filters (e.g., type, difficulty).
\nMethod: GET
\nAuthentication: Not required.
\ncreate/
Creates a new question. Requires fields like text, type, and difficulty.
Optional quizzes field allows associating the question with specific quizzes.
Method: POST
\nAuthentication: Required
\nquestion_id/
question_id is an integer representing the id for the question
\nHandles operations for a specific question:
\nGET: Fetches details of a specific question.
\nPUT: Updates details of a specific question (e.g., text, type, difficulty).
\nDELETE: Deletes a specific question.
\nMethods: GET, PUT, DELETE
\nAuthentication: Required
\nToken Management:
Ensure the token is valid and included in the header for authenticated endpoints. Make sure you're only trying to update or delete the question you created.
Question ID:
For endpoints requiring question_id, ensure the ID corresponds to an existing question.
Validation:
Provide valid values for type and difficulty when creating or updating questions to avoid errors.
This endpoint allows you to create a new quiz with a title, description, category, and links a list of questions.
\ntitle (string, required): The title of the quiz.
\ndescription (string, required): A brief description of the quiz.
\ncategory (integer or string, required): The ID of the category for the quiz or the slug for the category.
\nquestions (array of integers, required): An array of question IDs to be included in the quiz.
\nThe response will be a JSON object with the following schema:
\n{\n \"id\": integer,\n \"title\": string,\n \"description\": string,\n \"category\": {\n \"id\": integer,\n \"name\": string,\n \"slug\": string\n },\n \"number_of_questions\": integer,\n \"questions\": [\n {\n \"id\": integer,\n \"text\": string,\n \"question_type\": string,\n \"choices\": array,\n \"matching_pairs\": array,\n \"ordering_items\": array,\n \"tf_correct_answer\": boolean,\n \"category\": {\n \"id\": integer,\n \"name\": string,\n \"slug\": string\n },\n \"explanation\": string,\n \"difficulty\": string\n }\n ]\n}\n\nid (integer): The ID of the created quiz.
\ntitle (string): The title of the quiz.
\ndescription (string): A brief description of the quiz.
\ncategory (object): The category of the quiz with its ID, name, and slug.
\nnumber_of_questions (integer): The total number of questions in the quiz.
\nquestions (array): An array of objects representing the questions included in the quiz, each with its ID, text, question type, choices, matching pairs, ordering items, true/false correct answer, category, explanation, and difficulty.
\nThis endpoint retrieves the details of a specific quiz.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"id\": \"number\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"category\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n \"number_of_questions\": \"number\",\n \"questions\": [\n {\n \"id\": \"number\",\n \"text\": \"string\",\n \"question_type\": \"string\",\n \"choices\": [\"string\"],\n \"matching_pairs\": [\n {\n \"left\": \"string\",\n \"right\": \"string\"\n }\n ],\n \"ordering_items\": [\"string\"],\n \"tf_correct_answer\": \"boolean\",\n \"category\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n \"explanation\": \"string\",\n \"difficulty\": \"string\"\n }\n ]\n}\n\nThis endpoint allows the user to update an existing quiz by sending an HTTP PUT request to the specified URL ending with the id of the quiz.
\ntitle (string): The title of the quiz.
\ndescription (string): A brief description of the quiz.
\ncategory (string): The category of the quiz.
\nquestions (array): An array of question IDs associated with the quiz.
\nImportant note: you can't edit a quiz you didn't create.
\nThe response will be in JSON format and will include the following fields:
\n{\n \"id\": 0,\n \"title\": \"\",\n \"description\": \"\",\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"number_of_questions\": 0,\n \"questions\": [\n {\n \"id\": 0,\n \"text\": \"\",\n \"question_type\": \"\",\n \"choices\": [],\n \"matching_pairs\": [],\n \"ordering_items\": [],\n \"tf_correct_answer\": true,\n \"category\": {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\"\n },\n \"explanation\": \"\",\n \"difficulty\": \"\"\n }\n ]\n}\n\nThe response schema includes fields for the updated quiz, such as the ID, title, description, category, number of questions, and details of the questions associated with the quiz.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"This endpoint is used to delete a specific quiz.
\nImportant note: you can't delete a quiz you didn't create.
\nThis request does not require a request body.
\nStatus: 204
\nContent-Type: application/json
\n{ \"detail\": \"\"}
\nThis endpoint retrieves a list of quizzes based on the specified category and limit (optional).
\ncategory (query parameter): Specifies the category of the quizzes to retrieve.
category can be
\ninteger representing the id of the wanted category
\nstring representing the slug of the wanted category
\nlimit (query parameter): Specifies the maximum number of quizzes to be returned. default is 25.
This request does not contain a request body.
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"slug\": {\n \"type\": \"string\"\n }\n }\n },\n \"number_of_questions\": {\n \"type\": \"number\"\n },\n \"questions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"text\": {\n \"type\": \"string\"\n },\n \"question_type\": {\n \"type\": \"string\"\n },\n \"choices\": {\n \"type\": \"array\"\n },\n \"matching_pairs\": {\n \"type\": \"array\"\n },\n \"ordering_items\": {\n \"type\": \"array\"\n },\n \"tf_correct_answer\": {\n \"type\": \"boolean\"\n },\n \"category\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"slug\": {\n \"type\": \"string\"\n }\n }\n },\n \"explanation\": {\n \"type\": \"string\"\n },\n \"difficulty\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n }\n}\n\nThis folder contains endpoints for managing quizzes, retrieving quiz data, and accessing random quizzes. These endpoints are designed to handle both user-generated quizzes and general quiz-related functionalities.
\nAll endpoints in this folder are prefixed with /v1/quizzes/.
/ - Retrieves a filtered list of quizzes.
create/ - Allows authenticated users to create a new quiz.
quiz_id/ - Fetches, updates, or deletes a specific quiz based on its ID.
Response Format:
Responses are provided in JSON format. Each endpoint includes both success and error responses with detailed messages and relevant HTTP status codes.
Error Handling:
Common errors include:
401 Unauthorized: When the token is invalid or missing.
\n400 Bad Request: When required fields are missing or invalid.
\n404 Not Found: When the requested resource does not exist.
\n/
Retrieves a list of quizzes based on filters (e.g., category, difficulty).
\nMethod: GET
\nAuthentication: Not required.
\ncreate/
Allows users to create a new quiz by providing necessary details such as title, category, and questions.
\nMethod: POST
\nAuthentication: Required (via token header).
quiz_id/
Handles operations for a specific quiz (replace the word quiz_id with the actual id).
\nGET: Fetches the details of a specific quiz.
\nPUT: Updates the details of a specific quiz.
\nDELETE: Deletes a specific quiz.
\nMethods: GET, PUT, DELETE
\nAuthentication: Required (via token header).
Token Management:
For authenticated endpoints, ensure the token is valid and included in the request header.
Quiz ID Requirements:
For endpoints requiring quiz_id, ensure the ID corresponds to an existing quiz.
Data Validation:
Provide all required fields when creating or updating quizzes to avoid validation errors.
This endpoint retrieves a list of available categories.
\nMethod: GET
\nURL: https://quizapi.up.railway.app/v1/categories/
Status: 200
\nContent-Type: application/json
\nExample response body:
\n[\n {\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"number_of_questions\": 0,\n \"number_of_quizzes\": 0\n }\n]\n\nThis endpoint makes an HTTP GET request to retrieve the details of the category. you can replace nodejs with the id or the slug of any available category.
\nNo request body is required for this endpoint.
\nURL
\nhttps://quizapi.up.railway.app/v1/categories/category/The response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"slug\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"number_of_questions\": {\n \"type\": \"integer\"\n },\n \"number_of_quizzes\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThe response will include the following fields:
\nid (integer): The unique identifier of the category.
name (string): The name of the category.
slug (string): The slug of the category.
description (string): The description of the category.
number_of_questions (integer): The number of questions in the category.
number_of_quizzes (integer): The number of quizzes in the category.
This endpoint allows the creation of a new category.
\nname (string - mandatory): The name of the new category.
description (string - mandatory): A description for the new category.
Upon successful creation, the server responds with a status code of 201 and a JSON object containing the details of the newly created category, including:
\nid (integer): The unique identifier for the category.
name (string): The name of the category.
slug (string): The slug for the category.
description (string): The description of the category.
number_of_questions (integer): The number of questions in the category.
number_of_quizzes (integer): The number of quizzes in the category.
Example response:
\n{\n \"id\": 0,\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"number_of_questions\": 0,\n \"number_of_quizzes\": 0\n}\n\nThis endpoint is used to update the details of a specific category.
\nname (text, required): The updated name of the category.
\nslug (text, shown as an example, not required).
\ndescription (text, required): The updated description of the category.
\nThe response body follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"slug\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"number_of_questions\": {\n \"type\": \"integer\"\n },\n \"number_of_quizzes\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThe response returns the updated details of the category, including the category ID, name, slug, description, number of questions, and number of quizzes.
\n","urlObject":{"path":["categories","my-brand-new-category-8",""],"host":["https://quizapi.up.railway.app/v1"],"query":[],"variable":[]}},"response":[{"id":"8a8e31de-0d2e-4dfd-98f1-e7a9b6469c86","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"I changed my mind\",\r\n \"slug\": \"trying to change the slug\",\r\n \"description\": \"This is an attempt to test my endpoint.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://quizapi.up.railway.app/v1/categories/9/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 10:23:12 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.12.2"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"165"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10,\n \"name\": \"I changed my mind\",\n \"slug\": \"i-changed-my-mind\",\n \"description\": \"This is an attempt to test my endpoint.\",\n \"number_of_questions\": 0,\n \"number_of_quizzes\": 0\n}"}],"_postman_id":"c556460e-0554-4b5c-94dc-8f48c971401b"},{"name":"Delete a Category","id":"cc599ab0-ebce-46c5-95c4-944ddf74461a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":"The API endpoint sends an HTTP DELETE request to delete the category with the ID 9 or any other identifier. Upon successful deletion, the server returns a 204 status code with an empty JSON response body containing the key \"detail\". Below is the JSON schema for the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"detail\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\"detail\"]\n}\n\nThis folder provides endpoints to manage and retrieve information about categories, quizzes, and questions associated with specific categories.
\nAll endpoints in this folder are prefixed with /v1/categories/.
Authentication:
All endpoints require authentication. Include the token in the request header:
token: <your-api-token>\n\nResponse Format:
All responses are in JSON format, providing details about success or failure with appropriate HTTP status codes.
Error Handling:
\n401 Unauthorized: Token is missing or invalid.
\n404 Not Found: The requested resource does not exist.
\n400 Bad Request: Invalid data or malformed request.
\n/
Retrieves a list of all categories.
\nMethod: GET
\n/create/
Creates a new category.
\nMethod: POST
\nAuthentication: Required (with Admin role)
\n/
Retrieves, updates, or deletes a specific category by its identifier.
\nMethods:
\nGET: Retrieve details of a category.
\nPUT: Update the category's information (Authentication required).
\nDELETE: Delete the category (Authentication required).
\n404 Not Found error will be returned.The request body for /create/ should include:
{\n \"name\": \"string\",\n \"description\": \"string (optional)\"\n }\n\nThe request body for updating a category (PUT /) should include:
{\n \"name\": \"string (optional)\",\n \"description\": \"string (optional)\"\n }\n\n/quizzes/ and /questions/), use the parameter to limit the number of results retrieved.GET /v1/categories/\nHeaders:\ntoken: <your-api-token>\n\nPOST /v1/categories/create/\nHeaders:\ntoken: <your-api-token>\nBody:\n{\n \"name\": \"Science\",\n \"description\": \"Category for science-related quizzes and questions\"\n}\n\nPUT /v1/categories/technology/\nHeaders:\ntoken: <your-api-token>\nBody:\n{\n \"description\": \"Updated description for the technology category\"\n}\n\nGET /v1/categories/science/quizzes/\nHeaders:\ntoken: <your-api-token>\n\nGET /v1/categories/math/questions/5/\nHeaders:\ntoken: <your-api-token>\n\nDELETE /v1/categories/science/\nHeaders:\ntoken: <your-api-token>\n\nThese endpoints allows users to interact with quiz attempts, including creating, retrieving, and viewing attempts for quizzes. This documentation provides details for endpoints to handle:
\nStarting a quiz and submitting answers.
\nViewing the current user's quiz attempts.
\nViewing attempts by other users for a specific quiz.
\nGET /attempts/)Description: Retrieve all quiz attempts made by the currently authenticated user.
\nQuery Parameters:
\nquiz_id (optional): Retrieve attempts for a specific quiz only.Response:
\nAuthentication: Required.
\nGET /attempts//)Description: Retrieve the quiz questions without answers.
\nPath Parameters:
\nquiz_id (required): The ID of the quiz to retrieve.Response:
\nAuthentication: Required.
\nPOST /attempts//submit/)Description: Submit a new quiz attempt, including user answers for each question.
\nPath Parameters:
\nquiz_id (required): The ID of the quiz being attempted.{ \"answers\": [ {\"question\": 1, \"answer\": \"Sample Answer\"}, {\"question\": 2, \"answer\": \"True\"} ]}
\nResponse:
\nAuthentication: Required.
\nGET /attempts//others/)Description: Retrieve attempts made by other users for a specific quiz.
\nPath Parameters:
\nquiz_id (required): The ID of the quiz to retrieve attempts for.Response:
\nAuthentication: Required. You have to be the creator of the quiz.
\nRequest:
\nPOST /attempts/1/submit/\ntoken: <TOKEN>\nContent-Type: application/json\n{\n \"answers\": [\n {\"question\": 1, \"answer\": \"Option A\"},\n {\"question\": 2, \"answer\": \"True\"}\n ]\n}\n\nResponse:
\n{\n \"message\": \"Quiz attempt recorded successfully.\",\n \"data\": {\n \"attempt\": 42,\n \"user\": 1,\n \"quiz\": 1,\n \"total_questions\": 5,\n \"total_questions_answered\": 5,\n \"total_correct\": 4,\n \"user_score\": 4,\n \"max_score\": 5\n }\n}\n\nRequest:
\nGET /attempts/?quiz_id=1\ntoken: <TOKEN>\n\nResponse:
\n[\n {\n \"attempt\": 42,\n \"user\": 1,\n \"quiz\": 1,\n \"total_questions\": 5,\n \"total_questions_answered\": 5,\n \"total_correct\": 4,\n \"user_score\": 4,\n \"max_score\": 5\n }\n]\n\n