Workspaces

Get the metadata attributes for a drive including system attributes

get

Get the metadata attributes for a drive including system attributes

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/metadata

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/metadata HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "text",
    "name": "text",
    "keys": [
      "text"
    ],
    "value_type": "str",
    "description": "text",
    "location": "system",
    "default": null,
    "group": "text",
    "options": [
      {
        "id": "text",
        "name": "text",
        "color": "pink",
        "user": true,
        "archived": false
      }
    ],
    "add_new_options": true,
    "restrict_to_types": [
      "IMAGE"
    ],
    "automated": false,
    "prompt": "text",
    "archived": false,
    "locked": false
  }
]

Add metadata attributes to a drive

post

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/metadata

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/metadata HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "metadata": {
    "id": "text",
    "name": "text",
    "keys": [
      "text"
    ],
    "value_type": "str",
    "description": "text",
    "location": "system",
    "default": null,
    "group": "text",
    "options": [
      {
        "id": "text",
        "name": "text",
        "color": "pink",
        "user": true,
        "archived": false
      }
    ],
    "add_new_options": true,
    "restrict_to_types": [
      "IMAGE"
    ],
    "automated": false,
    "prompt": "text",
    "archived": false,
    "locked": false
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "name": "text",
  "keys": [
    "text"
  ],
  "value_type": "str",
  "description": "text",
  "location": "system",
  "default": null,
  "group": "text",
  "options": [
    {
      "id": "text",
      "name": "text",
      "color": "pink",
      "user": true,
      "archived": false
    }
  ],
  "add_new_options": true,
  "restrict_to_types": [
    "IMAGE"
  ],
  "automated": false,
  "prompt": "text",
  "archived": false,
  "locked": false
}

Archive metadata attribute on a drive

post

Path parameters

drive_idstring · uuidRequired

metadata_idstringRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

archivebooleanRequired

Archive metadata attribute or not

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/metadata/{metadata_id}

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/metadata/{metadata_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "archive": true,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Update a metadata attribute on a drive

put

Path parameters

drive_idstring · uuidRequired

metadata_idstringRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

nameany ofOptional

The metadata name to update

stringOptional

or

nullOptional

automatedany ofOptional

The metadata automated to update

booleanOptional

or

nullOptional

promptany ofOptional

The metadata prompt to update

stringOptional

or

nullOptional

defaultany ofOptional

The metadata default to update

stringOptional

or

nullOptional

add_new_optionsany ofOptional

Whether or not we're allowed to add new options

booleanOptional

or

nullOptional

optionsany ofOptional

The metadata options to update

or

nullOptional

rerunany ofOptional

Whether or not to rerun the AI on all cells including existing ones

Default: false

booleanOptional

or

nullOptional

lockedany ofOptional

Whether or not the metadata attribute is locked to managers only

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}/metadata/{metadata_id}

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id}/metadata/{metadata_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "name": "text",
  "automated": true,
  "prompt": "text",
  "default": "text",
  "add_new_options": true,
  "options": [
    {
      "id": "text",
      "name": "text",
      "color": "pink",
      "user": true,
      "archived": false
    }
  ],
  "rerun": false,
  "locked": true,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "name": "text",
  "keys": [
    "text"
  ],
  "value_type": "str",
  "description": "text",
  "location": "system",
  "default": null,
  "group": "text",
  "options": [
    {
      "id": "text",
      "name": "text",
      "color": "pink",
      "user": true,
      "archived": false
    }
  ],
  "add_new_options": true,
  "restrict_to_types": [
    "IMAGE"
  ],
  "automated": false,
  "prompt": "text",
  "archived": false,
  "locked": false
}

Create a metadata attribute option on a drive

post

Path parameters

drive_idstring · uuidRequired

metadata_idstringRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

option_namestringRequired

The option name to add to the metadata attribute

option_colorstring · enumRequired

The option color to add to the metadata attribute

Possible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/metadata/{metadata_id}/option

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/metadata/{metadata_id}/option HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "option_name": "text",
  "option_color": "pink",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "name": "text",
  "color": "pink",
  "user": true,
  "archived": false
}

Shares a file (or folder) w user

post

Share a file on a workspace.

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

pathstring · pathRequired

The directory path of the file to share

urlany ofOptional

The url of the file

stringOptional

or

nullOptional

messageany ofOptional

The message to send to the invited users

Default: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/share-file

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/share-file HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "path": "text",
  "invites": [
    {
      "email": "[email protected]",
      "role": 50
    }
  ],
  "url": "text",
  "message": "",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get all the shares for a specific file

get

