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

# Videos models

> List the video models, what each is best for, its supported values and prices

CLI: `adside media videos models`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/media/videos/models
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/media/videos/models:
    get:
      tags:
        - Media
      summary: Videos models
      description: >-
        List the video models, what each is best for, its supported values and
        prices


        CLI: `adside media videos models`
      operationId: media.videos.models
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  models:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        isDefault:
                          type: boolean
                        bestFor:
                          type: array
                          items:
                            type: string
                        notes:
                          anyOf:
                            - type: string
                            - type: 'null'
                        pricing:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: number
                            minimum: 0
                        status:
                          type: string
                          enum:
                            - active
                            - deprecated
                        retiresAt:
                          anyOf:
                            - type: string
                              format: date
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                            - type: 'null'
                        replacement:
                          anyOf:
                            - type: string
                            - type: 'null'
                        supportedResolutions:
                          type: array
                          items:
                            type: string
                            enum:
                              - 480p
                              - 720p
                              - 768p
                              - 1080p
                              - 1K
                              - 2K
                              - 4K
                        supportedAspectRatios:
                          type: array
                          items:
                            type: string
                            enum:
                              - '9:16'
                              - '16:9'
                              - '1:1'
                              - '4:3'
                              - '3:4'
                              - '3:2'
                              - '2:3'
                              - '21:9'
                              - '9:21'
                        supportedDurations:
                          type: array
                          items:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                        durationIsTarget:
                          type: boolean
                        supportedFrameImages:
                          type: array
                          items:
                            type: string
                            enum:
                              - first_frame
                              - last_frame
                        supportedGenerateAudio:
                          type: array
                          items:
                            type: boolean
                        defaults:
                          type: object
                          properties:
                            resolution:
                              type: string
                              enum:
                                - 480p
                                - 720p
                                - 768p
                                - 1080p
                                - 1K
                                - 2K
                                - 4K
                            aspectRatio:
                              type: string
                              enum:
                                - '9:16'
                                - '16:9'
                                - '1:1'
                                - '4:3'
                                - '3:4'
                                - '3:2'
                                - '2:3'
                                - '21:9'
                                - '9:21'
                            duration:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            generateAudio:
                              type: boolean
                          required:
                            - resolution
                            - aspectRatio
                            - duration
                            - generateAudio
                          additionalProperties: false
                      required:
                        - id
                        - name
                        - description
                        - isDefault
                        - bestFor
                        - notes
                        - pricing
                        - status
                        - retiresAt
                        - replacement
                        - supportedResolutions
                        - supportedAspectRatios
                        - supportedDurations
                        - durationIsTarget
                        - supportedFrameImages
                        - supportedGenerateAudio
                        - defaults
                      additionalProperties: false
                required:
                  - models
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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