Get up and running with auto generated documentation for code

Integrate Mintlify into your app in just a few minutes! Adding adding

Request an API key

In order to access the Mintlify API, you have to first register for a key by submitting the following form

Request the API key from your email

Open the email account that you used to register in the form. You should see an email with the Mintlify API Key (might take a minute to show up in your inbox)

📘

The key will look something like 7bc8epa7-e4b3-4bfa-bc25-668e19cba091

Copy the key. You will use it to make calls to the Mintlify API

Make your first request

Paste the following code into your console. Make sure to replace {{ API_KEY }} with the key you copied

curl --request POST \
     --url https://api.mintlify.com/v1/generate \
     --header 'key: {{ API_KEY }}' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{
     "commented": false,
     "language": "python",
     "code": "def hello(message): print(message) return True"
     }'

Voila! You should get the following response 🎉

{
  "success": true,
  "document": "Prints a message and returns True. :param message: The message to print :return: True"
}