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

# Images estimate

> Price an image request without generating or charging

CLI: `adside media images estimate`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/media/images/estimate
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/images/estimate:
    post:
      tags:
        - Media
      summary: Images estimate
      description: |-
        Price an image request without generating or charging

        CLI: `adside media images estimate`
      operationId: media.images.estimate
      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:
                model:
                  type: string
                  minLength: 1
                  maxLength: 120
                prompt:
                  type: string
                  minLength: 1
                  maxLength: 20000
                maxPriceUsd:
                  type: number
                  exclusiveMinimum: 0
                  maximum: 1000
                resolution:
                  type: string
                  enum:
                    - '512'
                    - '768'
                    - 1K
                    - 1.5K
                    - 2K
                    - 4K
                aspectRatio:
                  type: string
                  enum:
                    - auto
                    - '1:1'
                    - '2:3'
                    - '3:2'
                    - '3:4'
                    - '4:3'
                    - '4:5'
                    - '5:4'
                    - '9:16'
                    - '16:9'
                    - '21:9'
                    - '9:21'
                    - '1:2'
                    - '2:1'
                    - '1:4'
                    - '4:1'
                    - '1:8'
                    - '8:1'
                inputReferences:
                  minItems: 1
                  maxItems: 14
                  type: array
                  items:
                    oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            const: asset
                          assetId:
                            type: string
                            minLength: 1
                            maxLength: 64
                        required:
                          - type
                          - assetId
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            const: image_url
                          imageUrl:
                            type: object
                            properties:
                              url:
                                type: string
                                maxLength: 2048
                                format: uri
                            required:
                              - url
                            additionalProperties: false
                        required:
                          - type
                          - imageUrl
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            const: character
                          character:
                            type: string
                            minLength: 1
                            maxLength: 64
                        required:
                          - type
                          - character
                        additionalProperties: false
              required:
                - prompt
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  model:
                    type: string
                  parameters:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      $ref: '#/components/schemas/RecursiveValue'
                  priceUsd:
                    type: number
                    minimum: 0
                required:
                  - model
                  - parameters
                  - priceUsd
                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.