License editorial content

v1.0.0

This endpoint gets licenses for one or more editorial images. You must specify the country and one or more editorial images to license. The download links in the response are valid for 8 hours.

Input

{
  "type": "object",
  "description": "License editorial content request",
  "required": [
    "country",
    "editorial"
  ],
  "properties": {
    "country": {
      "description": "Mandatory country code for where the editorial content will be distributed; this value is used for rights checks",
      "type": "object"
    },
    "editorial": {
      "type": "array",
      "description": "Editorial content to license",
      "items": {
        "type": "object",
        "description": "Individual editorial content to license",
        "required": [
          "editorial_id",
          "license"
        ],
        "properties": {
          "editorial_id": {
            "type": "string",
            "description": "Editorial ID"
          },
          "license": {
            "type": "string",
            "description": "License agreement to use for licensing"
          },
          "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": {}
          },
          "size": {
            "type": "string",
            "description": "Asset size to download",
            "enum": [
              "small",
              "medium",
              "original"
            ]
          }
        }
      }
    }
  }
}

Output

{
  "description": "List of editorial license results",
  "properties": {
    "data": {
      "type": "array",
      "description": "License results",
      "items": {
        "type": "object",
        "description": "The response to a licensing request for editorial content",
        "required": [
          "editorial_id"
        ],
        "properties": {
          "allotment_charge": {
            "type": "integer",
            "description": "For pre-paid plans, how many credits were used for the item license"
          },
          "download": {
            "type": "object",
            "description": "URL object",
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string",
                "description": "URL that can be used to download the unwatermarked, licensed asset"
              }
            }
          },
          "editorial_id": {
            "type": "string",
            "description": "Editorial ID"
          },
          "error": {
            "type": "string"
          }
        }
      }
    },
    "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": "Optional error message"
    },
    "page": {
      "type": "integer",
      "description": "Current page of the response"
    },
    "per_page": {
      "type": "integer",
      "description": "Number of results per page"
    },
    "total_count": {
      "type": "integer",
      "description": "Total count of all results"
    }
  }
}