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

# Recommend

> Recommend up to three models for a task described in plain words, with why, ready-to-use parameters, the price and the model family's prompting guide

CLI: `adside media recommend`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/media/recommendations
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/recommendations:
    post:
      tags:
        - Media
      summary: Recommend
      description: >-
        Recommend up to three models for a task described in plain words, with
        why, ready-to-use parameters, the price and the model family's prompting
        guide


        CLI: `adside media recommend`
      operationId: media.recommendations.create
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                task:
                  type: string
                  minLength: 1
                  maxLength: 4000
                type:
                  type: string
                  enum:
                    - image
                    - video
                aspectRatio:
                  type: string
                  maxLength: 10
                duration:
                  type: integer
                  minimum: 1
                  maximum: 30
                generateAudio:
                  type: boolean
                inputs:
                  type: object
                  properties:
                    firstFrame:
                      type: boolean
                    lastFrame:
                      type: boolean
                    referenceImages:
                      type: integer
                      minimum: 0
                      maximum: 14
                  additionalProperties: false
                maxPriceUsd:
                  type: number
                  exclusiveMinimum: 0
                  maximum: 1000
                priority:
                  type: string
                  enum:
                    - quality
                    - balanced
                    - cost
              required:
                - task
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  useCase:
                    type: string
                  type:
                    type: string
                    enum:
                      - image
                      - video
                  classified:
                    type: boolean
                  constraints:
                    type: object
                    properties:
                      aspectRatio:
                        anyOf:
                          - type: string
                          - type: 'null'
                      duration:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                      generateAudio:
                        anyOf:
                          - type: boolean
                          - type: 'null'
                      firstFrame:
                        type: boolean
                      referenceImages:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      maxPriceUsd:
                        anyOf:
                          - type: number
                          - type: 'null'
                      priority:
                        type: string
                        enum:
                          - quality
                          - balanced
                          - cost
                    required:
                      - aspectRatio
                      - duration
                      - generateAudio
                      - firstFrame
                      - referenceImages
                      - maxPriceUsd
                      - priority
                    additionalProperties: false
                  note:
                    anyOf:
                      - type: string
                      - type: 'null'
                  recommendations:
                    maxItems: 3
                    type: array
                    items:
                      type: object
                      properties:
                        model:
                          type: string
                        name:
                          type: string
                        why:
                          type: string
                        parameters:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            $ref: '#/components/schemas/RecursiveValue'
                        priceUsd:
                          type: number
                          minimum: 0
                        requires:
                          type: array
                          items:
                            type: string
                            enum:
                              - first_frame
                              - reference_image
                        promptGuide:
                          type: string
                      required:
                        - model
                        - name
                        - why
                        - parameters
                        - priceUsd
                        - requires
                        - promptGuide
                      additionalProperties: false
                  unmet:
                    type: array
                    items:
                      type: string
                  guidanceVersion:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                  - useCase
                  - type
                  - classified
                  - constraints
                  - note
                  - recommendations
                  - unmet
                  - guidanceVersion
                additionalProperties: false
      security:
        - userAccess: []
components:
  schemas:
    RecursiveValue:
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/RecursiveValue'
        - type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/RecursiveValue'
  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.