Share a file on a workspace. ToDo: Remove this route once Emerson deploys windows! probably in a month. Do not use this route, only for backwards compatibility.

Path parameters

drive_idstring · uuidRequired

Query parameters

pathstring · pathRequired

The directory path to list items

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/file-shares

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/file-shares?path=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "workspace_member_inherited_role": 60,
  "drive_member_inherited_role": 50,
  "guests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "avatar_url": "text",
      "user_type": "regular",
      "role": 50,
      "via": "workspace"
    }
  ],
  "icon": "text",
  "icon_type": "color",
  "public_sharing_id": "123e4567-e89b-12d3-a456-426614174000",
  "public_sharing_path_name": "text",
  "public_sharing_role": 50
}

Get all files shared with a user

get

Get all files shared with a user on a drive

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/shared

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/shared HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "drive_identifier": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "asset": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "drive_id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "name": "text",
      "extension": "text",
      "updated": "2026-01-15T00:43:52.489Z",
      "created": "2026-01-15T00:43:52.489Z",
      "type": "IMAGE",
      "size_bytes": 1,
      "stack_id": "123e4567-e89b-12d3-a456-426614174000",
      "stack_number": 1,
      "is_fs_draft_blob": true,
      "is_fs_null_blob": true,
      "rating": 1,
      "ai_indexed": true,
      "system_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "custom_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "category": "text",
      "palette": [
        [
          1
        ]
      ],
      "ocr": "text",
      "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
      "faces_present": true,
      "content_length": 1,
      "preview_job_state": "NOT_STARTED",
      "metadata_job_state": "NOT_STARTED",
      "core_vision_job_state": "NOT_STARTED",
      "color_palette_job_state": "NOT_STARTED",
      "core_audio_job_state": "NOT_STARTED",
      "audio_job_state": "NOT_STARTED",
      "facial_recognition_job_state": "NOT_STARTED",
      "proxy_job_state": "NOT_STARTED",
      "audio_proxy_job_state": "NOT_STARTED",
      "transcription_job_state": "NOT_STARTED",
      "objects": [],
      "texture_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "integration_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "preview_images": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "frame": 1,
          "signed_url": "text"
        }
      ],
      "custom_thumbnail": "text",
      "proxy": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "audio_proxy": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "path": "text",
    "role": 1,
    "actions": [
      "manage"
    ]
  }
]

Removes a share from a path

delete

Path parameters

drive_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

pathstring · pathRequired

The directory path to list items

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

delete

/workspaces/drives/{drive_id}/shared/{user_id}/path

HTTPcURLJavaScriptPython

DELETE /workspaces/drives/{drive_id}/shared/{user_id}/path HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "path": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Updates people's permissions on a path

put

Path parameters

drive_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

roleinteger · enumRequiredPossible values:

pathstring · pathRequired

upsertany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}/users/{user_id}/path

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id}/users/{user_id}/path HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "role": 50,
  "path": "text",
  "upsert": false,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Toggles public sharing on or off

post

Enables or disables public links on files and folders. ToDo: Remove this route once Emerson deploys windows! probably in a month. Do not use this route, only for backwards compatibility.

Path parameters

drive_idstring · uuidRequired

The id of the drive

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

pathstring · pathRequired

The directory path to list items

enablebooleanRequired

roleinteger · enumRequiredPossible values:

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/public-link

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/public-link HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "path": "text",
  "enable": true,
  "role": 50,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Lists all the user for a specific path (file or folder).

get

Path parameters

drive_idstring · uuidRequired

Query parameters

pathstring · pathRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/file-users

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/file-users?path=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "invited": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "avatar_url": "text",
      "user_type": "regular",
      "role": 50,
      "via": "workspace",
      "is_contractor": false,
      "is_workspace_member": false,
      "is_inheriting_as_workspace_member": false,
      "is_pending": false
    }
  ],
  "not_invited": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "avatar_url": "text",
      "user_type": "regular",
      "role": 50
    }
  ]
}

Get your role + actions you can do on a folder (or file if you pass a path)

get

Get your role + actions you can do on a file (asset). No need to auth these bc you are checking your role and would get none if you don't have auth.

Path parameters

drive_idstring · uuidRequired

Query parameters

pathstring · pathRequired

The directory path to list items

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/folder-permissions

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/folder-permissions?path=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "role": 50,
  "actions": [
    "manage"
  ],
  "via": "workspace"
}

Get your role + actions you can do on an asset

get

Get your role + actions you can do on a file (asset). No need to auth these bc you are checking your role and would get none if you don't have auth.

Path parameters

drive_idstring · uuidRequired

