License sound effects

v1.0.0

This endpoint licenses sounds effect assets.

Input

{
  "type": "object",
  "description": "License sounds effect asset request body",
  "required": [
    "sound_effects"
  ],
  "properties": {
    "sound_effects": {
      "type": "array",
      "description": "Sound effects to license for",
      "items": {
        "type": "object",
        "required": [
          "sfx_id",
          "subscription_id"
        ],
        "properties": {
          "audio_layout": {
            "type": "string",
            "enum": [
              "ambisonic",
              "5.1",
              "stereo"
            ]
          },
          "format": {
            "type": "string",
            "enum": [
              "wav",
              "mp3"
            ]
          },
          "search_id": {
            "type": "string",
            "description": "ID of the search that led to this licensing event"
          },
          "sfx_id": {
            "type": "string",
            "description": "ID of the sounds effect being licensed"
          },
          "subscription_id": {
            "type": "string",
            "description": "ID of the subscription to use for the download."
          }
        }
      }
    }
  }
}

Output

{
  "description": "List of information about licensed sound effects",
  "properties": {
    "data": {
      "type": "array",
      "description": "Sound effects license results",
      "items": {
        "type": "object",
        "description": "The response to a licensing request for an sound effects",
        "required": [
          "sfx_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": "Error message, appears only if there was an error"
          },
          "license_id": {
            "type": "string",
            "description": "ID of the license event"
          },
          "sfx_id": {
            "type": "string",
            "description": "Sound effects ID 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"
    }
  }
}