> ## Documentation Index
> Fetch the complete documentation index at: https://docs.breezeblue.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List clips

> List clips in chapter order with stored and effective settings.

<section className="api-next-steps" aria-label="Continue building">
  ## Continue building

  <Columns cols={2}>
    <Card title="Manage Studio projects" icon="book-open" href="/guides/studio-projects">Import scripts, edit safely, and retry writes.</Card>
    <Card title="Update clips in bulk" icon="list-checks" href="/api-reference/studio/update-clips-in-bulk">Change up to 100 clips in one write.</Card>
    <Card title="Studio CLI" icon="terminal" href="/cli/reference/studio">Run the same operations from a terminal.</Card>
  </Columns>
</section>


## OpenAPI

````yaml /openapi.json get /v1/studio/projects/{project_id}/clips
openapi: 3.1.0
info:
  title: Breeze Developer API
  description: >-
    Breeze Developer API for models, voices, text-to-speech, history, balance,
    usage, and browser-managed API keys.
  version: 1.0.0
servers:
  - url: https://api.breeze.blue
security: []
tags:
  - name: Models
    description: Supported TTS models.
  - name: Text to Speech
    description: Text-to-speech synthesis and instruction enhancement.
  - name: Voices
    description: Saved voices and voice settings.
  - name: Voice Previews
    description: Create, audition, and save temporary voice previews.
  - name: Account
    description: Balance, usage, and API keys.
  - name: History
    description: Generated audio history.
  - name: Studio
    description: Projects, scripts, arrangement and audio materials.
paths:
  /v1/studio/projects/{project_id}/clips:
    get:
      tags:
        - Studio
      summary: List clips
      description: List clips in chapter order with stored and effective settings.
      operationId: studio_clips_list
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            title: Project Id
          description: Studio project ID, such as prj_….
        - name: chapter_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Chapter Id
          description: Only list clips in this chapter.
        - name: include_deleted
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Deleted
          description: Include clips in deleted chapters.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
          description: Page number, starting at 1.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 400
            minimum: 1
            default: 100
            title: Page Size
          description: Clips per page, up to 400.
      responses:
        '200':
          description: A page of clips and the current edit_token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClipList'
          headers:
            x-breeze-api-key-id:
              description: >-
                Public API key identifier used to authenticate the request, when
                an API key was used.
              schema:
                type: string
        '401':
          description: HTTP 401 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: HTTP 404 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: HTTP 422 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl \
              --request GET \
              --url "https://api.breeze.blue/v1/studio/projects/prj_example/clips" \
              --header "xi-api-key: $BREEZE_API_KEY"
        - lang: Python
          label: Python
          source: |-
            from breeze_blue import BreezeBlue

            client = BreezeBlue()
            result = client.studio.clips.list("prj_example")
        - lang: TypeScript
          label: TypeScript
          source: |-
            import { BreezeBlueClient } from "@breeze.blue/sdk";

            const client = new BreezeBlueClient();
            const result = await client.studio.clips.list("prj_example");
components:
  schemas:
    ClipList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ClipView'
          type: array
          title: Items
          description: Resources in order.
        edit_token:
          type: string
          title: Edit Token
          description: >-
            Current edit_token. Send it as expected_edit_token on the next
            write.
        total:
          type: integer
          title: Total
          description: Total number of matching items.
        page:
          type: integer
          title: Page
          description: Current page number.
        page_size:
          type: integer
          title: Page Size
          description: Items per page.
      additionalProperties: false
      type: object
      required:
        - items
        - edit_token
        - total
        - page
        - page_size
      title: ClipList
    ErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          title: Meta
      required:
        - code
        - detail
        - error
      title: ErrorResponse
      type: object
    ValidationErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
      required:
        - code
        - detail
        - error
      title: ValidationErrorResponse
      type: object
    ClipView:
      properties:
        id:
          type: string
          title: Id
          description: Clip ID.
        chapter_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Chapter Id
          description: Chapter containing the clip.
        name:
          type: string
          title: Name
          description: Clip label.
        script:
          type: string
          title: Script
          description: Text to speak.
        instructions:
          type: string
          title: Instructions
          description: Instructions stored on the clip.
        voice_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Voice Id
          description: Voice ID stored on the clip.
        voice:
          anyOf:
            - $ref: '#/components/schemas/VoiceSummary'
            - type: 'null'
          description: Voice name and availability.
        playback:
          $ref: '#/components/schemas/PlaybackView'
          description: Playback speed and volume.
        trailing_silence_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Trailing Silence Ms
          description: Silence stored on the clip; null inherits the project default.
        effective_instructions:
          type: string
          title: Effective Instructions
          description: Instructions used for generation after project defaults.
        effective_trailing_silence_ms:
          type: integer
          title: Effective Trailing Silence Ms
          description: Silence applied after the clip, in milliseconds.
        version:
          type: integer
          title: Version
          description: Clip version. Increases with each change.
      additionalProperties: false
      type: object
      required:
        - id
        - chapter_id
        - name
        - script
        - instructions
        - voice_id
        - voice
        - playback
        - trailing_silence_ms
        - effective_instructions
        - effective_trailing_silence_ms
        - version
      title: ClipView
    VoiceSummary:
      properties:
        id:
          type: string
          title: Id
          description: Voice ID.
        name:
          type: string
          title: Name
          description: Voice name.
        available:
          type: boolean
          title: Available
          description: false when the voice was deleted or is no longer accessible.
      additionalProperties: false
      type: object
      required:
        - id
        - name
        - available
      title: VoiceSummary
    PlaybackView:
      properties:
        speed:
          type: number
          title: Speed
          description: Playback speed.
        volume:
          type: number
          title: Volume
          description: Volume multiplier.
      additionalProperties: false
      type: object
      required:
        - speed
        - volume
      title: PlaybackView
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: xi-api-key
      description: Breeze Developer API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.