MediaValet Assets API

openapi: 3.0.3
info:
  title: MediaValet Assets API
  description: |-
    The MediaValet API is a RESTful, JSON, hypermedia-driven service that supplies data to clients consuming the MediaValet cloud digital asset management (DAM) platform. The service applies business rules, permission rules, and other data processing to standardize what is returned. Requests go to the API gateway at https://api.mediavalet.com and must carry two credentials: an OAuth 2.0 / OpenID Connect Bearer access token issued by https://login.mediavalet.com/connect/token, and a per-account subscription key in the Ocp-Apim-Subscription-Key header. Requests also carry an x-mv-api-version header to select the API version. Access requires a MediaValet subscription and registration in the MediaValet Developer Portal at https://developer.mediavalet.com.

    PROVENANCE: this definition is derived operation-for-operation from MediaValet's own published Postman collection ("MediaValet API", collection 55cc404f-b818-43ba-87c2-1a07f2a47bd9) served at https://docs.mediavalet.com/api/collections/15676803/TzRUB7XE. Paths, methods, parameters, request bodies, response status codes and examples come from that collection. Schemas are inferred from the collection's request/response example payloads and are indicative rather than authoritative.
  version: '1.0'
  contact:
    name: MediaValet
    url: https://developer.mediavalet.com
  termsOfService: https://www.mediavalet.com/terms-of-service
servers:
- url: https://api.mediavalet.com
  description: MediaValet API gateway (public)
security:
- oauth2:
  - api
  subscriptionKey: []
tags:
- name: Assets
  description: Core digital asset objects, their media files, renditions, versions, comments, history,
    faces and video clips.
