MediaValet Categories API

openapi: 3.0.3
info:
  title: MediaValet Categories 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: Categories
  description: Hierarchical categories (folders) that organize assets and carry permissions.
paths:
  /folders/{categoryId}/assets:
    get:
      operationId: retrieveFolderAssets
      summary: Retrieve Folder Assets
      description: Returns assets that belongs to the specified category.
      tags:
      - Categories
      parameters:
      - name: categoryId
        in: path
        required: true
        description: categoryId 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.
        '500':
          description: The request failed because of a problem on the server.
  /categories/{categoryId}/assets:
    get:
      operationId: retrieveCategoryAssets
      summary: Retrieve Category Assets
      description: Returns assets that belongs to the specified category.
      tags:
      - Categories
      parameters:
      - name: categoryId
        in: path
        required: true
        description: categoryId 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.
        '500':
          description: The request failed because of a problem on the server.
  /categories/{categoryId}/assets/basic:
    get:
      operationId: retrieveCategoryAssetsBasicInformation
      summary: Retrieve Category Assets Basic Information
      description: Returns assets that belongs to the specified category.
      tags:
      - Categories
      parameters:
      - name: categoryId
        in: path
        required: true
        description: categoryId 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.
        '500':
          description: The request failed because of a problem on the server.
  /categories:
    get:
      operationId: retrieveCategories
      summary: Retrieve Categories
      description: Returns list of categories for the library.
      tags:
      - Categories
      parameters:
      - name: includePermissions
        in: query
        required: false
        description: includePermissions query 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: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    container:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        type:
                          type: string
                    parentId:
                      type: string
                      format: uuid
                    description:
                      type: string
                    tree:
                      type: object
                      properties:
                        path:
                          type: string
                        name:
                          type: string
                        idPath:
                          type: string
                        id:
                          type: string
                    subcats:
                      type: object
                      properties:
                        total:
                          type: integer
                    assetCount:
                      type: integer
                    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
                    subfolderCount:
                      type: integer
                    name:
                      type: string
                    categoryFeatures:
                      type: object
                      properties:
                        videoIntelligenceAutoIndex:
                          type: object
                          properties:
                            enabled:
                              type: boolean
                            inheritToChildren:
                              type: boolean
                    includedInBrandedPortalSync:
                      type: boolean
                    syncedBrandedPortals:
                      type: array
                      items:
                        type: string
                    _links:
                      type: object
                      properties:
                        self:
                          type: string
                        functions:
                          type: array
                          items:
                            type: string
                    translationKeys:
                      type: object
                      properties:
                        sunt_5bc:
                          type: object
                    interpolations:
                      type: object
                      properties:
                        laborisca:
                          type: object
                        Ut99:
                          type: object
                        qui02d:
                          type: object
                        in2:
                          type: object
                    permissions:
                      type: array
                      items:
                        type: string
              example:
              - id: <uuid>
                container:
                  id: <uuid>
                  type: <string>
                parentId: <uuid>
                description: <string>
                tree:
                  path: <string>
                  name: <string>
                  idPath: <string>
                  id: <string>
                subcats:
                  total: <integer>
                assetCount: <integer>
                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>
                subfolderCount: <integer>
                name: <string>
                categoryFeatures:
                  videoIntelligenceAutoIndex:
                    enabled: <boolean>
                    inheritToChildren: <boolean>
                includedInBrandedPortalSync: <boolean>
                syncedBrandedPortals:
                - <string>
                - <string>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  sunt_5bc: {}
                interpolations:
                  laborisca: {}
                  Ut99: {}
                  qui02d: {}
                  in2: {}
                permissions:
                - lightbox:editDetails
                - asset:createImageCrop
              - id: <uuid>
                container:
                  id: <uuid>
                  type: <string>
                parentId: <uuid>
                description: <string>
                tree:
                  path: <string>
                  name: <string>
                  idPath: <string>
                  id: <string>
                subcats:
                  total: <integer>
                assetCount: <integer>
                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>
                subfolderCount: <integer>
                name: <string>
                categoryFeatures:
                  videoIntelligenceAutoIndex:
                    enabled: <boolean>
                    inheritToChildren: <boolean>
                includedInBrandedPortalSync: <boolean>
                syncedBrandedPortals:
                - <string>
                - <string>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  mollited7: {}
                  suntce: {}
                  ea3ef: {}
                interpolations:
                  veniam_: {}
                  elit_3: {}
                permissions:
                - asset:shareAsLightbox
                - lightbox:viewAsset
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
    post:
      operationId: createCategory
      summary: Create Category
      description: Creates a category in the library.
      tags:
      - Categories
      parameters:
      - name: includePermissions
        in: query
        required: false
        description: includePermissions query 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:
                parentId:
                  type: string
                  format: uuid
                description:
                  type: string
                treeName:
                  type: string
                categoryId:
                  type: string
                  format: uuid
                notification:
                  type: object
                  properties:
                    entityIds:
                      type: array
                      items:
                        type: string
                        format: uuid
                    notificationEntityType:
                      type: string
                    userGroups:
                      type: array
                      items:
                        type: string
                        format: uuid
                    users:
                      type: array
                      items:
                        type: string
                        format: uuid
                    userEmails:
                      type: array
                      items:
                        type: string
                    message:
                      type: string
            example:
              parentId: <uuid>
              description: <string>
              treeName: <string>
              categoryId: <uuid>
              notification:
                entityIds:
                - <uuid>
                - <uuid>
                notificationEntityType: CategoryCreation
                userGroups:
                - <uuid>
                - <uuid>
                users:
                - <uuid>
                - <uuid>
                userEmails:
                - <string>
                - <string>
                message: <string>
      responses:
        '201':
          description: The category was successfully created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  assetCount:
                    type: integer
                  subfolderCount:
                    type: integer
                  subfolders:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                  subcats:
                    type: object
                    properties:
                      total:
                        type: integer
                  tree:
                    type: object
                    properties:
                      path:
                        type: string
                      name:
                        type: string
                      idPath:
                        type: string
                      id:
                        type: string
                  id:
                    type: string
                    format: uuid
                  parentId:
                    type: string
                    format: uuid
                  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
                  categoryFeatures:
                    type: object
                    properties:
                      videoIntelligenceAutoIndex:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          inheritToChildren:
                            type: boolean
                  includedInBrandedPortalSync:
                    type: boolean
                  syncedBrandedPortals:
                    type: array
                    items:
                      type: string
                  _links:
                    type: object
                    properties:
                      self:
                        type: string
                      functions:
                        type: array
                        items:
                          type: string
                  translationKeys:
                    type: object
                    properties:
                      reprehenderit_f24:
                        type: object
                      reprehenderit_0c0:
                        type: object
                      quis_2:
                        type: object
                  interpolations:
                    type: object
                    properties:
                      laborumacf:
                        type: object
                      ad0:
                        type: object
                  permissions:
                    type: array
                    items:
                      type: string
              example:
                name: <string>
                assetCount: <integer>
                subfolderCount: <integer>
                subfolders:
                - value: '<Circular reference to #/components/schemas/FolderDto detected>'
                - value: '<Circular reference to #/components/schemas/FolderDto detected>'
                subcats:
                  total: <integer>
                tree:
                  path: <string>
                  name: <string>
                  idPath: <string>
                  id: <string>
                id: <uuid>
                parentId: <uuid>
                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>
                categoryFeatures:
                  videoIntelligenceAutoIndex:
                    enabled: <boolean>
                    inheritToChildren: <boolean>
                includedInBrandedPortalSync: <boolean>
                syncedBrandedPortals:
                - <string>
                - <string>
                _links:
                  self: <string>
                  functions:
                  - <string>
                  - <string>
                translationKeys:
                  reprehenderit_f24: {}
                  reprehenderit_0c0: {}
                  quis_2: {}
                interpolations:
                  laborumacf: {}
                  ad0: {}
                permissions:
                - asset:assignCategory
                - asset:shareAsCdnLink
        '400':
          description: There was a problem with the data sent with the request.
        '401':
          description: The current user is not authorized to execute this operation.
        '403':
          description: The user does not have permission to perform this operation.
        '500':
          description: The request failed because of a problem on the server.
  /categories/subcategories:
    get:
      operationId: retrieveRootSubCategories
      summary: Retrieve Root Sub Categories
      description: Returns the sub categories that belongs to the specified category.
      tags:
      - Categories
      parameters:
      - name: categoryFeatures
        in: query
        required: false
        description: categoryFeatures query 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: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    container:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        type:
                          type: string
                    parentId:
                      type: string
                      format: uuid
                    description:
                      type: string
                    tree:
                      type: object
                      properties:
                        path:
                          type: string
                        name:
                          type: string
                        idPath:
                          type: string
                        id:
                          type: string
                    subcats:
                      type: object
                      properties:
                        total:
                          type: integer
                    assetCount:
                      type: integer
                    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
                    subfolderCount:
                      type: integer
                    name:
                      type: string
                    categoryFeatures:
                      type: object
                      properties:
                        videoIntelligenceAutoIndex:
                          type: object
                          properties:
                            enabled:
                              type: boolean
                            inheritToChildren:
                              type: boolean
                    includedInBrandedPortalSync:
                      type: boolean
                    syncedBrandedPortals:
                      type: array
                      items:
                        type: string
                    _links:
                      type: object
                      properties:
                        self:
                          type: string
                        functions:
                          type: array
                          items:
                            type: string
                    translationKeys:
                      type: object
                      properties:
                        sunt_5bc:
                          type: object
                    interpolations:
                      type: object
                      properties:
                        laborisca:
                          type: object
                        Ut99:
                          type: object
                        qui02d:
                          type: object
                        in2:
                          type: object
                    permissi

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