Getting started

You can use the Riddle Generative AI API to generate Riddles, populated with content from generative AI models.

Providing context

Generally there are two approaches you can take for providing context / content:

  1. Topic: Supply a topic or theme for the Riddle, e.g. 'Soccer', 'Harry Potter'
  2. URL: Provide a URL to a website, blog or article that contains the content you want to use for the Riddle.

Asynchronous generation

The Riddle AI generation happens asynchronously, meaning the Riddle will be generated in the background and the Riddle will not be visible in the Creator / on the landing page yet.

The API only returns an UUID and the requested Riddle type:

{
    "UUID": "as12Dcs",
    "type": "Quiz"
}

Tip: You can save this UUID to your database, for example to later call the API to analyse the Riddle's stats or leads. Additionally, you can specify a callback URL to receive a webhook when the Riddle is ready to use.

API limits and usage

The generative AI API has strict limits per month, differentiated for each plan:

  • Basic: 5 calls/month
  • Pro: 15 calls/month
  • Business: 30 calls/month
  • Enterprise: 50 calls/month

Fetch current usage dynamically

You can check your current usage dynamically by calling the AI usage endpoint. This will return a JSON object with the current usage and limits:

{
    "current": 5,
    "max": 50
}

Note: The returned usage may be multiplied by 12 if your subscription is billed annually. For example, if you are on the Pro plan, the usage will be 15 * 12 = 180.

Next steps

Table of Contents