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

# List video streams

> List video streaming assets for the authenticated workspace.



## OpenAPI

````yaml /openapi.json get /api/video/streams
openapi: 3.1.0
info:
  title: Convertly API
  version: 1.0.0
  description: >-
    Convertly provides production API endpoints for media conversion,
    compression, Image CDN delivery, Forma AI, HLS/DASH video streaming, media
    tools, async jobs, workflows, webhooks, and Convertly Storage.
  license:
    name: Proprietary
    url: https://convertly.sh/terms
servers:
  - url: https://convertly.sh
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /api/video/streams:
    get:
      tags:
        - Video Streaming
      summary: List video streams
      description: List video streaming assets for the authenticated workspace.
      operationId: listVideoStreams
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - processing
              - ready
              - failed
              - deleted
      responses:
        '200':
          description: Video streams
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoStreamListResponse'
        '401':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
components:
  schemas:
    VideoStreamListResponse:
      type: object
      properties:
        streams:
          type: array
          items:
            $ref: '#/components/schemas/VideoStream'
        pagination:
          $ref: '#/components/schemas/Pagination'
    VideoStream:
      type: object
      properties:
        id:
          type: string
          format: uuid
        assetId:
          type: string
          format: uuid
        playbackId:
          type: string
        status:
          type: string
          enum:
            - pending
            - processing
            - ready
            - failed
            - deleted
        protocol:
          type: string
          enum:
            - hls
            - dash
            - hls_dash
        profile:
          type: string
        videoCodec:
          type: string
          enum:
            - h264
            - av1
          default: h264
        access:
          type: string
          enum:
            - public
            - signed
        duration:
          type:
            - number
            - 'null'
        width:
          type:
            - integer
            - 'null'
        height:
          type:
            - integer
            - 'null'
        manifestUrl:
          type:
            - string
            - 'null'
        posterUrl:
          type:
            - string
            - 'null'
        renditions:
          type: array
          items:
            $ref: '#/components/schemas/VideoStreamRendition'
        error:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        readyAt:
          type:
            - string
            - 'null'
          format: date-time
        packageFormats:
          type: array
          items:
            type: string
            enum:
              - hls
              - dash
        hlsManifestUrl:
          type:
            - string
            - 'null'
        dashManifestUrl:
          type:
            - string
            - 'null'
        tokenTtlSeconds:
          type:
            - integer
            - 'null'
        allowedDomains:
          type: array
          items:
            type: string
        captions:
          type: array
          items:
            $ref: '#/components/schemas/VideoCaptionTrack'
        analytics:
          type:
            - object
            - 'null'
          properties:
            events:
              type: integer
            plays:
              type: integer
    Pagination:
      type: object
      properties:
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
        hasMore:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
    VideoStreamRendition:
      type: object
      properties:
        id:
          type: string
          format: uuid
        width:
          type: integer
        height:
          type: integer
        bitrate:
          type: integer
        averageBitrate:
          type: integer
        codec:
          type: string
          example: h264
        audioCodec:
          type:
            - string
            - 'null'
          example: aac
        segmentCount:
          type: integer
    VideoCaptionTrack:
      type: object
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
        language:
          type: string
        kind:
          type: string
          enum:
            - subtitles
            - captions
        url:
          type:
            - string
            - 'null'
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Dashboard-generated Convertly API key. Keys currently begin with
        `cvly_`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative API key header for server-side clients.

````