OCT-103 Gumlet outreach
POST/video/workspaces/{workspace_id}/folders

Create a folder in a video workspace

Creates a folder inside a video workspace. Supply name and optionally parent_id to create a nested folder; omit parent_id or send null to create a root-level folder. A 200 response returns the created folder details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
workspace_idstringrequired

The ID of the video workspace in which to create the folder.

Folder details. name is required; parent_id can be omitted or set to null to create the folder at the root level.

namestringrequired

Folder name.

parent_idstringoptional

Parent folder id. Send null or omit it to create a root-level folder.

5 status codes
200Returns the created folder object, including its ID, name, workspace, parent, path, and timestamps.
asset_countintegeroptional

Number of assets inside this folder

Default:0
created_atstringoptional

Folder creation time in ISO 8601 format

depthintegeroptional

Depth of this folder from root

Default:0
idstringoptional

Folder ID

namestringoptional

Folder name

parent_idstringoptional

Parent folder ID

patharray<string>optional

Path details

path_namesarray<string>optional
subdirectory_countintegeroptional

Number of subfolders inside this folder

Default:0
updated_atstringoptional

Folder update time in ISO 8601 format

video_source_idstringdeprecatedoptional

Deprecated. Use workspace_id instead. Still returned for backwards compatibility.

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • folder_name_required

    Folder name is required.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks sufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

The workspace_id path parameter identifies the workspace for the new folder. The body must include name; parent_id may be omitted or set to null for a root-level folder. A 400 or 422 indicates an invalid or unprocessable request, a 401 indicates missing or invalid authentication, and a 403 indicates an unpaid account or insufficient role permissions.