API reference
GET /presentations/generate/:generationId/status
Returns the current state of a generation job.
Parameters
The generation job ID
Response
Common fields
Generation job ID
Current generation status: one of
generating, awaiting_input, completed,
failed.When status = “generating”
Optional progress object. Present once Chronicle has begun generating slides.
Optional. Present only for Standalone generations (when
template_id was
omitted on the original request). One of storyline (Chronicle is planning
the deck outline) or slides (Chronicle is generating the slides from the
storyline). Use this to give users finer-grained progress feedback than the
time-based stage progression.Optional running token total for this generation. Present when non-zero.
When status = “awaiting_input”
Clarifying question or follow-up prompt from Chronicle. Reply via POST
/presentations/generate/:generationId/message.
When status = “completed”
The materialized presentation. Same shape as GET /presentations/:id.
Optional total tokens consumed by the generation. Present when non-zero.
When status = “failed”
Human-readable failure reason (for example
Generation timed out or a
propagated upstream error message).FAQs
How often should I poll for status?
How often should I poll for status?
Poll at a short interval, such as every few seconds.Avoid polling in a tight loop.
What statuses should my client handle?
What statuses should my client handle?
Your client should handle these statuses:
generatingcompletedfailedawaiting_input
What do I get when generation completes?
What do I get when generation completes?
When generation completes, Chronicle returns the final presentation object.That response includes the information you need to open or continue working with the presentation.
What should I do if the status is `failed`?
What should I do if the status is `failed`?
Treat
failed as a terminal state and surface the error clearly in your app or logs.Do not continue polling after generation has failed.Can I show progress while generation is running?
Can I show progress while generation is running?
Yes. The status response can include progress details while the presentation is being generated.Use those fields to give users better feedback than a generic loading state.
What does the `phase` field mean?
What does the `phase` field mean?
For Standalone generations (no
template_id), Chronicle works in two phases: it first generates the storyline outline, then it generates the slides from that outline. The phase field tells you which one is currently active so your UI can show a more accurate progress indicator.Template-based generations don’t emit a phase — they’re single-phase from the API’s perspective.