Query parameters

asset_idstring · uuidRequired

The id of the file (asset id)

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/file-permissions

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/file-permissions?asset_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "role": 50,
  "actions": [
    "manage"
  ],
  "via": "workspace"
}

Authorize path

get

Check whether a user is authed on a path in a drive.

Path parameters

drive_idstring · uuidRequired

Query parameters

pathstring · pathRequired

The directory path to authorize

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/authorize

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/authorize?path=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Lists all the paths for a specific workspace

get

For drive and workspace users, list their access and paths.

Path parameters

drive_idstring · uuidRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/user-paths

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/user-paths HTTP/1.1
Host: 
Accept: */*

{
  "drive": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "icon": "text",
    "settings": {
      "max_storage_bytes": 1,
      "mount_path_macos": "text",
      "mount_path_linux": "text",
      "mount_path_windows": "text"
    },
    "type": "catalog",
    "identifier": "text",
    "icon_type": "color",
    "member_inherited_role": 50,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "byos": {
      "bucket": "text",
      "endpoint": "text"
    },
    "default_storage_backend": {
      "provider": "text",
      "bucket": "text"
    }
  },
  "paths": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_name": "text",
      "path": "text",
      "role": 50
    }
  ]
}

Lists all the paths for a user in a specific drive

get

Lists all the paths for a specific user on a drive

Path parameters

drive_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/user-paths/{user_id}

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/user-paths/{user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "drive": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "icon": "text",
    "settings": {
      "max_storage_bytes": 1,
      "mount_path_macos": "text",
      "mount_path_linux": "text",
      "mount_path_windows": "text"
    },
    "type": "catalog",
    "identifier": "text",
    "icon_type": "color",
    "member_inherited_role": 50,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "byos": {
      "bucket": "text",
      "endpoint": "text"
    },
    "default_storage_backend": {
      "provider": "text",
      "bucket": "text"
    }
  },
  "paths": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_name": "text",
      "path": "text",
      "role": 50
    }
  ]
}

Lists all the user for a specific drive

get

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/users

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text",
    "user_type": "regular",
    "external_id": "text",
    "joined": "2026-01-15T00:43:52.489Z",
    "role": 50,
    "is_workspace_member": false,
    "is_workspace_owner": false,
    "is_inherited_manager": false,
    "is_contractor": false
  }
]

Sends invites for user to join a drive

post

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

messageany ofRequired

stringOptional

or

nullOptional

Responses

202

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/send-invites

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/send-invites HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "invites": [
    {
      "email": "[email protected]",
      "role": 50
    }
  ],
  "message": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Gets a drive from the drive_id

get

Gets a drive from the drive_id

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "icon": "text",
  "settings": {
    "max_storage_bytes": 1,
    "mount_path_macos": "text",
    "mount_path_linux": "text",
    "mount_path_windows": "text"
  },
  "type": "catalog",
  "identifier": "text",
  "icon_type": "color",
  "member_inherited_role": 50,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "byos": {
    "bucket": "text",
    "endpoint": "text"
  },
  "default_storage_backend": {
    "provider": "text",
    "bucket": "text"
  },
  "actions": [
    "manage"
  ],
  "role": 50,
  "is_workspace_member": false
}

Updates drive

put

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

namestringRequired

descriptionstringRequired

iconstringRequired

icon_typestring · enumRequiredPossible values:

member_inherited_roleinteger · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "text",
  "description": "text",
  "icon": "text",
  "icon_type": "color",
  "member_inherited_role": 50,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "icon": "text",
  "settings": {
    "max_storage_bytes": 1,
    "mount_path_macos": "text",
    "mount_path_linux": "text",
    "mount_path_windows": "text"
  },
  "type": "catalog",
  "identifier": "text",
  "icon_type": "color",
  "member_inherited_role": 50,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "byos": {
    "bucket": "text",
    "endpoint": "text"
  },
  "default_storage_backend": {
    "provider": "text",
    "bucket": "text"
  },
  "actions": [
    "manage"
  ],
  "role": 50,
  "is_workspace_member": false
}

Delete a drive by drive_id

delete

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

delete

/workspaces/drives/{drive_id}

HTTPcURLJavaScriptPython

DELETE /workspaces/drives/{drive_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Updates people's permissions on a drive

put

Path parameters

drive_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

roleinteger · enumRequiredPossible values:

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}/users/{user_id}

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id}/users/{user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "role": 50,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Removes a user from a drive

delete

Path parameters

drive_idstring · uuidRequired

user_idstring · uuidRequired

Query parameters

only_remove_direct_accessany ofOptionalDefault: false

booleanOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

delete

/workspaces/drives/{drive_id}/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /workspaces/drives/{drive_id}/users/{user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Get a signed JWT for a specific drive

get

Path parameters

drive_idstring · uuidRequired

Query parameters

machine_idany ofOptional

The machine ID to embed into the JWT

stringOptional

or

nullOptional

share_idany ofOptional

If provided, only include this specific share path in the token

string · uuidOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

text/plain

Responsestring

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/shade-fs-token

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/shade-fs-token HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

text

Get a signed JWT for Shade Message Bus for a specific drive

get

Path parameters

drive_idstring · uuidRequired

Query parameters

share_idany ofOptional

If user not authenticated, a share id must be passed for a publish path

string · uuidOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

text/plain

Responsestring

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/shade-message-bus-token

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/shade-message-bus-token HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

text

Get all the shared links from a drive

get

Get all shared links for a drive.

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/drive-shared-links

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/drive-shared-links HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_public_enabled": true,
    "allowed_actions": [
      "manage"
    ],
    "password_protected": true,
    "name": "text",
    "expiration_date": "2026-01-15T00:43:52.489Z",
    "created": "2026-01-15T00:43:52.489Z",
    "path_name": "text",
    "icon": "text",
    "icon_type": "color",
    "is_expired": false
  }
]

Get all the shares for a specific file

get

Get all public shares for a specific file.

Path parameters

drive_idstring · uuidRequired

Query parameters

pathstring · pathRequired

The directory path to list items

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/drives/{drive_id}/public-file-shares

HTTPcURLJavaScriptPython

GET /workspaces/drives/{drive_id}/public-file-shares?path=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_public_enabled": true,
    "allowed_actions": [
      "manage"
    ],
    "password_protected": true,
    "name": "text",
    "expiration_date": "2026-01-15T00:43:52.489Z",
    "created": "2026-01-15T00:43:52.489Z",
    "path_name": "text",
    "icon": "text",
    "icon_type": "color",
    "is_expired": false
  }
]

Create a public share for a specific file or folder

post

Share a file on a workspace.

Path parameters

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

pathstring · pathRequired

The directory path to list items

is_public_enabledbooleanRequired

Whether the share is enabled

namestringRequired

The name of the share

iconany ofOptional

The icon of the share

stringOptional

or

nullOptional

icon_typeany ofOptional

The icon type of the share

Default: color

string · enumOptionalPossible values:

or

nullOptional

expiration_dateany ofOptional

The expiration date of the share

string · date-timeOptional

or

nullOptional

passwordany ofOptional

The password of the share

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/drives/{drive_id}/public-file-shares

HTTPcURLJavaScriptPython

POST /workspaces/drives/{drive_id}/public-file-shares HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "path": "text",
  "is_public_enabled": true,
  "allowed_actions": [
    "manage"
  ],
  "name": "text",
  "icon": "text",
  "icon_type": "color",
  "expiration_date": "2026-01-15T00:43:52.489Z",
  "password": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_public_enabled": true,
  "allowed_actions": [
    "manage"
  ],
  "password_protected": true,
  "name": "text",
  "expiration_date": "2026-01-15T00:43:52.489Z",
  "created": "2026-01-15T00:43:52.489Z",
  "path_name": "text",
  "icon": "text",
  "icon_type": "color",
  "is_expired": false
}

Update a public share for a specific file or folder

put

Update a public share for a specific file or folder.

Path parameters

drive_idstring · uuidRequired

share_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

is_public_enabledbooleanRequired

Whether the share is enabled

namestringOptional

The name of the share

Default: ""

iconany ofOptional

The icon of the share

stringOptional

or

nullOptional

icon_typeany ofOptional

The icon type of the share

Default: color

string · enumOptionalPossible values:

or

nullOptional

expiration_dateany ofOptional

The expiration date of the share

string · date-timeOptional

or

nullOptional

passwordany ofOptional

The password of the share

stringOptional

or

nullOptional

removed_passwordany ofOptional

remove the public link password

Default: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}/public-file-shares/{share_id}

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id}/public-file-shares/{share_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "is_public_enabled": true,
  "allowed_actions": [
    "manage"
  ],
  "name": "",
  "icon": "text",
  "icon_type": "color",
  "expiration_date": "2026-01-15T00:43:52.489Z",
  "password": "text",
  "removed_password": false,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Delete a public share for a specific file or folder

delete

Share a file on a workspace.

Path parameters

drive_idstring · uuidRequired

share_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

/workspaces/drives/{drive_id}/public-file-shares/{share_id}

HTTPcURLJavaScriptPython

DELETE /workspaces/drives/{drive_id}/public-file-shares/{share_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Update drive settings

put

Path parameters

drive_idstring · uuidRequired

Body

application/json

max_storage_bytesany ofOptional

integerOptional

or

nullOptional

mount_path_macosany ofOptional

stringOptional

or

nullOptional

mount_path_linuxany ofOptional

stringOptional

or

nullOptional

mount_path_windowsany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/drives/{drive_id}/settings

HTTPcURLJavaScriptPython

PUT /workspaces/drives/{drive_id}/settings HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "max_storage_bytes": 1,
  "mount_path_macos": "text",
  "mount_path_linux": "text",
  "mount_path_windows": "text"
}

No content

Lists all the workspaces for that user based on permissions

get

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces

HTTPcURLJavaScriptPython

GET /workspaces HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "domain": "text",
    "thumbnail": "text",
    "member_inherited_role": 60,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "PERSONAL",
    "onboarding": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "settings": {
      "transcription_model": "BEST",
      "default_drive_inheritance": 50
    },
    "trial_started": true,
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "url_subdomain": "text",
      "email_domain": "text",
      "client_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "partnership_type": "BRANDING",
      "discount_amount": 1
    },
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "actions": [
      "manage"
    ],
    "personal": true,
    "role": 60
  }
]

Creates a workspace

post

Create a workspace.

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

url_subdomainany ofOptional

stringOptional

or

nullOptional

namestringRequired

descriptionstringRequired

team_size_analyticsstringRequired

team_domainany ofOptional

stringOptional

or

nullOptional

team_usage_analyticsstringRequired

data_types_analyticsany ofOptional

string[]Optional

or

nullOptional

thumbnailany ofOptional

The profile picture's link to image

stringOptional

or

nullOptional

domainany ofOptional

Custom domain for the workspae

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces

HTTPcURLJavaScriptPython

POST /workspaces HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "url_subdomain": "text",
  "name": "text",
  "description": "text",
  "team_size_analytics": "text",
  "team_domain": "text",
  "team_usage_analytics": "text",
  "data_types_analytics": [
    "text"
  ],
  "thumbnail": "text",
  "domain": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "domain": "text",
  "thumbnail": "text",
  "member_inherited_role": 60,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PERSONAL",
  "onboarding": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "settings": {
    "transcription_model": "BEST",
    "default_drive_inheritance": 50
  },
  "trial_started": true,
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "url_subdomain": "text",
    "email_domain": "text",
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "partnership_type": "BRANDING",
    "discount_amount": 1
  },
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Lists all the drives for a specific workspace

get

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/drives

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/drives HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "icon": "text",
    "settings": {
      "max_storage_bytes": 1,
      "mount_path_macos": "text",
      "mount_path_linux": "text",
      "mount_path_windows": "text"
    },
    "type": "catalog",
    "identifier": "text",
    "icon_type": "color",
    "member_inherited_role": 50,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "byos": {
      "bucket": "text",
      "endpoint": "text"
    },
    "default_storage_backend": {
      "provider": "text",
      "bucket": "text"
    },
    "actions": [
      "manage"
    ],
    "role": 50,
    "is_workspace_member": false
  }
]

Creates a drive in a workspace

post

Create a Drive

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

namestringRequired

descriptionstringRequired

typestring · enumRequiredPossible values:

iconany ofOptional

stringOptional

or

nullOptional

icon_typeany ofRequired

string · enumOptionalPossible values:

or

nullOptional

byosany ofOptional

or

nullOptional

default_storage_backendany ofOptional

or

nullOptional

template_drive_idany ofOptional

string · uuidOptional

or

nullOptional

public_template_keyany ofOptional

string · enumOptionalPossible values:

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/{workspace_id}/drives

HTTPcURLJavaScriptPython

POST /workspaces/{workspace_id}/drives HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 344

{
  "name": "text",
  "description": "text",
  "type": "catalog",
  "icon": "text",
  "icon_type": "color",
  "byos": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "default_storage_backend": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "template_drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "public_template_key": "video_production",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "icon": "text",
  "settings": {
    "max_storage_bytes": 1,
    "mount_path_macos": "text",
    "mount_path_linux": "text",
    "mount_path_windows": "text"
  },
  "type": "catalog",
  "identifier": "text",
  "icon_type": "color",
  "member_inherited_role": 50,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "byos": {
    "bucket": "text",
    "endpoint": "text"
  },
  "default_storage_backend": {
    "provider": "text",
    "bucket": "text"
  },
  "actions": [
    "manage"
  ],
  "role": 50,
  "is_workspace_member": false
}

Lists all user drives (including demo workspace drives)

get

This route is used to get all the drives for a user. The frontend uses this to determine which shadefs drives should be kept/removed

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responsestring · uuid[]

404

Not found

422

Validation Error

application/json

get

/workspaces/drive-ids

HTTPcURLJavaScriptPython

GET /workspaces/drive-ids HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  "123e4567-e89b-12d3-a456-426614174000"
]

Lists all the paths for a user in a specific workspace

get

Lists all the paths for a specific user on a workspace

Path parameters

workspace_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/user-paths/{user_id}

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/user-paths/{user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "drive": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "icon": "text",
      "settings": {
        "max_storage_bytes": 1,
        "mount_path_macos": "text",
        "mount_path_linux": "text",
        "mount_path_windows": "text"
      },
      "type": "catalog",
      "identifier": "text",
      "icon_type": "color",
      "member_inherited_role": 50,
      "invite_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "byos": {
        "bucket": "text",
        "endpoint": "text"
      },
      "default_storage_backend": {
        "provider": "text",
        "bucket": "text"
      }
    },
    "paths": [
      {
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_name": "text",
        "path": "text",
        "role": 50
      }
    ]
  }
]

Lists all the paths for a specific workspace

get

For drive and workspace users, list their access and paths.

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/user-paths

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/user-paths HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "drive": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "icon": "text",
      "settings": {
        "max_storage_bytes": 1,
        "mount_path_macos": "text",
        "mount_path_linux": "text",
        "mount_path_windows": "text"
      },
      "type": "catalog",
      "identifier": "text",
      "icon_type": "color",
      "member_inherited_role": 50,
      "invite_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "byos": {
        "bucket": "text",
        "endpoint": "text"
      },
      "default_storage_backend": {
        "provider": "text",
        "bucket": "text"
      }
    },
    "paths": [
      {
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_name": "text",
        "path": "text",
        "role": 50
      }
    ]
  }
]

Gets the # of available credits on a workspace

post

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseinteger

404

Not found

422

Validation Error

application/json

post

/workspaces{workspace_id}/credits

HTTPcURLJavaScriptPython

POST /workspaces{workspace_id}/credits HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

1

Lists all the drives and your permission level for them

get

This is used for the /admin routes

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/drives/permissions

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/drives/permissions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "drives_you_can_manage": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "icon": "text",
      "settings": {
        "max_storage_bytes": 1,
        "mount_path_macos": "text",
        "mount_path_linux": "text",
        "mount_path_windows": "text"
      },
      "type": "catalog",
      "identifier": "text",
      "icon_type": "color",
      "member_inherited_role": 50,
      "invite_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "byos": {
        "bucket": "text",
        "endpoint": "text"
      },
      "default_storage_backend": {
        "provider": "text",
        "bucket": "text"
      }
    }
  ],
  "drives_you_can_read": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "icon": "text",
      "settings": {
        "max_storage_bytes": 1,
        "mount_path_macos": "text",
        "mount_path_linux": "text",
        "mount_path_windows": "text"
      },
      "type": "catalog",
      "identifier": "text",
      "icon_type": "color",
      "member_inherited_role": 50,
      "invite_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "byos": {
        "bucket": "text",
        "endpoint": "text"
      },
      "default_storage_backend": {
        "provider": "text",
        "bucket": "text"
      }
    }
  ]
}

Lists all the users for a specific workspace

get

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/users

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text",
    "user_type": "regular",
    "external_id": "text",
    "joined": "2026-01-15T00:43:52.489Z",
    "role": 60,
    "is_workspace_member": false,
    "is_workspace_owner": false,
    "is_contractor": false
  }
]

Lists count of all the users for a specific workspace

get

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/users/count

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/users/count HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "total_count": 1,
  "member_count": 1,
  "guest_count": 1,
  "admin_count": 1
}

Gets a workspace from the workspace_id

get

Gets a workspace from the workspace_id

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "domain": "text",
  "thumbnail": "text",
  "member_inherited_role": 60,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PERSONAL",
  "onboarding": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "settings": {
    "transcription_model": "BEST",
    "default_drive_inheritance": 50
  },
  "trial_started": true,
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "url_subdomain": "text",
    "email_domain": "text",
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "partnership_type": "BRANDING",
    "discount_amount": 1
  },
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "actions": [
    "manage"
  ],
  "personal": true,
  "role": 60
}

Updates a workspace

put

Update a workspace.

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

nameany ofOptional

stringOptional

or

nullOptional

domainany ofOptional

stringOptionalPattern: ^[a-zA-Z0-9.-]+$

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

team_size_analyticsany ofOptional

stringOptional

or

nullOptional

team_usage_analyticsany ofOptional

stringOptional

or

nullOptional

data_types_analyticsany ofOptional

string[]Optional

or

nullOptional

thumbnailany ofOptional

The profile picture's byte array

stringOptional

or

nullOptional

onboarding_keyany ofOptional

Workspace onboarding key to set as finished

stringOptional

or

nullOptional

client_metadataany ofOptional

set client metadata

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

PUT /workspaces/{workspace_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "name": "text",
  "domain": "text",
  "description": "text",
  "team_size_analytics": "text",
  "team_usage_analytics": "text",
  "data_types_analytics": [
    "text"
  ],
  "thumbnail": "text",
  "onboarding_key": "text",
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "domain": "text",
  "thumbnail": "text",
  "member_inherited_role": 60,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PERSONAL",
  "onboarding": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "settings": {
    "transcription_model": "BEST",
    "default_drive_inheritance": 50
  },
  "trial_started": true,
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "url_subdomain": "text",
    "email_domain": "text",
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "partnership_type": "BRANDING",
    "discount_amount": 1
  },
  "client_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Deletes a workspace

delete

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

delete

/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspace_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Create an avatar for a workspace

post

Body

application/json

extensionstring · enumRequired

The extension type of the avatar

Possible values:

sizeanyRequired

Size of the avatar

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/avatar/upload-url

HTTPcURLJavaScriptPython

POST /workspaces/avatar/upload-url HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "extension": "png",
  "size": null
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Confirm uploading an avatar for a workspace

post

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

download_urlanyRequired

The download url

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/workspaces/{workspace_id}/avatar/complete

HTTPcURLJavaScriptPython

POST /workspaces/{workspace_id}/avatar/complete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "download_url": null,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Sends invites for user to join a workspace

post

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

messageany ofRequired

The message to send to the invited user

stringOptional

or

nullOptional

Responses

202

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/workspaces/{workspace_id}/send-invites

HTTPcURLJavaScriptPython

POST /workspaces/{workspace_id}/send-invites HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "invites": [
    {
      "email": "[email protected]",
      "role": 60
    }
  ],
  "message": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Gets data for a specific invitation

get

This is a PUBLIC route where anyone can see invites. To see (you've been invited to ... workspace)

Path parameters

invite_idstring · uuidRequired

Responses

200

Successful Response

application/json

Responseany of

or

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/workspaces/invites/{invite_id}

HTTPcURLJavaScriptPython

GET /workspaces/invites/{invite_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sent_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text",
    "user_type": "regular"
  },
  "sent_by_id": "123e4567-e89b-12d3-a456-426614174000",
  "sent_to_email": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "domain": "text",
    "thumbnail": "text",
    "member_inherited_role": 60,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "PERSONAL",
    "onboarding": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "settings": {
      "transcription_model": "BEST",
      "default_drive_inheritance": 50
    },
    "trial_started": true,
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "url_subdomain": "text",
      "email_domain": "text",
      "client_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "partnership_type": "BRANDING",
      "discount_amount": 1
    },
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "workspace_role": 60,
  "invite_type": "drive",
  "invite_target": "user"
}

Accepts invitation

post

This is a PUBLIC route where anyone can accept invites.

Path parameters

invite_idstring · uuidRequired

The id of the invitation to join

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseany of

or

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/workspaces/invites/{invite_id}/join

HTTPcURLJavaScriptPython

POST /workspaces/invites/{invite_id}/join HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sent_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "avatar_url": "text",
    "user_type": "regular"
  },
  "sent_by_id": "123e4567-e89b-12d3-a456-426614174000",
  "sent_to_email": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "domain": "text",
    "thumbnail": "text",
    "member_inherited_role": 60,
    "invite_id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "PERSONAL",
    "onboarding": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "settings": {
      "transcription_model": "BEST",
      "default_drive_inheritance": 50
    },
    "trial_started": true,
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "url_subdomain": "text",
      "email_domain": "text",
      "client_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "partnership_type": "BRANDING",
      "discount_amount": 1
    },
    "client_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "workspace_role": 60,
  "invite_type": "drive",
  "invite_target": "user"
}

Updates people's permissions on a workspace

put

Path parameters

workspace_idstring · uuidRequired

user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

roleinteger · enumRequiredPossible values:

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/{workspace_id}/users/{user_id}

HTTPcURLJavaScriptPython

PUT /workspaces/{workspace_id}/users/{user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "role": 60,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Removes a user from a workspace

delete

Path parameters

workspace_idstring · uuidRequired

The id of the workspace we want to deactivate the user in

user_id_to_removestring · uuidRequired

The id for the user we want to deactivate

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

delete

/workspaces/{workspace_id}/users/{user_id_to_remove}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspace_id}/users/{user_id_to_remove} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Gets a workspace for workspace domain

get

Path parameters

workspace_domainstringRequired

Responses

200

Successful Response

application/json

Responsestring · uuid

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_domain}/domain

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_domain}/domain HTTP/1.1
Host: 
Accept: */*

