OCT-103 Gumlet outreach
POST/video/workspaces

Create a video workspace

Creates a video workspace that you can use to organize videos by team, department, or use case. Supply name and type, and include the storage configuration required for the selected workspace type. A 200 response returns the created workspace, including its ID and configuration.

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

17 body fields

Video workspace configuration. name and type are required; storage configuration fields are required when they match the selected type.

awsobjectoptional

This is a required field if workspace type is aws.

azureobjectoptional

This is a required field if workspace type is azure.

backblazeobjectoptional

This is a required field if workspace type is backblaze.

cloudflareobjectoptional

This is a required field if workspace type is cloudflare.

cloudinaryobjectoptional

This is a required field if workspace type is cloudinary.

data_localizationstringoptional

Data localization region

Allowed:usineuDefault:us
default_profile_idstringoptional

Gumlet provides the functionality of creating multiple video assets using the same set of parameters.

dostorageobjectoptional

This is a required field if workspace type is dostorage.

gcsobjectoptional

This is a required field if workspace type is gcs.

insight_property_idstringoptional

The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard.

linodeobjectoptional

This is a required field if workspace type is linode.

namestringrequired

Specify a text string or identifier for the workspace.

proxyobjectoptional

This is a required field if workspace type is proxy.

typestringrequired

Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.

Allowed:proxydirect-uploadwebfolderawsgcsdostoragewasabicloudinaryazurelinodebackblazecloudflareDefault:direct-upload
video_protectionobjectoptional

Gumlet provides multiple options for securing your video playback.

wasabiobjectoptional

This is a required field if workspace type is wasabi.

zoomobjectoptional

This is a required field if workspace type is zoom.

5 status codes
200Returns the created workspace object, including its ID, name, type, folders, and configuration.
channel_settingsobjectoptional
created_atstringoptional

Created at time in ISO 8601 format

default_profile_idstringoptional

Default profile for this workspace

embed_detailsobjectoptional
foldersarray<string>optional

List of folders inside this workspace

idstringoptional

Workspace ID

insight_property_idstringoptional
namestringoptional

Workspace name

player_configobjectoptional

Player configuration for this workspace

typestringoptional

Workspace type

updated_atstringoptional

Updated at time in ISO 8601

video_protectionobjectoptional
zoomobjectoptional
400Returned when the request is invalid.

One documented failure

  • parameter_missing

    One or more required values are missing.

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 feature is unavailable on the account's plan.

One documented failure

  • unauthorised_feature_access

    Your plan doesn't have this feature, please upgrade your current plan to access this feature.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

name and type are required. Include the configuration object for the selected workspace type, with its required fields: for example, aws requires bucket_name, bucket_region, access_key, and secret, while azure requires azure_account_name, azure_container_name, azure_shared_token, and `azure_path. A 400 or 422 indicates an invalid or unprocessable request; a 401 indicates missing or invalid authentication, and a 403 indicates the feature is unavailable on your plan.