Skip to main content
POST
/
api
/
v1
/
renders
Create a render job
curl --request POST \
  --url https://quizquail.com/api/v1/renders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quiz_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "format": "<string>",
  "resolution": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quiz_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "output_url": "<string>",
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.quiz-quail.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key authentication. Prefix your key with Bearer in the Authorization header.

Keys follow the format qq_... and can be scoped to specific permissions.

Body

application/json
quiz_id
string<uuid>
required

ID of the quiz to render

format
string

Output format (default: mp4)

resolution
string

Output resolution (default: 1080p)

Response

Render job accepted

data
object
required