GET /presentations/generate/:generationId/status

Returns the current state of a generation job.

cURL

curl "https://api.chroniclehq.com/api/v1/presentations/generate/gen_123/status" \
  -H "Authorization: Bearer $API_KEY"

generating

{
  "generation_id": "gen_123",
  "status": "generating",
  "progress": {
    "slides_total": 9,
    "slides_completed": 3,
    "current_step": "Creating slide 4 of 9"
  },
  "tokens_used": 12450
}

cURL

curl "https://api.chroniclehq.com/api/v1/presentations/generate/gen_123/status" \
  -H "Authorization: Bearer $API_KEY"

Parameters

generationId · string · required

The generation job ID

Response

generating

{
  "generation_id": "gen_123",
  "status": "generating",
  "progress": {
    "slides_total": 9,
    "slides_completed": 3,
    "current_step": "Creating slide 4 of 9"
  },
  "tokens_used": 12450
}

Common fields

generation_id · string

Generation job ID

status · string

Current generation status: one of generating, awaiting_input, completed, failed.

When status = “generating”

progress · object

Optional progress object. Present once Chronicle has begun generating slides.

Show child attributes

slides_total · number

Total number of slides expected

slides_completed · number

Number of slides completed so far

current_step · string

Human-readable progress message

tokens_used · number

Optional running token total for this generation. Present when non-zero.

When status = “awaiting_input”

message · string

Clarifying question or follow-up prompt from Chronicle. Reply via POST /presentations/generate/:generationId/message.

When status = “completed”

presentation · object

The materialized presentation. Same shape as GET /presentations/:id.

Show child attributes

id · string

Presentation ID

title · string

Presentation title

workspace_id · string

Workspace ID that owns the presentation

sections · array

Presentation slides

is_public · boolean

Whether the presentation is public

url · string

Canonical presentation URL

created_at · string

ISO timestamp when the presentation was created

updated_at · string

ISO timestamp when the presentation was last updated

tokens_used · number

Optional total tokens consumed by the generation. Present when non-zero.

When status = “failed”

error · string

Human-readable failure reason (for example Generation timed out or a propagated upstream error message).

---

FAQs

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?

Your client should handle these statuses:

• generating
• completed
• failed
• awaiting_input

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`?

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?

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.

---

Related posts

• POST /presentations/generate
• POST /presentations/generate/:generationId/message
• API scope and rate limits