Generate Beautiful images of your code!
 - the query for above image
The API supports the following 4 operations
- HTTP Method:
POST/GET - Endpoint:
/api/image - Content Type:
image/png
Query Parameters
| Parameter | Type | Required | Description | Possible Values | Example |
|---|---|---|---|---|---|
| code | string | true | Sets the code. Not needed if gistId is provided. | Any string | var a = 69; |
| gistId | string | false | Gist ID of code. | Valid Gist ID | e6cdcb6198546f324adca0995b191649 |
| theme | string | true | Sets the prismjs theme | get the /api/themes endpoint for all possible values | a11y-dark |
| language | string | true | Sets the programming language | get the /api/languages endpoint for all possible values | javascript |
| lineNumbers | boolean | false | Shows the line numbers on the side | true/false | true |
| scaleFactor | integer | false | Controls the scale/size of the image | 1-5 | 2 |
| width | integer | false | Sets the width of the image | any value in pixels | 500 |
| backgroundColor | string | false | Sets the background color of the image | valid CSS color | green |
| backgroundImage | string | false | Sets the background Image of the image | valid URL to image | https://picsum.photos/1920/1080 |
| showBackground | boolean | false | Controls whether to show or hide background | true/false | true |
| hideButtons | boolean | false | Controls whether to show or hide buttons | true/false | true |
| padding | integer | false | controls the size of padding around the image. | 0-10 | 5 |
Description: Given a code snippet in the request body, an image will be returned with the specified theme and language options.
- HTTP Method:
GET - Endpoint:
/api/themes - Response Content Type:
application/json
Description: Get a list of all supported themes.
- HTTP Method:
GET - Endpoint:
/api/languages - Response Content Type:
application/json
Description: Get a list of all supported languages.