requests

Get Generation Request

Get deck-generation status by the caller's request ID.

get/requests/{request_id}

Request

  • Base URL: https://api.presentations.ai/api/v1
  • URL: https://api.presentations.ai/api/v1/requests/{request_id}
  • Auth: HTTP bearer

Path parameters

request_idstring required

Response

Successful Response

request_idstring required

Caller request ID used to safely replay this deck creation.

deck_idstring uuid required
status'CREATED' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

Lifecycle state of an async task.

stage'QUEUED' | 'OUTLINE' | 'SLIDES' | 'EXPORT' | 'COMPLETED' | 'FAILED' | 'ENRICHING' | 'SCRAPING' | 'ANALYZING' | 'GENERATING_VISUALS' | 'SAVING' required

Durable, caller-visible deck-generation stage.

status_urlstring uri required

Canonical URL to poll for this request.

errorstring nullable required

Sanitized terminal failure message; non-null only when status is FAILED.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.