Quick Start

First, you will need an API key to authenticate your requests. Sign up for a free account, then generate a key from your dashboard.

Use the following curl command to fetch a list of quizzes. Replace YOUR_API_KEY with the key from the previous step.

curl -X GET "https://quizapi.io/api/v1/quizzes?limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

The API returns JSON responses with a consistent structure. Every list endpoint returns a data array and a meta object for pagination.

{
  "success": true,
  "data": [
    {
      "id": "quiz_abc123",
      "title": "JavaScript Fundamentals",
      "description": "Test your knowledge of JS basics",
      "category": "programming",
      "difficulty": "MEDIUM",
      "tags": ["javascript", "web"],
      "questionCount": 10,
      "plays": 1250
    }
  ],
  "meta": {
    "total": 42,
    "limit": 5,
    "offset": 0
  }
}

The full API is described as an OpenAPI 3.1 specification. Import it into Postman, generate client SDKs, or use it with any OpenAPI-compatible tool.

Official JavaScript/TypeScript and Python SDKs are coming soon. In the meantime, the REST API works with any HTTP client in any language.

Next Steps