Presentations
Endpoints for Presentations
ℹ️
An apiKey is required to use these endpoints. See Authentication
Generate new presentation
[POST] https://api.presentationgpt.com/presentations (opens in a new tab)
curl --location 'https://api.presentationgpt.com/presentations' \
--header 'X-Api-Key: {your_api_key}' \
--header 'Content-Type: application/json' \
--data '{
"themeColor": "white",
"userInput": "secret internal memos leaked"
}'
Data props
Name | Values | Required | Notes | |
---|---|---|---|---|
themeColor | `white` or `blue` | true | ||
userInput | string | Either both `title` & `slides` or `userInput` must be included. | ||
backgroundImageUrl | string | |||
slides | Slide[] | Either both `title` & `slides` or `userInput` must be included. |
Response body
{
"id": "string",
"title": "string",
"themeColor": "white | black",
"backgroundImageUrl": "string",
"model": "string",
"isGenerated": "boolean",
"previewImage": "string",
"userId": "string",
"createdAt": "string",
"links": {
"web": "string",
// -- Only included on paid api plans
"pptxUrl": "string",
"pdfUrl": "string",
"googleSlideUrl": "string",
// --
},
"apiKey": "string"
}
Get presentation by id
[GET] https://api.presentationgpt.com/presentations/{id} (opens in a new tab)
curl --location 'https://api.presentationgpt.com/presentations/{id}' \
--header 'X-Api-Key: {your_api_key}'
Response body
{
"id": "string",
"title": "string",
"themeColor": "white | black",
"backgroundImageUrl": "string",
"model": "string",
"isGenerated": "boolean",
"previewImage": "string",
"userId": "string",
"createdAt": "string",
"links": {
"web": "string",
// -- Only included on paid api plans
"pptxUrl": "string",
"pdfUrl": "string",
"googleSlideUrl": "string",
// --
},
"apiKey": "string"
}
List many presentations
[GET] https://api.presentationgpt.com/presentations?limit=10&offset=0 (opens in a new tab)
curl --location --request GET 'https://api.presentationgpt.com/presentations?limit=10&offset=0' \
--header 'X-Api-Key: {your_api_key}' \
--header 'Content-Type: application/json'
Response body
{
"limit": "number",
"offset": "number",
"data": [{
"id": "string",
"title": "string",
"themeColor": "white | black",
"backgroundImageUrl": "string",
"model": "string",
"isGenerated": "boolean",
"previewImage": "string",
"userId": "string",
"createdAt": "string",
"links": {
"web": "string",
// -- Only included on paid api plans
"pptxUrl": "string",
"pdfUrl": "string",
"googleSlideUrl": "string",
// --
},
"apiKey": "string"
}]
}