Quizb AI Question Generation API Documentation

Note: Default API limit is 10 QPS

Request Authentication

Each API request to Quizb AI requires authentication. The user needs to generate an access token by using a Secret Key (SK) with a specific method and include it in the request header under the Authorization field, formatted as follows:

Authorization: <access_token>

1、Obtaining an access_token

Preparation: Obtain the Secret Key (SK)

You need to contact customer service to obtain your Secret Key.

Note: The Secret Key (SK) is highly sensitive and private information. Any leakage could lead to severe consequences, so do not place it directly in client applications.

Get the question generation authorization access_token The generated access_token is valid for a single use and will expire after use.

GET https://aiapi.quizb.ai/api/v2/get-token?secret=sk&count=4&grant_type=gen

Parameter Description:

• secret: Authentication key, i.e., SK
• count: Number of questions to generate
• grant_type: Authorization type, options: gen for question generation, query for query generation interface

Response Example Successful Response:

{
    "access_token":"ACCESS_TOKEN",
    "expires_in":300
}

Error Response:

{"status": "error","errmsg":"invalid appid"}

2、Knowledge Point Generation Endpoint

Request URL:

 https://aiapi.quizb.ai/api/v2/gen-question-by-desc/multiple-types

Example Listener:

let aiServer = new SSE(url, {
    headers: {
        Authorization: 'access_token',
        'Content-Type': 'application/x-www-form-urlencoded'
    },
    payload: 'description="Please generate a multiple-choice question"&language=zh-cn&questions=[{"name":"Multiple Choice","questionType":"multiplechoise","count":1,"dfficulty":"easy"}]',
    method: 'POST'
})

//Streamed response
aiServer.addEventListener('message', function (e) {
    let data = decodeURIComponent(escape(atob(e.data)))
    console.log(data)
}）

// End of stream
aiServer.addEventListener('generate_count', function (e) {
    
})

//Error message
aiServer.addEventListener('error', function (e) {
    let error = JSON.parse((e.data))
    console.log(error)
})

Authorization

Authorization: <access_token>

Payload Parameter Description:

questions Parameter Description: Multiple question types can be passed

Response: Streamed response

3、Content Generation Endpoint

Request URL:

 https://aiapi.quizb.ai/api/v2/gen-question-by-content-direct/multiple-types

Example Listener:

let aiServer = new SSE(url, {
    headers: {
        Authorization: 'access_token',
        'Content-Type': 'application/x-www-form-urlencoded'
    },
    payload: 'content="Please generate a multiple-choice question"&language=zh-cn&questions=[{"name":"Multiple Choice","questionType":"multiplechoise","count":1,"dfficulty":"easy"}]',
    method: 'POST'
})

// Streamed response
aiServer.addEventListener('message', function (e) {
    let data = decodeURIComponent(escape(atob(e.data)))
    console.log(data)
}）

// End of stream
aiServer.addEventListener('generate_count', function (e) {
    
})

// Error message
aiServer.addEventListener('error', function (e) {
    let error = JSON.parse((e.data))
    console.log(error)
})

Authorization:

Authorization: <access_token>

Payload Parameter Description:

questions Parameter Description: Multiple question types can be passed

Response: Streamed response