---
title: "List caption words"
method: GET
path: "/projects/{projectId}/captions/words"
tags: ["Captions and Themes"]
---

# List caption words

`GET /projects/{projectId}/captions/words`

## Request

- Base URL: `https://blitzreels.com/api/v1`
- URL: `https://blitzreels.com/api/v1/projects/{projectId}/captions/words`
- Auth: API key in header `Authorization`

List caption words.

## Path parameters

- `projectId` string, required

## Query parameters

- `timeline_item_id` string
- `match_text` string
- `limit` number
- `offset` number

## Response `200`

Successful response

- object
  - `success` boolean, required
  - `words` object[], required
    - `id` string, required
    - `captionId` string, required
    - `timelineItemId` string, nullable, required
    - `word` string, required
    - `orderIndex` number, required
    - `sequenceIndex` number, required
    - `isEmphasis` boolean, required
    - `startUnits` number, nullable, required
    - `endUnits` number, nullable, required
    - `startSeconds` number, nullable, required
    - `endSeconds` number, nullable, required
    - `paragraphIndex` number, nullable, required
    - `style` object, nullable, required
      - `offsetX` number, nullable
      - `offsetY` number, nullable
      - `rotationDeg` number, nullable
      - `scale` number, nullable
      - `fontFamily` string, nullable
      - `fontWeight` string, nullable
      - `color` string, nullable
      - `activeColor` string, nullable
      - `backgroundColor` string, nullable
      - `activeAnimation` 'none' | 'slide-from-bottom' | 'pop' | 'glow' | 'punch', nullable
      - `fontStyle` 'normal' | 'italic', nullable
      - `textTransform` 'none' | 'uppercase', nullable
      - `letterSpacing` number, nullable
      - `opacity` number, nullable
      - `textStrokeColor` string, nullable
      - `textStrokeWidthPx` number, nullable
      - `textStrokeBlurPx` number, nullable
      - `textShadow` string, nullable
      - `glowColor` string, nullable
      - `glowBlurPx` number, nullable
      - `textGradientFrom` string, nullable
      - `textGradientTo` string, nullable
      - `textGradientAngleDeg` number, nullable
      - `backgroundRadiusPx` number, nullable
      - `emojiName` string, nullable
      - `emojiScale` '1' | '2' | '0.5', nullable
      - `isSpecial` boolean, nullable
      - `isKeyword` boolean, nullable
      - `lineBreakBefore` boolean
  - `items` object[], required
    - `id` string, required
    - `captionId` string, required
    - `timelineItemId` string, nullable, required
    - `word` string, required
    - `orderIndex` number, required
    - `sequenceIndex` number, required
    - `isEmphasis` boolean, required
    - `startUnits` number, nullable, required
    - `endUnits` number, nullable, required
    - `startSeconds` number, nullable, required
    - `endSeconds` number, nullable, required
    - `paragraphIndex` number, nullable, required
    - `style` object, nullable, required
      - `offsetX` number, nullable
      - `offsetY` number, nullable
      - `rotationDeg` number, nullable
      - `scale` number, nullable
      - `fontFamily` string, nullable
      - `fontWeight` string, nullable
      - `color` string, nullable
      - `activeColor` string, nullable
      - `backgroundColor` string, nullable
      - `activeAnimation` 'none' | 'slide-from-bottom' | 'pop' | 'glow' | 'punch', nullable
      - `fontStyle` 'normal' | 'italic', nullable
      - `textTransform` 'none' | 'uppercase', nullable
      - `letterSpacing` number, nullable
      - `opacity` number, nullable
      - `textStrokeColor` string, nullable
      - `textStrokeWidthPx` number, nullable
      - `textStrokeBlurPx` number, nullable
      - `textShadow` string, nullable
      - `glowColor` string, nullable
      - `glowBlurPx` number, nullable
      - `textGradientFrom` string, nullable
      - `textGradientTo` string, nullable
      - `textGradientAngleDeg` number, nullable
      - `backgroundRadiusPx` number, nullable
      - `emojiName` string, nullable
      - `emojiScale` '1' | '2' | '0.5', nullable
      - `isSpecial` boolean, nullable
      - `isKeyword` boolean, nullable
      - `lineBreakBefore` boolean
  - `count` number, required
  - `warnings` string[], required
  - `pagination` object, required
    - `total` number, required
    - `returned` number, required
    - `offset` number, required
    - `limit` number, required
    - `hasMore` boolean, required
  - `summary` object, required
    - `totalWords` number, required
    - `emphasisCount` number, required
    - `hasEmphasis` boolean, required
  - `hint` string

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/blitzreels/apis/blitzreels-api.md) · [All operations](https://skmtc.dev/blitzreels/apis/blitzreels-api/llms.txt) · [OpenAPI document](https://skmtc.dev/blitzreels/apis/blitzreels-api/revisions/35608b12471d?raw)