paths:
  /assetCheckIn/{assetId}:
    get:
      operationId: checkInAsset
      summary: Check-In Asset
      description: ChecksIn an asset and returns newly created asset media file information.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '202':
          description: Request was accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  uploadUrl:
                    type: string
                  uploadFileName:
                    type: string
                  mediaFileId:
                    type: string
                    format: uuid
                  title:
                    type: string
                  description:
                    type: string
                  fileSizeInBytes:
                    type: integer
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      functions:
                        type: array
                        items:
                          type: string
                  translationKeys:
                    type: object
                    properties:
                      ullamco__8:
                        type: object
                      aliquaed5:
                        type: object
                      quiddd:
                        type: object
                  interpolations:
                    type: object
                    properties:
                      reprehenderita:
                        type: object
                  permissions:
                    type: array
                    items:
                      type: string
              example:
                id: <uuid>
                uploadUrl: <string>
                uploadFileName: <string>
                mediaFileId: <uuid>
                title: <string>
                description: <string>
                fileSizeInBytes: <long>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  ullamco__8: {}
                  aliquaed5: {}
                  quiddd: {}
                interpolations:
                  reprehenderita: {}
                permissions:
                - asset:downloadFromPortal
                - lightbox:share
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
    put:
      operationId: updateCheckedInAsset
      summary: Update Checked-In Asset
      description: Update asset's checked-in.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                status:
                  type: integer
                fileSizeInBytes:
                  type: integer
                uploadFilename:
                  type: string
                fileName:
                  type: string
                uploadUrl:
                  type: string
            example:
              comment: <string>
              status: <integer>
              fileSizeInBytes: <long>
              uploadFilename: <string>
              fileName: <string>
              uploadUrl: <string>
      responses:
        '202':
          description: Request was accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  title:
                    type: string
                  media:
                    type: object
                    properties:
                      type:
                        type: string
                      small:
                        type: string
                      thumb:
                        type: string
                      large:
                        type: string
                      original:
                        type: string
                      medium:
                        type: string
                      download:
                        type: string
                      downloadRequest:
                        type: string
                      stream:
                        type: string
                      streamLoDef:
                        type: string
                      originalDimensions:
                        type: string
                      sasExpiry:
                        type: integer
                      sasRenewal:
                        type: integer
                      renditionItemCount:
                        type: integer
                      autodeskUrn:
                        type: string
                      watermarked:
                        type: boolean
                      assetId:
                        type: string
                        format: uuid
                      streamingManifest:
                        type: string
                      fullStreamAvailable:
                        type: boolean
                  file:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      title:
                        type: string
                      fileName:
                        type: string
                      md5:
                        type: string
                      fileType:
                        type: string
                      sizeInBytes:
                        type: integer
                      description:
                        type: string
                      keywords:
                        type: string
                      uploadedAt:
                        type: string
                        format: date-time
                      modifiedAt:
                        type: string
                        format: date-time
                      approvedAt:
                        type: string
                        format: date-time
                      disapprovedAt:
                        type: string
                        format: date-time
                      expiresAt:
                        type: string
                        format: date-time
                      imageHeight:
                        type: integer
                      imageWidth:
                        type: integer
                      frameRate:
                        type: string
                      length:
                        type: string
                      bitRate:
                        type: string
                      mimeType:
                        type: string
                      resolution:
                        type: string
                      colorMode:
                        type: string
                      aspectRatio:
                        type: string
                      orientation:
                        type: string
                      sharedRenditionWidth:
                        type: integer
                      sharedRenditionHeight:
                        type: integer
                      sharedRenditionFileExtension:
                        type: string
                      sharedRenditionFileSizeInBytes:
                        type: integer
                  description:
                    type: string
                  altText:
                    type: string
                  containerName:
                    type: string
                  status:
                    type: integer
                  rating:
                    type: object
                    properties:
                      average:
                        type: integer
                      user:
                        type: integer
                  attributes:
                    type: object
                    properties:
                      amet_a0e:
                        type: string
                      culpa_16:
                        type: string
                  record:
                    type: object
                    properties:
                      createdAt:
                        type: string
                        format: date-time
                      createdBy:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          username:
                            type: string
                          firstName:
                            type: string
                          lastName:
                            type: string
                      modifiedAt:
                        type: string
                        format: date-time
                      modifiedBy:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          username:
                            type: string
                          firstName:
                            type: string
                          lastName:
                            type: string
                      softDeletedAt:
                        type: string
                        format: date-time
                      softDeletedBy:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          username:
                            type: string
                          firstName:
                            type: string
                          lastName:
                            type: string
                      version:
                        type: object
                        properties:
                          version:
                            type: integer
                          current:
                            type: string
                            format: uuid
                          head:
                            type: string
                            format: uuid
                          parentid:
                            type: string
                            format: uuid
                          isversionable:
                            type: boolean
                          islatestversion:
                            type: boolean
                          ismajorversion:
                            type: boolean
                  categories:
                    type: array
                    items:
                      type: string
                      format: uuid
                  keywords:
                    type: array
                    items:
                      type: string
                  relatedassets:
                    type: array
                    items:
                      type: string
                      format: uuid
                  assetCheckOutComment:
                    type: string
                  assetCheckInComment:
                    type: string
                  checkedOutBy:
                    type: string
                    format: uuid
                  renderAsPdf:
                    type: boolean
                  wopiEnabled:
                    type: boolean
                  userViewCounts:
                    type: object
                    properties:
                      Ut_86:
                        type: integer
                      consectetur7c:
                        type: integer
                      voluptate_94:
                        type: integer
                  createdAt:
                    type: string
                    format: date-time
                  hasVideoIntelligenceContent:
                    type: boolean
                  followed:
                    type: boolean
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      functions:
                        type: array
                        items:
                          type: string
                  translationKeys:
                    type: object
                    properties:
                      nostrud389:
                        type: object
                      non186:
                        type: object
                      amet_668:
                        type: object
                  interpolations:
                    type: object
                    properties:
                      incididunt4d:
                        type: object
                      in2:
                        type: object
                  permissions:
                    type: array
                    items:
                      type: string
              example:
                id: <uuid>
                title: <string>
                media:
                  type: <string>
                  small: <string>
                  thumb: <string>
                  large: <string>
                  original: <string>
                  medium: <string>
                  download: <string>
                  downloadRequest: <string>
                  stream: <string>
                  streamLoDef: <string>
                  originalDimensions: <string>
                  sasExpiry: <long>
                  sasRenewal: <long>
                  renditionItemCount: <long>
                  autodeskUrn: <string>
                  watermarked: <boolean>
                  assetId: <uuid>
                  streamingManifest: <string>
                  fullStreamAvailable: <boolean>
                file:
                  id: <uuid>
                  title: <string>
                  fileName: <string>
                  md5: <string>
                  fileType: <string>
                  sizeInBytes: <long>
                  description: <string>
                  keywords: <string>
                  uploadedAt: <dateTime>
                  modifiedAt: <dateTime>
                  approvedAt: <dateTime>
                  disapprovedAt: <dateTime>
                  expiresAt: <dateTime>
                  imageHeight: <long>
                  imageWidth: <long>
                  frameRate: <string>
                  length: <string>
                  bitRate: <string>
                  mimeType: <string>
                  resolution: <string>
                  colorMode: <string>
                  aspectRatio: <string>
                  orientation: <string>
                  sharedRenditionWidth: <long>
                  sharedRenditionHeight: <long>
                  sharedRenditionFileExtension: <string>
                  sharedRenditionFileSizeInBytes: <long>
                description: <string>
                altText: <string>
                containerName: <string>
                status: <integer>
                rating:
                  average: <integer>
                  user: <integer>
                attributes:
                  amet_a0e: <string>
                  culpa_16: <string>
                record:
                  createdAt: <dateTime>
                  createdBy:
                    id: <uuid>
                    username: <string>
                    firstName: <string>
                    lastName: <string>
                  modifiedAt: <dateTime>
                  modifiedBy:
                    id: <uuid>
                    username: <string>
                    firstName: <string>
                    lastName: <string>
                  softDeletedAt: <dateTime>
                  softDeletedBy:
                    id: <uuid>
                    username: <string>
                    firstName: <string>
                    lastName: <string>
                  version:
                    version: <integer>
                    current: <uuid>
                    head: <uuid>
                    parentid: <uuid>
                    isversionable: <boolean>
                    islatestversion: <boolean>
                    ismajorversion: <boolean>
                categories:
                - <uuid>
                - <uuid>
                keywords:
                - <string>
                - <string>
                relatedassets:
                - <uuid>
                - <uuid>
                assetCheckOutComment: <string>
                assetCheckInComment: <string>
                checkedOutBy: <uuid>
                renderAsPdf: <boolean>
                wopiEnabled: <boolean>
                userViewCounts:
                  Ut_86: <long>
                  consectetur7c: <long>
                  voluptate_94: <long>
                createdAt: <dateTime>
                hasVideoIntelligenceContent: <boolean>
                followed: <boolean>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  nostrud389: {}
                  non186: {}
                  amet_668: {}
                interpolations:
                  incididunt4d: {}
                  in2: {}
                permissions:
                - lightbox:assignAsset
                - asset:shareAsCdnLink
        '400':
          description: There was a problem with the data sent with the request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      functions:
                        type: array
                        items:
                          type: string
                  translationKeys:
                    type: object
                    properties:
                      in1e:
                        type: object
                      officiaef:
                        type: object
                      deserunt8:
                        type: object
                  interpolations:
                    type: object
                    properties:
                      nisi_a:
                        type: object
                      consequat_7_:
                        type: object
                  permissions:
                    type: array
                    items:
                      type: string
              example:
                message: <string>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  in1e: {}
                  officiaef: {}
                  deserunt8: {}
                interpolations:
                  nisi_a: {}
                  consequat_7_: {}
                permissions:
                - asset:downloadFromMvd
                - lightbox:assignAsset
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
  /assets/{assetId}/faces:
    get:
      operationId: assetsGetFacesInAsset
      summary: Assets Get Faces In Asset
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '200':
          description: Request was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  faces:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        personId:
                          type: string
                        personName:
                          type: string
                        identified:
                          type: boolean
                        identificationStatus:
                          type: integer
                        faceRectangle:
                          type: object
                          properties:
                            top:
                              type: integer
                            left:
                              type: integer
                            width:
                              type: integer
                            height:
                              type: integer
                        thumbnailUrl:
                          type: string
              example:
                faces:
                - id: <string>
                  personId: <string>
                  personName: <string>
                  identified: <boolean>
                  identificationStatus: <integer>
                  faceRectangle:
                    top: <integer>
                    left: <integer>
                    width: <integer>
                    height: <integer>
                  thumbnailUrl: <string>
                - id: <string>
                  personId: <string>
                  personName: <string>
                  identified: <boolean>
                  identificationStatus: <integer>
                  faceRectangle:
                    top: <integer>
                    left: <integer>
                    width: <integer>
                    height: <integer>
                  thumbnailUrl: <string>
        '400':
          description: There was a problem with the data sent with the request.
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
  /assets/{assetId}/clip/{clipId}:
    get:
      operationId: retrieveVideoClip
      summary: Retrieve Video Clip
      description: Retrieves Video Clip details.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: clipId
        in: path
        required: true
        description: clipId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '200':
          description: Request was accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assetId:
                    type: string
                    format: uuid
                  clipId:
                    type: string
                    format: uuid
                  clipUrl:
                    type: string
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      functions:
                        type: array
                        items:
                          type: string
                  translationKeys:
                    type: object
                    properties:
                      fugiat99f:
                        type: object
                      Utcbc:
                        type: object
                      culpa7_:
                        type: object
                      occaecat_:
                        type: object
                  interpolations:
                    type: object
                    properties:
                      Excepteur_09d:
                        type: object
                      eu_4_b:
                        type: object
                  permissions:
                    type: array
                    items:
                      type: string
              example:
                assetId: <uuid>
                clipId: <uuid>
                clipUrl: <string>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  fugiat99f: {}
                  Utcbc: {}
                  culpa7_: {}
                  occaecat_: {}
                interpolations:
                  Excepteur_09d: {}
                  eu_4_b: {}
                permissions:
                - None
                - asset:assignCategory
        '403':
          description: The user does not have permission to perform this operation.
        '404':
          description: The video clip was not found.
        '500':
          description: The request failed because of a problem on the server.
  /assets/{assetId}/relatedassets:
    get:
      operationId: retrieveAssetRelatedAssets
      summary: Retrieve Asset Related Assets
      description: Retrieve related assets based on the asset id.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '200':
          description: Request was successful.
        '403':
          description: The user does not have permission to perform this operation.
        '404':
          description: A related asset was not found.
        '500':
          description: The request failed because of a problem on the server.
    post:
      operationId: createAssociationWithAssetAndRelatedAssets
      summary: Create Association with Asset and Related Assets
      description: Add related assets to an asset.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                derived:
                  type: array
                  items:
                    type: string
                    format: uuid
            example:
              derived:
              - <uuid>
              - <uuid>
      responses:
        '202':
          description: Request was accepted.
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
  /assets/videoIntelligence/limits:
    get:
      operationId: retrieveVideoIntelligenceLimits
      summary: Retrieve Video Intelligence Limits
      description: Retrieves video intelligence limits and usage information.
      tags:
      - Assets
      parameters:
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '200':
          description: Request was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  allottedCredits:
                    type: integer
                  maximumRunTime:
                    type: integer
                  totalAssetsIndexed:
                    type: integer
                  remainingCredit:
                    type: integer
              example:
                status: <string>
                allottedCredits: <integer>
                maximumRunTime: <integer>
                totalAssetsIndexed: <integer>
                remainingCredit: <integer>
        '403':
          description: The user does not have permission to perform this operation.
        '404':
          description: The video intelligence was not found.
        '500':
          description: The request failed because of a problem on the server.
  /assets/{assetId}/{metadataType}:
    get:
      operationId: retrieveAssetMetadata
      summary: Retrieve Asset Metadata
      description: Retrieve meta data for an asset.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        required: true
        description: assetId path parameter.
        schema:
          type: string
      - name: metadataType
        in: path
        required: true
        description: metadataType path parameter.
        schema:
          type: string
      - name: x-mv-api-version
        in: header
        required: false
        description: (Required) The requested API version
        schema:
          type: string
        example: '1.2'
      responses:
        '202':
          description: List of records representing the meta data requested.
  

# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mediavalet/refs/heads/main/openapi/mediavalet-assets-api-openapi.yml