Upload a Background

Uploads a single background image file to your organization's library.

Request

This endpoint expects a multipart form containing a file.

organization_idstringRequiredformat: "uuid"

Your organization's unique identifier.

filefileRequired

The path to the single background image file you'd like to upload. Image files must be in JPEG, PNG, or JPG format. The image files must also have a resolution of at least 1080p and have a landscape orientation.

labelstringRequired

A descriptive title for the background image file you'd like to upload.

frames_folder_idstringOptionalformat: "uuid"

The unique identifier for the folder within your library where this background image file should be uploaded. If left empty, the background image file will be uploaded to the Unclassified folder.

Response

201 - Upload successful

savedFilestring or null

The user input label of the successfully uploaded background image file.

1	import requests
2
3	url = "https://api.amniscient.com/upload/background-image"
4
5	files = { "file": "open('foo', 'rb')" }
6	payload = {
7	"organization_id": "foo",
8	"label": "foo",
9	"frames_folder_id":
10	}
11	headers = {"x-api-key": "x-api-key"}
12
13	response = requests.post(url, data=payload, files=files, headers=headers)
14
15	print(response.json())

Headers

Request

Response

Errors