API Reference

An overview of all available API endpoints

Not sure where to start? Check out the quickstart section to get up and running with the API in minutes.

Prefer using Postman? Check out our Postman collection.

Generate Presentation

Generate a presentation from plain text.

POSThttps://api.slidespeak.co/api/v1/presentation/generate

Authorization

APIKeyHeader

Body

application/json

plain_text*string

lengthnullable integer

themenullable string

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.slidespeak.co/api/v1/presentation/generate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "plain_text": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get Status

Retrieve the status of a task by its ID.

GEThttps://api.slidespeak.co/api/v1/task_status/{task_id}

Authorization

APIKeyHeader

Path parameters

task_id*string

Response

200422

Successful Response

Body

application/json

task_id*string

task_status*TaskState (enum)

FAILUREPENDINGRECEIVEDRETRYREVOKEDSTARTEDSUCCESS

task_resultnullable object

task_infoTaskProgress (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.slidespeak.co/api/v1/task_status/{task_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "task_id": "text",
  "task_status": "FAILURE",
  "task_info": {
    "progress": 0,
    "start_time": 0,
    "update_time": 0,
    "max_duration": 0
  }
}

Get All Themes

Get a list of available presentation themes including preview image urls.

GEThttps://api.slidespeak.co/api/v1/presentation/themes

Authorization

APIKeyHeader

Response

200

Successful Response

Body

application/json

Response Get Presentation Themes Endpoint Api V1 Presentation Themes Get

Request

JavaScriptCurlPython

const response = await fetch('https://api.slidespeak.co/api/v1/presentation/themes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Edit Pptx

Edit a PPTX file with the given content.

POSThttps://api.slidespeak.co/api/v1/presentation/edit

Authorization

APIKeyHeader

Body

multipart/form-data

pptx_file*Pptx File

config*Config

Configuration for the pptx_fill service.

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.slidespeak.co/api/v1/presentation/edit', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "pptx_file": "binary",
      "config": {
        "replacements": [
          {
            "shape_name": "text",
            "content": "text"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}