Skip to main content
POST
/
api
/
public
/
v1
/
folder
/
create
curl -X POST "https://app.hoox.video/api/public/v1/folder/create" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Campaign",
    "type": "assets"
  }'
{
  "id": "662f8c1d3a4b5e6f70123456",
  "name": "Summer Campaign",
  "type": "assets",
  "parent_folder_id": null,
  "created_at": "2026-06-19T10:00:00.000Z"
}

Overview

Creates a folder in your space to keep your library organized. A folder is scoped to a type — either assets (images/videos generated via Submit Asset Generation) or videos (videos produced through the video workflow). For asset folders, pass the returned id as folder_id when calling Submit Asset Generation and the outputs land in that folder.
When you start a batch of generations or work on a specific project, create a dedicated folder first and route every generation into it. It keeps the space tidy and makes the assets easy to find in the dashboard.

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Request Body

name
string
required
Display name of the folder.
type
string
default:"assets"
Folder type: assets or videos. Determines which library the folder appears in.
parent_folder_id
string
ID of an existing folder of the same type to nest this one under. Omit (or pass null) to create a folder at the root of the library.

Response

id
string
Unique identifier of the created folder. For an asset folder, pass this as folder_id to Submit Asset Generation.
name
string
Name of the folder.
type
string
Folder type: assets or videos.
parent_folder_id
string
ID of the parent folder, or null for a root folder.
created_at
string
ISO 8601 creation timestamp.

Examples

curl -X POST "https://app.hoox.video/api/public/v1/folder/create" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Campaign",
    "type": "assets"
  }'
{
  "id": "662f8c1d3a4b5e6f70123456",
  "name": "Summer Campaign",
  "type": "assets",
  "parent_folder_id": null,
  "created_at": "2026-06-19T10:00:00.000Z"
}

Notes

  • type defaults to assets when omitted.
  • A parent_folder_id must reference a folder of the same type, otherwise the request fails with invalid_value.
  • Use List Folders to retrieve existing folder IDs before creating duplicates.