License videos

v1.0.0

This endpoint gets licenses for one or more videos. You must specify the video IDs in the body parameter and the size and subscription ID either in the query parameter or with each video ID in the body parameter. Values in the body parameter override values in the query parameters. The download links in the response are valid for 8 hours.

Input

{
  "type": "object",
  "properties": {
    "search_id": {
      "type": "string"
    },
    "size": {
      "type": "string",
      "enum": [
        "web",
        "sd",
        "hd",
        "4k"
      ]
    },
    "subscription_id": {
      "type": "string"
    },
    "videos": {
      "type": "array",
      "description": "Videos to license",
      "items": {
        "type": "object",
        "description": "Data required to license a video",
        "required": [
          "video_id"
        ],
        "properties": {
          "auth_cookie": {
            "type": "object",
            "description": "Cookie object",
            "required": [
              "name",
              "value"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the cookie"
              },
              "value": {
                "type": "string",
                "description": "The value of the cookie"
              }
            }
          },
          "editorial_acknowledgement": {
            "type": "boolean",
            "description": "Whether or not this item is editorial content"
          },
          "metadata": {
            "type": "object",
            "description": "Additional information for license requests for enterprise accounts and API subscriptions, 4 fields maximum; which fields are required is set by the account holder",
            "properties": {}
          },
          "price": {
            "type": "number",
            "description": "Retail price amount as a floating-point number in the transaction currency, such as 12.34; only for rev-share partners"
          },
          "search_id": {
            "type": "string",
            "description": "ID of the search that led to this licensing event"
          },
          "show_modal": {
            "type": "boolean",
            "description": "(Deprecated)"
          },
          "size": {
            "type": "string",
            "description": "Size of the video being licensed",
            "enum": [
              "web",
              "sd",
              "hd",
              "4k"
            ]
          },
          "subscription_id": {
            "type": "string",
            "description": "ID of the subscription used for this license"
          },
          "video_id": {
            "type": "string",
            "description": "ID of the video being licensed"
          }
        }
      }
    }
  },
  "required": [
    "videos"
  ],
  "additionalProperties": false
}

Output

{
  "description": "List of video license results",
  "properties": {
    "data": {
      "type": "array",
      "description": "License results",
      "items": {
        "type": "object",
        "description": "The response to a licensing request for a video",
        "required": [
          "video_id"
        ],
        "properties": {
          "allotment_charge": {
            "type": "integer",
            "description": "Number of credits that this licensing event used"
          },
          "download": {
            "type": "object",
            "description": "URL object",
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string",
                "description": "URL that can be used to download the unwatermarked, licensed asset"
              }
            }
          },
          "error": {
            "type": "string",
            "description": "Potential error that occurred during licensing"
          },
          "license_id": {
            "type": "string",
            "description": "ID of the license event"
          },
          "price": {
            "type": "object",
            "description": "Price",
            "properties": {
              "local_amount": {
                "type": "number",
                "description": "Floating-point amount of the calculated rev-share price in the currency local_currency"
              },
              "local_currency": {
                "type": "string",
                "description": "Currency of the rev-share price that was calculated"
              }
            }
          },
          "video_id": {
            "type": "string",
            "description": "ID of the video that was licensed"
          }
        }
      }
    },
    "errors": {
      "type": "array",
      "description": "Error list; appears only if there was an error",
      "items": {
        "type": "object",
        "description": "Error object",
        "required": [
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "The error code of this error"
          },
          "data": {
            "type": "string",
            "description": "Debugging information about the error"
          },
          "items": {
            "type": "array",
            "description": "A list of items that produced the error",
            "items": {
              "type": "object"
            }
          },
          "message": {
            "type": "string",
            "description": "Specific details about this error"
          },
          "path": {
            "type": "string",
            "description": "Internal code reference to the source of the error"
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Server-generated message, if any"
    },
    "page": {
      "type": "integer",
      "description": "Current page that is returned"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "total_count": {
      "type": "integer",
      "description": "Total count of all results across all pages"
    }
  }
}