123e4567-e89b-12d3-a456-426614174000

Gets a drive_id from an identifier

get

Path parameters

drive_identifierstringRequired

workspace_domainstringRequired

Responses

200

Successful Response

application/json

Responsestring · uuid

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_domain}/drives/{drive_identifier}/identifier

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_domain}/drives/{drive_identifier}/identifier HTTP/1.1
Host: 
Accept: */*

123e4567-e89b-12d3-a456-426614174000

Get share data

get

Return the contents of the folder -> an array of AssetDTO

Query parameters

pathany ofOptional

The path under the share to get the data for

stringOptional

or

nullOptional

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Share data includes drive_id, role, actions

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/shares/{share_id}

HTTPcURLJavaScriptPython

GET /workspaces/shares/{share_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "role": 50,
  "actions": [
    "manage"
  ],
  "is_file": false,
  "is_folder": false,
  "root_path": "text",
  "path": "text",
  "preview_image_id": "123e4567-e89b-12d3-a456-426614174000",
  "preview_video_id": "123e4567-e89b-12d3-a456-426614174000",
  "password_protected": false
}

Authorize drive usage

get

Path parameters

actionstring · enumRequiredPossible values:

drive_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/authorize/drives/{drive_id}/{action}

HTTPcURLJavaScriptPython

GET /workspaces/authorize/drives/{drive_id}/{action} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "icon": "text",
  "settings": {
    "max_storage_bytes": 1,
    "mount_path_macos": "text",
    "mount_path_linux": "text",
    "mount_path_windows": "text"
  },
  "type": "catalog",
  "identifier": "text",
  "icon_type": "color",
  "member_inherited_role": 50,
  "invite_id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "byos": {
    "bucket": "text",
    "endpoint": "text"
  },
  "default_storage_backend": {
    "provider": "text",
    "bucket": "text"
  }
}

Update workspace settings

put

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

transcription_modelany ofOptional

New model to set it to

string · enumOptionalPossible values:

or

nullOptional

default_drive_inheritanceany ofOptional

Default access level for workspace members in new drives

integer · enumOptionalPossible values:

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/workspaces/{workspace_id}/settings

HTTPcURLJavaScriptPython

PUT /workspaces/{workspace_id}/settings HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "transcription_model": "BEST",
  "default_drive_inheritance": 50,
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get the FS public key to sign files

get

Responses

200

Successful Response

text/plain

Responsestring

404

Not found

get

/workspaces/shade-fs-public-key

HTTPcURLJavaScriptPython

GET /workspaces/shade-fs-public-key HTTP/1.1
Host: 
Accept: */*

