Bynder Media API

The Media API from Bynder — 4 operation(s) for media.

OpenAPI Specification

bynder-media-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Bynder Account Media API
  version: '1.0'
  description: 'Bynder is a cloud-based digital asset management (DAM) platform. The

    REST API lets developers manage assets, metaproperties, collections,

    taxonomies, workflows, brand guidelines, analytics, webhooks, and

    automations.


    Authentication uses OAuth 2.0 with authorization code, client

    credentials, and refresh token flows against the customer''s portal

    domain. All calls require a Bearer access token in JWT format. The

    base URL is the customer''s portal hostname, e.g.

    `https://yourportal.bynder.com`.


    Rate limit: 4500 requests per 5-minute window per IP. Exceeding

    returns HTTP 429.

    '
  contact:
    name: Bynder Developer Portal
    url: https://developers.bynder.com
servers:
- url: https://{portal}.bynder.com
  description: Customer portal
  variables:
    portal:
      default: yourportal
      description: Customer portal subdomain
security:
- oauth2: []
tags:
- name: Media
paths:
  /api/v4/media:
    get:
      tags:
      - Media
      summary: List assets
      operationId: listAssets
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
      - name: page
        in: query
        schema:
          type: integer
      - name: keyword
        in: query
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
          enum:
          - image
          - document
          - audio
          - video
      - name: orderBy
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Assets
  /api/v4/media/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Media
      summary: Retrieve asset
      operationId: getAsset
      responses:
        '200':
          description: Asset
    post:
      tags:
      - Media
      summary: Modify asset
      operationId: updateAsset
      responses:
        '200':
          description: Updated
    delete:
      tags:
      - Media
      summary: Delete asset
      operationId: deleteAsset
      responses:
        '204':
          description: Deleted
  /api/v4/media/{id}/download:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Media
      summary: Retrieve asset download location
      operationId: getAssetDownload
      responses:
        '200':
          description: Download URL
  /api/v4/media/{id}/publiclinks:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Media
      summary: Get public links for asset
      operationId: getAssetPublicLinks
      responses:
        '200':
          description: Public links
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 with JWT bearer access tokens
      flows:
        authorizationCode:
          authorizationUrl: https://yourportal.bynder.com/v6/authentication/oauth2/auth
          tokenUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/authorization
          refreshUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/refresh
          scopes:
            offline: Refresh token access
            asset:read: Read assets
            asset:write: Write assets
            collection:read: Read collections
            collection:write: Write collections
            meta.assetbank:read: Read asset bank metaproperties
            meta.assetbank:write: Write asset bank metaproperties
        clientCredentials:
          tokenUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/client-credentials
          scopes:
            asset:read: Read assets
            asset:write: Write assets