Exports

3 endpoints for working with exports.

Request an export

post/decks/{id}/exportscreate_export

Queues a PDF or PPTX render of a skroll and returns immediately. Poll get_export until status is 'completed', then use its downloadUrl. Repeated requests within 10 minutes reuse the in-flight export. Only 'slides' skrolls can be exported.

Example request

curl

curl -X POST https://skrollai.com/api/v1/decks/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f/exports \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "format": "pdf"
  }'

Parameters

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

Request body

Field	Type	Description
format*	"pdf" \| "pptx"	n/a
version	integer	Defaults to the latest version

Responses

202Export queued (or an in-flight one reused)

Export

Field	Type	Description
id*	string (uuid)	n/a
deckId*	string (uuid)	n/a
version*	integer	n/a
format*	"pdf" \| "pptx"	n/a
status*	"pending" \| "running" \| "completed" \| "failed"	n/a
fileName*	string \| null	n/a
nonstandardFonts*	string[] \| null	Fonts in the deck that may not render identically in the export
error*	string \| null	n/a
downloadUrl*	string \| null	Authenticated download endpoint; present once status is 'completed'
createdAt*	string (date-time)	n/a

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

404Resource not found

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

Get export status

get/exports/{id}get_export

Returns an export's status. Once 'completed', downloadUrl points at the authenticated file download.

Example request

curl

curl -X GET https://skrollai.com/api/v1/exports/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_..."

Parameters

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

Responses

200The export

Export

Field	Type	Description
id*	string (uuid)	n/a
deckId*	string (uuid)	n/a
version*	integer	n/a
format*	"pdf" \| "pptx"	n/a
status*	"pending" \| "running" \| "completed" \| "failed"	n/a
fileName*	string \| null	n/a
nonstandardFonts*	string[] \| null	Fonts in the deck that may not render identically in the export
error*	string \| null	n/a
downloadUrl*	string \| null	Authenticated download endpoint; present once status is 'completed'
createdAt*	string (date-time)	n/a

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

404Resource not found

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

Download a completed export

get/exports/{id}/downloaddownload_export

Redirects to the rendered file. Requires the same API key that requested the export.

Example request

curl

curl -X GET https://skrollai.com/api/v1/exports/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f/download \
  -H "Authorization: Bearer sk_..."

Parameters

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

Responses

302Redirect to the file

401Missing, malformed, unknown or revoked API key

403The key's creator lacks access

404Resource not found

409Export is not completed yet

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error