Skip to main content
POST
Create Folder

Authorizations

x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key
string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body

application/json

Request body for POST /v3/folders.

name
string
required

Folder name, 1-256 characters. Sibling folders may share a name.

Required string length: 1 - 256
Example:

"Module 3 - Deploying to production"

parent_id
string | null

ID of the folder to create this one in. Omit, pass null, or pass an empty string to create it at the workspace root. The parent must be a folder in the caller's workspace that is not in the trash.

Maximum string length: 64
Example:

"7c1f0b2e3d4a4f5e8a9b0c1d2e3f4a5b"

type
enum<string>
default:mixed

Kind of folder. 'mixed' is what the HeyGen web app's New folder action creates; 'video_translate' is what the Video Translate page creates. The web app lists all three kinds together in its folder views, and every kind accepts videos and translations placed with folder_id on POST /v3/videos and POST /v3/video-translations.

Available options:
mixed,
video,
video_translate

Response

Created.

data
FolderV3 · object

A folder in the caller's workspace.