Get slide preview image

GET

api

templates

{template_id}

slides

{slide_number}

preview

Get slide preview image

curl --request GET \
  --url https://api.example.com/api/v1/templates/{template_id}/slides/{slide_number}/preview \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Production API key. Development/test deployments may also allow X-Org-Name.

Path Parameters

template_id

string

required

slide_number

integer

required

Response

Successful Response

Generate single slide (async)Generate a single slide asynchronously from a template slide and your data. **Workflow:** 1. Upload and analyze a template first (see Templates endpoints) 2. Get the `template_slide_id` from analysis results 3. POST to this endpoint with your slide data 4. Receive `generation_id` immediately (HTTP 202) 5. Poll `GET /presentations/{generation_id}/status` every 2-5 seconds 6. When status is `completed`, download from `download_url` **Table Pagination:** If your slide is table-only and `auto_paginate_tables` is enabled (default), a large table may generate multiple slides. Check `total_pages_generated` in the status response. Slides that combine table and text content should set `auto_paginate_tables` to `false`. **For multiple slides:** Use POST `/presentations/generate-deck` instead.

Get slide preview image

curl --request GET \
  --url https://api.example.com/api/v1/templates/{template_id}/slides/{slide_number}/preview \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}