Create a Background Folder

Create a new background image folder. This folder will appear in your organization's library.

This endpoint expects an object.

namestringRequired

A descriptive title for the background image folder you'd like to create.

organization_idstringRequiredformat: "uuid"

Your organization's unique identifier.

typestringRequired

For the creation of background folders, this value should always be 'BACKGROUND'.

created_bystringOptional

The email of the user creating the folder.

200 - Folder creation successful

namestring or null

The descriptive title of the background image folder you've successfully created.

display_namestring or null

The title of the background image folder you've successfully created as it appears within your organization's library.

organization_idstring or nullformat: "uuid"

Your organization's unique identifier.

created_bystring or null

The email of the user that created this folder within your organization's library.

typestring or null

The type of folder created within your organization's library. For background folders, this value will always be 'BACKGROUND.'

idstring or nullformat: "uuid"

The folder id of the folder created within your organization's library.

created_atstring or nullformat: "date-time"

The date and time at which this folder was originally created within your organization's library.

updated_atstring or nullformat: "date-time"

The date and time at which this folder was last updated within your organization's library.

deleted_atstring or nullformat: "date-time"

The date and time at which this folder was deleted within your organization's library. This value will always be null for newly created folders.

1	import requests
2
3	url = "https://api.amniscient.com/folder/background"
4
5	payload = {
6	"name": "foo",
7	"organization_id": "foo",
8	"type": "foo"
9	}
10	headers = {
11	"x-api-key": "x-api-key",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

1	{
2	"name": "my frame folder 3",
3	"display_name": "My Frame Folder 3",
4	"organization_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
5	"created_by": "example@amniscient.com",
6	"type": "BACKGROUND",
7	"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
8	"created_at": "2025-09-11T17:05:05.450Z",
9	"updated_at": "2025-09-11T17:05:05.450Z"
10	}