text

Transfer a workspace to a new owner

post

Path parameters

workspace_idstring · uuidRequired

new_owner_user_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

post

/workspaces/{workspace_id}/transfer-ownership/{new_owner_user_id}

HTTPcURLJavaScriptPython

POST /workspaces/{workspace_id}/transfer-ownership/{new_owner_user_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Leave a workspace

post

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

Responseboolean

404

Not found

422

Validation Error

application/json

post

/workspaces/{workspace_id}/leave

HTTPcURLJavaScriptPython

POST /workspaces/{workspace_id}/leave HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

true

Invite a user to a public share

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

emailstringRequired

messagestringRequired

linkstringRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/workspaces/public-file-shares/{share_id}/email

HTTPcURLJavaScriptPython

POST /workspaces/public-file-shares/{share_id}/email HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "email": "text",
  "message": "text",
  "link": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Svix webhook dashboard URL for workspace

get

Generate and return a Svix dashboard URL for the workspace webhooks. User must be an admin, member, or owner of the workspace.

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/webhook-dashboard-url

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/webhook-dashboard-url HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Svix webhook zapier integration key for workspace

get

Generate and return a Svix dashboard URL for the workspace webhooks. User must be an admin, member, or owner of the workspace.

Path parameters

workspace_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/workspaces/{workspace_id}/zapier-integration-key

HTTPcURLJavaScriptPython

GET /workspaces/{workspace_id}/zapier-integration-key HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}