MediaMath Video Creatives API

openapi: 3.0.0
info:
  title: Video Creatives
  description: 'To work with the MediaMath API with Video Creatives, first generate an [authentication
    token](/guides/authentication).


    For more information on Video Creatives, please see the [Video/VPAID Specification](https://support.infillion.com/article/s/article/Video-Creative-Format-Specs)
    and [The MediaMath Platform Video/Audio tab](https://support.infillion.com/article/s/article/Video-Audio-Tab).


    *Example HTTPie command to list all video creatives.*

    `http GET https://api.mediamath.com/api/v3.0/atomic_creatives?q==media_type==video`


    ## Migration Notice


    The following V2.0 endpoints are deprecated and replaced by V3.0 equivalents.


    | Deprecated V2.0 Endpoint | Use Instead |

    |---|---|

    | `GET /api/v2.0/atomic_creatives` | `POST /v3.0/creatives/list` |

    | `GET /api/v2.0/atomic_creatives/{atomic_creative_id}` | `GET /v3.0/creatives/{creativeId}` |

    | `POST /video/v2.0/creatives` | `POST /v3.0/creatives` |

    | `GET /video/v2.0/creatives/{video_id}` | `GET /v3.0/creatives/{creativeId}` |

    | `POST /video/v2.0/creatives/{video_id}` | `POST /v3.0/creatives/{creativeId}` or `PATCH /v3.0/creatives/{creativeId}`
    |

    | `GET /video/v2.0/creatives/{video_id}/companions` | `GET /v3.0/creatives/{creativeId}/companions`
    |

    | `POST /video/v2.0/creatives/{video_id}/companions` | `POST /v3.0/creatives/{creativeId}/companions`
    |

    | `GET /video/v2.0/creatives/{video_id}/companions/{companion_id}/delete` | `DELETE /v3.0/creatives/{creativeId}/companions/{companionId}`
    |

    | `POST /video/v2.0/creatives/{video_id}/upload` | `POST /v3.0/creatives` with the `fileName` field
    (returns a pre-signed S3 upload URL) |

    | `POST /video/v2.0/creatives/validateVAST` | `POST /v3.0/creatives/validateVAST` |


    See the **Video Creative Management (V3)** section below for the V3.0 API.'
  contact:
    name: API Support
    url: https://support.infillion.com/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: v1.0
paths:
  /video/v2.0/creatives/{video_id}/companions:
    get:
      tags:
      - Video Creative Management (V2)
      summary: Get Video Creative Companions
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/creatives/{creativeId}/companions` instead.


        Get Video Creative Companions

        '
      operationId: GET_video-v2-0-creatives-video_id-companions
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Companions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanionsResponse'
        '404':
          description: Creative not found
    post:
      tags:
      - Video Creative Management (V2)
      summary: Create Video Creative Companions
      description: '> **⚠️ Deprecated** — Use `POST /v3.0/creatives/{creativeId}/companions` instead.


        Create Video Creative Companions

        '
      operationId: POST_video-v2-0-creatives-video_id-companions
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/ModifyCompanionRequest'
      responses:
        '201':
          description: Companion created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCompanionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfoList'
        '404':
          description: Creative not found
  /static_data/v1.0/iab_attributes:
    get:
      tags:
      - IAB (V1.0 - Deprecated)
      summary: Get IAB Attributes List
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/static_data/iab_attributes` instead.


        Get IAB Attributes List

        '
      operationId: GET_static_data-v1-0-iab_attributes
      responses:
        '200':
          description: ''
          content:
            text/plain:
              examples:
                response:
                  value:
                  - id: 101
                    name: Rotating Advertisers
                    parent: 0
                    children: []
                  - id: 10
                    name: Shaky, Flashing, Flickering, Extreme Animation, Smileys
                    parent: 0
                    children: []
                  - id: 14
                    name: Windows Dialog or Alert Style
                    parent: 0
                    children: []
                  - id: 6
                    name: In-Banner Video Ad (Auto Play)
                    parent: 0
                    children: []
                  - id: 102
                    name: 'Animated: between 0 and 15 seconds'
                    parent: 0
                    children: []
                  - id: 9
                    name: Provocative or Suggestive Imagery
                    parent: 0
                    children: []
                  - id: 13
                    name: User Interactive (e.g., Embedded Games)
                    parent: 0
                    children: []
                  - id: 2
                    name: Audio Ad (User Initiated)
                    parent: 0
                    children: []
                  - id: 12
                    name: Text Only
                    parent: 0
                    children: []
                  - id: 7
                    name: In-Banner Video Ad (User Initiated)
                    parent: 0
                    children: []
                  - id: 103
                    name: 'Animated: between 15 and 30 seconds'
                    parent: 0
                    children: []
                  - id: 16
                    name: Ad can be skipped (e.g., skip button on preroll video)
                    parent: 0
                    children: []
                  - id: 11
                    name: Surveys
                    parent: 0
                    children: []
                  - id: 104
                    name: 'Animated: more than 30 seconds'
                    parent: 0
                    children: []
                  - id: 8
                    name: Pop (e.g., Over, Under, or upon Exit)
                    parent: 0
                    children: []
                  - id: 999
                    name: None Apply
                    parent: 0
                    children: []
                  - id: 15
                    name: Has audio on/off button
                    parent: 0
                    children: []
                  - id: 100
                    name: Auto redirect
                    parent: 0
                    children: []
  /classification/v1.0/{creative_id}/inflate:
    get:
      tags:
      - Classification (V1.0 - Deprecated)
      summary: Get Inflated Classification
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/classification/{cid}/inflate` instead.


        Get Inflated Classification

        '
      operationId: GET_classification-v1-0-creative_id-inflate
      parameters:
      - name: creative_id
        in: path
        description: Creative ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: ''
  /video/v2.0/creatives/{video_id}/upload:
    post:
      tags:
      - Video Creative Management (V2)
      summary: Upload Video Creative
      description: '> **⚠️ Deprecated** — Use `POST /v3.0/creatives` (Create a new video creative - V3)

        > and supply the `fileName` field to receive a pre-signed S3 upload URL.


        Upload Video Creative

        '
      operationId: POST_video-v2-0-creatives-video_id-upload
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      - name: fileName
        in: query
        description: File name for the upload
        required: false
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  description: The video file to upload
                  type: string
                  format: binary
      responses:
        '200':
          description: File uploaded successfully
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfoList'
        '404':
          description: Creative not found
  /video/v2.0/creatives/{video_id}/variants:
    get:
      tags:
      - Video Creative Management (V2)
      summary: Get Video Creative Variants
      description: Get all encoded video variants for the creative, including asset path and video info.
      operationId: GET_video-v2-0-creatives-video_id-variants
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Variants retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCreativeVariantsResponse'
        '404':
          description: Creative not found
  /video/v2.0/creatives/{video_id}/variants/{variant_id}:
    get:
      tags:
      - Video Creative Management (V2)
      summary: Get Video Creative Variant
      description: Get Video Creative Variant
      operationId: GET_video-v2-0-creatives-video_id-variants-variant_id
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      - name: variant_id
        in: path
        description: Variant ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Variant retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyEncoding'
        '404':
          description: Creative or variant not found
  /video/v2.0/creatives/{video_id}/status:
    get:
      tags:
      - Video Creative Management (V2)
      summary: Get Video Creative Status
      description: Includes upload status, encoding info, encoding percent.
      operationId: GET_video-v2-0-creatives-video_id-status
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Creative status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreativeStatusResponse'
        '404':
          description: Creative not found
  /classification/v1.0/bulk/{creative_ids}/inflate:
    get:
      tags:
      - Classification (V1.0 - Deprecated)
      summary: Bulk Inflated Classification
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/classification/bulk/{cids}/inflate` instead.


        The bulk classification endpoints are useful for batch retrieval and editting of a group of existing
        creatives.

        '
      operationId: GET_classification-v1-0-bulk-creative_ids-inflate
      parameters:
      - name: creative_ids
        in: path
        description: A comma separated list of integers, e.g. 1,243,351,41932.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
  /video/v2.0/creatives/{video_id}/companions/{companion_id}/delete:
    get:
      tags:
      - Video Creative Management (V2)
      summary: Delete Video Creative Companion
      description: '> **⚠️ Deprecated** — Use `DELETE /v3.0/creatives/{creativeId}/companions/{companionId}`
        instead.


        Delete companion ad for the specified creative.

        '
      operationId: GET_video-v2-0-creatives-video_id-companions-companion_id-delete
      parameters:
      - name: video_id
        in: path
        description: Video ID
        required: true
        schema:
          type: integer
      - name: companion_id
        in: path
        description: Companion ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Companion deleted successfully
        '404':
          description: Creative or companion not found
  /static_data/v1.0/language/{language_id}:
    get:
      tags:
      - IAB (V1.0 - Deprecated)
      summary: Get IAB Language
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/static_data/language/{id}` instead.


        Get IAB Language

        '
      operationId: GET_static_data-v1-0-language-language_id
      parameters:
      - name: language_id
        in: path
        description: Language ID
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/GET_static_data-v1-0-language-language_idBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                response:
                  value:
                    alpha2: en
                    bibliographic: eng
                    id: 1
                    name: English
                    nameFr: anglais
                    terminologic: ''
  /classification/v1.0/bulk/{creative_ids}:
    get:
      tags:
      - Classification (V1.0 - Deprecated)
      summary: Bulk Classification
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/classification/bulk/{cids}` instead.


        The bulk classification endpoints are useful for batch retrieval and editting of a group of existing
        creatives.

        '
      operationId: GET_classification-v1-0-bulk-creative_ids
      parameters:
      - name: creative_ids
        in: path
        description: 'A comma separated list of integers, e.g. 1,243,351,41932.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
  /static_data/v1.0/iab_verticals:
    get:
      tags:
      - IAB (V1.0 - Deprecated)
      summary: List IAB Verticals
      description: '> **⚠️ Deprecated** — Use `GET /v3.0/static_data/iab_verticals` instead.


        List IAB Verticals

        '
      operationId: GET_static_data-v1-0-iab_verticals
      responses:
        '200':
          description: ''
          content:
            application/json:
              examples:
                response:
                  value:
                  - children:
                    - 215
                    - 216
                    - 217
                    - 218
                    - 219
                    - 220
                    - 221
                    - 222
                    code: IAB14
                    description: Society
                    id: 214
                    parent: 0
                  - children:
                    - 224
                    - 225
                    - 226
                    - 227
                    - 228
                    - 229
                    - 230
                    - 231
                    - 232
                    - 233
                    code: IAB15
                    description: Science
                    id: 223
                    parent: 0
                  - children:
                    - 235
                    - 236
                    - 237
                    - 238
                    - 239
                    - 240
                    - 241
                    code: IAB16
                    description: Pets
                    id: 234
                    parent: 0
                  - children: []
                    code: IAB13-2
                    description: Credit/Debt & Loans
                    id: 203
                    parent: 201
                  - children: []
                    code: IAB13-3
                    description: Financial News
                    id: 204
                    parent: 201
                  - children: []
                    code: IAB13-4
                    description: Financial Planning
                    id: 205
                    parent: 201
                  - children: []
                    code: IAB13-5
                    description: Hedge Fund
                    id: 206
                    parent: 201
                  - children: []
                    code: IAB13-6
                    description: Insurance
                    id: 207
                    parent: 201
                  - children: []
                    code: IAB13-7
                    description: Investing
                    id: 208
                    parent: 201
                  - children: []
                    code: IAB13-8
                    description: Mutual Funds
                    id: 209
                    parent: 201
                  - children: []
                    code: IAB14-1
                    description: Dating
                    id: 215
                    parent: 214
                  - children: []
                    code: IAB14-2
                    description: Divorce Support
                    id: 216
                    parent: 214
                  - children: []
                    code: IAB14-3
                    description: Gay Life
                    id: 217
                    parent: 214
                  - children: []
                    code: IAB14-4
                    description: Marriage
                    id: 218
                    parent: 214
                  - children: []
                    code: IAB14-5
                    description: Senior Living
                    id: 219
                    parent: 214
                  - children: []
                    code: IAB14-6
                    description: Teens
                    id: 220
                    parent: 214
                  - children: []
                    code: IAB14-7
                    description: Weddings
                    id: 221
                    parent: 214
                  - children: []
                    code: IAB14-8
                    description: Ethnic Specific
                    id: 222
                    parent: 214
                  - children: []
                    code: IAB15-1
                    description: Astrology
                    id: 224
                    parent: 223
                  - children: []
                    code: IAB15-10
                    description: Weather
                    id: 233
                    parent: 223
                  - children: []
                    code: IAB15-2
                    description: Biology
                    id: 225
                    parent: 223
                  - children: []
                    code: IAB15-3
                    description: Chemistry
                    id: 226
                    parent: 223
                  - children: []
                    code: IAB15-4
                    description: Geology
                    id: 227
                    parent: 223
                  - children: []
                    code: IAB15-5
                    description: Paranormal Phenomena
                    id: 228
                    parent: 223
                  - children: []
                    code: IAB15-6
                    description: Physics
                    id: 229
                    parent: 223
                  - children: []
                    code: IAB15-7
                    description: Space/Astronomy
                    id: 230
                    parent: 223
                  - children: []
                    code: IAB15-8
                    description: Geography
                    id: 231
                    parent: 223
                  - children: []
                    code: IAB15-9
                    description: Botany
                    id: 232
                    parent: 223
                  - children: []
                    code: IAB16-1
                    description: Aquariums
                    id: 235
                    parent: 234
                  - children: []
                    code: IAB16-2
                    description: Birds
                    id: 236
                    parent: 234
                  - children: []
                    code: IAB16-3
                    description: Cats
                    id: 237
                    parent: 234
                  - children: []
                    code: IAB16-4
                    description: Dogs
                    id: 238
                    parent: 234
                  - children: []
                    code: IAB16-5
                    description: Large Animals
                    id: 239
                    parent: 234
                  - children: []
                    code: IAB16-6
                    description: Reptiles
                    id: 240
                    parent: 234
                  - children: []
                    code: IAB16-7
                    description: Veterinary Medicine
                    id: 241
                    parent: 234
                  - children: []
                    code: IAB17-1
                    description: Auto Racing
                    id: 243
                    parent: 242
                  - children: []
                    code: IAB17-10
                    description: Figure Skating
                    id: 252
                    parent: 242
                  - children: []
                    code: IAB17-11
                    description: Fly Fishing
                    id: 253
                    parent: 242
                  - children: []
                    code: IAB17-12
                    description: Football
                    id: 254
                    parent: 242
                  - children: []
                    code: IAB17-13
                    description: Freshwater Fishing
                    id: 255
                    parent: 242
                  - children: []
                    code: IAB17-14
                    description: Game & Fish
                    id: 256
                    parent: 242
                  - children: []
                    code: IAB17-15
                    description: Golf
                    id: 257
                    parent: 242
                  - children: []
                    code: IAB17-16
                    description: Horse Racing
                    id: 258
                    parent: 242
                  - children: []
                    code: IAB17-17
                    description: Horses
                    id: 259
                    parent: 242
                  - children: []
                    code: IAB17-18
                    description: Hunting/Shooting
                    id: 260
                    parent: 242
                  - children: []
                    code: IAB4-3
                    description: Financial Aid
                    id: 49
                    parent: 46
                  - children: []
                    code: IAB4-4
                    description: Job Fairs
                    id: 50
                    parent: 46
                  - children: []
                    code: IAB4-5
                    description: Job Search
                    id: 51
                    parent: 46
                  - children: []
                    code: IAB4-6
                    description: Resume Writing/Advice
                    id: 52
                    parent: 46
                  - children: []
                    code: IAB6-1
                    description: Adoption
                    id: 75
                    parent: 74
                  - children: []
                    code: IAB6-2
                    description: Babies & Toddlers
                    id: 76
                    parent: 74
                  - children: []
                    code: IAB6-3
                    description: Daycare/Pre School
                    id: 77
                    parent: 74
                  - children: []
                    code: IAB6-4
                    description: Family Internet
                    id: 78
                    parent: 74
                  - children: []
                    code: IAB6-5
                    description: Parenting - K-6 Kids
                    id: 79
                    parent: 74
                  - children: []
                    code: IAB6-9
                    description: Eldercare
                    id: 83
                    parent: 74
                  - children: []
                    code: IAB7-1
                    description: Exercise
                    id: 85
                    parent: 84
                  - children: []
                    code: IAB7-10
                    description: Brain Tumor
                    id: 94
                    parent: 84
                  - children: []
                    code: IAB7-11
                    description: Cancer
                    id: 95
                    parent: 84
                  - children: []
                    code: IAB7-12
                    description: Cholesterol
                    id: 96
                    parent: 84
                  - children: []
                    code: IAB7-20
                    description: Diabetes
                    id: 104
                    parent: 84
                  - children: []
                    code: IAB7-21
                    description: Epilepsy
                    id: 105
                    parent: 84
                  - children: []
                    code: IAB7-22
                    description: GERD/Acid Reflux
                    id: 106
                    parent: 84
                  - children: []
                    code: IAB7-23
                    description: Headaches/Migraines
                    id: 107
                    parent: 84
                  - children: []
                    code: IAB7-24
                    description: Heart Disease
                    id: 108
                    parent: 84
                  - children: []
                    code: IAB7-25
                    description: Herbs for Health
                    id: 109
                    parent: 84
                  - children: []
                    code: IAB8-2
                    description: Barbecues & Grilling
                    id: 132
                    parent: 130
                  - children: []
                    code: IAB8-3
                    description: Cajun/Creole
                    id: 133
                    parent: 130
                  - children: []
                    code: IAB8-4
                    description: Chinese Cuisine
                    id: 134
                    parent: 130
                  - children: []
                    code: IAB8-5
                    description: Cocktails/Beer
                    id: 135
                    parent: 130
                  - children: []
                    code: IAB8-6
                    description: Coffee/Tea
                    id: 136
                    parent: 130
                  - children: []
                    code: IAB8-7
                    description: Cuisine-Specific
                    id: 137
                    parent: 130
                  - children: []
                    code: IAB8-8
                    description: Desserts & Baking
                    id: 138
                    parent: 130
                  - children: []
                    code: IAB8-9
                    description: Dining Out
                    id: 139
                    parent: 130
                  - children: []
                    code: IAB9-1
                    description: Art/Technology
                    id: 150
                    parent: 149
                  - children: []
                    code: IAB9-22
                    description: Painting
                    id: 171
                    parent: 149
                  - children: []
                    code: IAB9-23
                    description: Photography
                    id: 172
                    parent: 149
                  - children: []
                    code: IAB9-24
                    description: Radio
                    id: 173
                    parent: 149
                  - children: []
                    code: IAB9-25
                    description: Roleplaying Games
                    id: 174
                    parent: 149
                  - children: []
                    code: IAB9-26
                    description: Sci-Fi & Fantasy
                    id: 175
                    parent: 149
                  - children: []
                    code: IAB9-27
                    description: Scrapbooking
                    id: 176
                    parent: 149
                  - children: []
                    code: IAB9-28
                    description: Screenwriting
                    id: 177
                    parent: 149
                  - children: []
                    code: IAB9-29
                    description: Stamps & Coins
                    id: 178
                    parent: 149
                  - children: []
                    code: IAB9-3
                    description: Beadwork
                    id: 152
                    parent: 149
                  - children: []
                    code: IAB9-30
                    description: Video & Computer Games
                    id: 179
                    parent: 149
                  - children: []
                    code: IAB9-31
                    description: Woodworking
                    id: 180
                    parent: 149
                  - children: []
                    code: IAB9-4
                    description: Birdwatching
                    id: 153
                    parent: 149
                  - children: []
                    code: IAB9-5
                    description: Board Games/Puzzles
                    id: 154
                    parent: 149
                  - children: []
                    code: IAB9-6
                    description: Candle & Soap Making
                    id: 155
                    parent: 149
                  - children: []
                    code: IAB9-7
                    description: Card Games
                    id: 156
                    parent: 149
                  - children: []
                    code: IAB9-8
                    description: Chess
                    id: 157
                    parent: 149
                  - children: []
                    code: IAB9-9
                    description: Cigars
                    id: 158
                    parent: 149
  /classification/v1.0/bulk:
    post:
      tags:
      - Classification (V1.0 - Deprecated)
      summary: Bulk Update Classification
      description: '> **⚠️ Deprecated** — Use `POST /v3.0/classification/bulk` instead.


        Prior to creating or updating the classification record of any creative, those creatives must
        exist.


        Unlike in the single creative classifiction, no creative IDs are passed in the url itself.'
      operationId: POST_classification-v1-0-bulk
      requestBody:
        $ref: '#/components/requestBodies/GET_static_data-v1-0-language-language_idBody'
      responses:
        '200':
          description: ''
          content:
            example-1:
              examples:
                response:
                  value:
                    records:
                    - atomic_creative_id: 0
                      details:
                        attributes:
                        - {}
                        language: 0
                        verticals:
                        - {}
  /video/v2.0/creatives/validateVAST:
    post:
      tags:
      - Video Creative Management (V2)
      summary: Validate VAST XML
      description: '> **⚠️ Deprecated** — Use `POST /v3.0/creatives/validateVAST` instead.


        Validates the p

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mediamath/refs/heads/main/openapi/mediamath-video-creatives-api-openapi.yml