Developer Resources

API Documentation

Integrate Studd's question generation capabilities into your own applications.

Getting Started

Studd's API allows you to programmatically generate study questions from your content. Whether you're building an educational platform, creating a study app, or enhancing your e-learning tools, our API makes it easy to integrate powerful question generation.

To use our API, you'll need an API key. Premium plan subscribers automatically receive API access with their subscription.

Ready to get started?

Create a free developer account to experiment with our API in the sandbox environment.

Create Developer Account

Authentication

All API requests require authentication using your API key. Include your API key in the header of each request:

Authorization: Bearer YOUR_API_KEY

Important:

Keep your API key secure and never expose it in client-side code. Always make API calls from your server.

Endpoints

POST/api/v1/generate-questions

Generate study questions from text content or uploaded files.

Request Body

{
  "content": "string",       // Optional: Text content to generate questions from
  "fileUrl": "string",       // Optional: URL to a PDF, image, or document
  "questionTypes": [         // Required: Array of question types to generate
    "recall",                // Basic recall questions
    "comprehension",         // Understanding and concept questions
    "application"            // Applied knowledge questions
  ],
  "count": 10,               // Optional: Number of questions to generate (default: 5)
  "difficulty": "medium"     // Optional: "easy", "medium", or "hard" (default: "medium")
}

Response

{
  "success": true,
  "data": {
    "questions": [
      {
        "id": "q_123abc",
        "type": "recall",
        "question": "What are the three branches of government in the United States?",
        "answer": "Executive, Legislative, and Judicial",
        "difficulty": "medium"
      },
      // ... more questions
    ]
  }
}
GET/api/v1/questions

Retrieve questions previously generated by the user.

Query Parameters

limit: number          // Optional: Number of questions to return (default: 20)
offset: number         // Optional: Pagination offset (default: 0)
type: string           // Optional: Filter by question type
difficulty: string     // Optional: Filter by difficulty

Response

{
  "success": true,
  "data": {
    "questions": [
      // ... array of question objects
    ],
    "pagination": {
      "total": 50,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

Need Help?

If you need assistance integrating our API or have any questions, our developer support team is here to help.

Contact Developer Support