The Creatives API allows you to create and manage Creatives in your Workspace. A Creative is a graphic, video, audio, or HTML overlay that you can use in different workflows.
How you add a Creative depends on its type:
- Graphics, video, and audio: Upload the file to Uplynk.
- HTML overlays: Provide the URL where the overlay is hosted. Uplynk does not upload HTML files. The Creative references the overlay at its hosted location, and Uplynk returns the URL you supplied.
HTML overlays are in early access and are not yet generally available. Contact your account team to enable HTML overlays on your account.
Key Features
- Create Creatives by uploading a graphic, video, or audio file, or by referencing a hosted HTML overlay by its URL.
- Validate files before uploading against the accepted file extensions and maximum file size.
- Search, filter, and sort Creatives by title, media type, source, status, and creation time.
- Retrieve and update Creatives to track their status, rename them, and set their media resolution.
Creative Management
Use the following endpoints to create, retrieve, update, and delete Creatives, and to retrieve the file-validation rules for uploads.
Available Endpoints
| Endpoint | Description |
|---|---|
| Create creative POST /creatives | Create a Creative by uploading a graphic, video, or audio file, or by referencing an HTML overlay by its hosted URL. For an upload, the response includes upload instructions. After the upload completes, poll the Creative until its status is ready or error. |
| Retrieve creative GET /creatives/{creative_id} | Retrieve a specific Creative, including its media details, status, timestamps, and a fresh signed media URL. |
| List creatives GET /creatives | List Creatives in a paginated response. By default, only Creatives that are not deleted and have a ready status are returned. |
| Update creative PATCH /creatives/{creative_id} | Rename an existing Creative or set its media resolution. |
| Delete creative DELETE /creatives/{creative_id} | Delete a specific Creative. You cannot delete a Creative that a clipping profile still references until you remove that reference. |
| Retrieve rules GET /creatives/rules | Retrieve the accepted file extensions and maximum file size for Creative uploads, so you can validate a file before you upload it. |
Base URL
Use the following base URL:
https://api.uplynk.com/v5