Skip to main content
Before you begin, you’ll need:
  • Chronicle workspace with API enabled (available on Pro, Plus, and Max plans)
  • Node.js 18+ or another runtime with fetch support
1

Create an API key

  • Open Chronicle
  • Navigate to Settings → API
  • Create an API key
  • Copy and store it securely, you won’t be able to see it again
export CHRONICLE_API_KEY="your_api_key_here"
Include the key in the header with every request. Supported headers:
  • Authorization: Bearer <API_KEY>
  • x-api-key: <API_KEY>
2

Upload reference files (optional)

Skip this step if your prompt doesn’t need source files. Otherwise, request a presigned upload target, post the file directly to S3, and keep the returned download_url for the next step.
# 1. Request a presigned target
TARGET=$(curl -s -X POST "https://api.chroniclehq.com/api/v1/uploads/create-target" \
  -H "Authorization: Bearer $CHRONICLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file_name": "research-notes.pdf",
    "content_type": "application/pdf",
    "declared_file_size": 524288
  }')

URL=$(echo "$TARGET" | jq -r '.url')
DOWNLOAD_URL=$(echo "$TARGET" | jq -r '.download_url')
FIELDS_ARGS=$(echo "$TARGET" | jq -r '.fields[] | "-F \(.name)=\(.value)"')

# 2. POST the file to S3 (no Authorization header, file last)
eval "curl -X POST \"$URL\" $FIELDS_ARGS -F file=@research-notes.pdf"
Allowed formats: .txt, .md, .pdf, .pptx, and common image types. Max 50 MB per file. See POST /uploads/create-target for the full reference.
3

Start a generation from a prompt

If you uploaded files in the previous step, pass them in the attachments array using the download_url you captured.
curl -X POST "https://api.chroniclehq.com/api/v1/presentations/generate" \
  -H "Authorization: Bearer $CHRONICLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "tpl_123",
    "prompt": "Create a 5-slide presentation summarizing our Q2 product launch, customer traction, and next-quarter priorities.",
    "attachments": [
      {
        "id": "att_123",
        "url": "'"$DOWNLOAD_URL"'",
        "file_name": "research-notes.pdf",
        "type": "application/pdf"
      }
    ]
  }'
The request returns 202 Accepted with a generation_id you can poll.
{
  "generation_id": "gen_123",
  "status": "generating",
  "poll_url": "/api/v1/presentations/generate/gen_123/status"
}
4

Poll for completion

Poll the status endpoint until status is completed, failed, or awaiting_input.
curl -X GET "https://api.chroniclehq.com/api/v1/presentations/generate/gen_123/status" \
  -H "Authorization: Bearer $CHRONICLE_API_KEY"

{
  "generation_id": "gen_123",
  "status": "completed",
  "presentation": {
    "id": "pres_789",
    "title": "Q2 Product Launch Review",
    "workspace_id": "ws_123",
    "sections": [],
    "is_public": false,
    "url": "https://app.chroniclehq.com/ws_123/document/pres_789",
    "created_at": "2026-04-30T00:00:00.000Z",
    "updated_at": "2026-04-30T00:00:00.000Z"
  }
}
5

View and use your Chronicle deck

Open the url from the completed payload, or fetch the presentation later by ID:
curl "https://api.chroniclehq.com/api/v1/presentations/pres_789" \
  -H "Authorization: Bearer $CHRONICLE_API_KEY"

{
  "id": "pres_789",
  "title": "Q2 Product Launch Review",
  "workspace_id": "ws_123",
  "sections": [],
  "is_public": false,
  "url": "https://app.chroniclehq.com/ws_123/document/pres_789",
  "created_at": "2026-04-30T00:00:00.000Z",
  "updated_at": "2026-04-30T00:00:00.000Z"
}