Authentication

Upload API (v2.0)

Use the Upload API to upload files to Content Hub. Uploads are completed in three steps:

Generate an upload URL that returns metadata about the upload session. Provide the following information:
- Configuration settings to use for the upload - an entity that hosts a predefined configuration, which specifies supported file extensions, the permitted file size, the default asset lifecycle for asset creation, and so on.
- Purpose of the newly uploaded file - create a new asset, use the uploaded file as a new master file for an existing asset, or use the file as an alternate file for an existing asset.
Upload the file to the generated upload URL.
Complete the upload by providing the metadata about the session that was generated in step 1.

For more information and to see examples, refer to the Upload API documentation. For details on how to upload large files, see Upload large files.

Important

The Upload API is not intended for the bulk upload of assets. High volumes of parallel uploads can impact performance. Review Performance best practices to ensure optimal performance of Content Hub.

Note

Security is applied at the upload configuration level. This means that the user upload permissions depend on the upload configuration entities that users have access to.

Authentication

To use the Upload API, you need:

The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the {{server}} variable by hovering your mouse over the variable in the Try it pane and then clicking Edit.
An access token and the client ID. Both are sent with every request. You can create a token through the Content Hub interface or by requesting one using the API itself.

Download OpenAPI description

index.json

index.yaml

Overview

License closed source

Servers

https://{server}/

Upload

The Upload endpoint is used to manage file uploads.

Operations