> ## 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.

# Update a video stream

> Update the stream title, description, tags, or interactive engagement configuration.



## OpenAPI

````yaml /openapi.json patch /api/video/streams/{id}
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/{id}:
    patch:
      tags:
        - Video Streaming
      summary: Update a video stream
      description: >-
        Update the stream title, description, tags, or interactive engagement
        configuration.
      operationId: updateVideoStream
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  maxLength: 200
                description:
                  type: string
                  maxLength: 5000
                tags:
                  type: array
                  maxItems: 50
                  items:
                    type: string
                engagement:
                  type: object
                  additionalProperties: true
              minProperties: 1
      responses:
        '200':
          description: Updated video stream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoStreamResponse'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
components:
  schemas:
    VideoStreamResponse:
      type: object
      properties:
        stream:
          $ref: '#/components/schemas/VideoStream'
    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
    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.

````