Instantiate and use the client with the following:
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
If you would like to send additional headers as part of the request, use the headers request option.
If you would like to send additional query string parameters as part of the request, use the queryParams request option.
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the maxRetries request option to configure this behavior.
The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.
The SDK allows users to abort requests at any point by passing in an abort signal.
The SDK provides access to raw response data, including headers, through the .withRawResponse() method. The .withRawResponse() method returns a promise that results to an object with a data and a rawResponse property.
The SDK works in the following runtimes:
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you’re running in an unsupported environment, this provides a way for you to break glass and ensure the SDK works.
Update metadata values across multiple files.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.BulkUpdateMetadataParams
requestOptions: Metadata.RequestOptions
Show the metadata of a file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.MetadataShowRequest
requestOptions: Metadata.RequestOptions
Delete account level custom field definitions.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fieldDefinitionId: Frameio.Uuid —
requestOptions: MetadataFields.RequestOptions
Update account level custom field definitions.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid` —
fieldDefinitionId: Frameio.Uuid —
request: Frameio.UpdateFieldDefinitionParams
requestOptions: MetadataFields.RequestOptions
List account level field definitions.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
request: Frameio.MetadataFieldDefinitionsIndexRequest
requestOptions: MetadataFields.RequestOptions
Create account level field definitions.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
request: Frameio.CreateFieldDefinitionParams
requestOptions: MetadataFields.RequestOptions
List user roles for a given project.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.ProjectPermissionsIndexRequest
requestOptions: ProjectPermissions.RequestOptions
Remove a user from a given project.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid` —
projectId: Frameio.Uuid —
userId: Frameio.Uuid —
requestOptions: ProjectPermissions.RequestOptions
Update user roles for the given project if the user is already added to the project. If the user is not added to the project, the user will be added with the given role.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
UserId: Frameio.Uuid —
request: Frameio.UpdateUserRolesParams
requestOptions: ProjectPermissions.RequestOptions
Show project details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.ProjectsShowRequest
requestOptions: Projects.RequestOptions
Delete a project.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid` —
projectId: Frameio.Uuid —
requestOptions: Projects.RequestOptions
Update project details.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.ProjectUpdateParams
requestOptions: Projects.RequestOptions
List projects in a given workspace.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.ProjectsIndexRequest
requestOptions: Projects.RequestOptions
Create project in a given workspace.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.ProjectsParams
requestOptions: Projects.RequestOptions
Show folder details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.FoldersShowRequest
requestOptions: Folders.RequestOptions
Delete folder by id.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
requestOptions: Folders.RequestOptions
Update folder details.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FolderUpdateParams
requestOptions: Folders.RequestOptions
List the children in the given folder.
Use the include query parameter to selectively include additional properties in the response.
media_links.original and the user does not have permission to download files in the corresponding project, then this endpoint will respond with a 403 Forbidden error. If the content is inaccessible because watermarking is required for this user and isn’t supported by the requested media_links, then the request will succeed but the unsupported media links will be set to null. Similarly, if a requested transcode link does not exist for a particular file (e.g. including media_links.video_h264_180 on a static image file) or transoding process hasn’t finished (i.e. the file’s status is “uploaded” rather than “transcoded”), then the a media link will also be set to null in the response payload. In short, the client must handle null media links gracefully.Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FolderIndexRequest
requestOptions: Folders.RequestOptions
Copy folder.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FolderCopyParams
requestOptions: Folders.RequestOptions
List folders in a given folder.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FoldersListRequest
requestOptions: Folders.RequestOptions
Create a new folder inside the given folder_id path param.
Rate Limits: 3 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FolderCreateParams
requestOptions: Folders.RequestOptions
Move folder to a folder.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FolderMoveParams
requestOptions: Folders.RequestOptions
List the children (files) in a given version stack.
Use the include query parameter to selectively include additional properties in the response.
media_links.original and the user does not have permission to download files in the corresponding project, then this endpoint will respond with a 403 Forbidden error. If the content is inaccessible because watermarking is required for this user and isn’t supported by the requested media_links, then the request will succeed but the unsupported media links will be set to null. Similarly, if a requested transcode link does not exist for a particular file (e.g. including media_links.video_h264_180 on a static image file) or transoding process hasn’t finished (i.e. the file’s status is “uploaded” rather than “transcoded”), then the a media link will also be set to null in the response payload. In short, the client must handle null media links gracefully.Parameters
accountId: Frameio.Uuid —
projectId: Frameio.Uuid —
request: Frameio.VersionStacksIndexRequest
requestOptions: VersionStacks.RequestOptions
Show version stack details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
versionStackId: Frameio.Uuid —
request: Frameio.VersionStacksShowRequest
requestOptions: VersionStacks.RequestOptions
Copy version stack.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
versionStackId: Frameio.Uuid —
request: Frameio.VersionStackCopyParams
requestOptions: VersionStacks.RequestOptions
List version stacks in a given folder.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.VersionStacksListRequest
requestOptions: VersionStacks.RequestOptions
Create a new Version Stack under the parent folder.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.VersionStackCreateParams
requestOptions: VersionStacks.RequestOptions
Move version stack to a folder.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.VersionStackMoveParams
requestOptions: VersionStacks.RequestOptions
List user roles for a given account.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
request: Frameio.AccountPermissionsIndexRequest
requestOptions: AccountPermissions.RequestOptions
List accounts for the current user.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
request: Frameio.AccountsIndexRequest
requestOptions: Accounts.RequestOptions
Show a single comment on a file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
commentId: Frameio.Uuid —
request: Frameio.CommentsShowRequest
requestOptions: Comments.RequestOptions
Delete comment from an asset.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
commentId: Frameio.Uuid —
requestOptions: Comments.RequestOptions
Update comment on given asset.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
commentId: Frameio.Uuid —
request: Frameio.UpdateCommentParams
requestOptions: Comments.RequestOptions
List comments on a given asset.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.CommentsIndexRequest
requestOptions: Comments.RequestOptions
Create a comment on a file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.CreateCommentParams
requestOptions: Comments.RequestOptions
List webhooks for the given workspace.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.WebhooksIndexRequest
requestOptions: Webhooks.RequestOptions
Creates a single webhook with secret.
Valid events:
file.created,
file.deleted,
file.ready,
file.updated,
file.upload.completed,
file.versioned,
file.copied,
folder.created,
folder.deleted,
folder.updated,
folder.copied,
comment.completed,
comment.created,
comment.deleted,
comment.uncompleted,
comment.updated,
customfield.created,
customfield.updated,
customfield.deleted,
metadata.value.updated,
project.created,
project.deleted,
project.updated,
collection.created,
collection.updated,
collection.deleted,
share.created,
share.updated,
share.deleted,
share.viewed
Rate Limits: 10 calls per 1.00 minute(s) per account
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.WebhookCreateParams
requestOptions: Webhooks.RequestOptions
Show webhook details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
webhookId: Frameio.Uuid —
request: Frameio.WebhooksShowRequest
requestOptions: Webhooks.RequestOptions
Delete a webhook.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
webhookId: Frameio.Uuid —
requestOptions: Webhooks.RequestOptions
Update webhook details.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
webhookId: Frameio.Uuid —
request: Frameio.WebhookUpdateParams`
requestOptions: Webhooks.RequestOptions
List user roles for a given workspace.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.WorkspacePermissionsIndexRequest
requestOptions: WorkspacePermissions.RequestOptions
Remove a user from a given workspace.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
userId: Frameio.Uuid —
requestOptions: WorkspacePermissions.RequestOptions
Update user roles for the given workspace if the user is already added to the workspace. If the user is not added to the workspace, the user will be added with the given role.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
userId: Frameio.Uuid —
request: Frameio.UpdateUserRolesParams
requestOptions: WorkspacePermissions.RequestOptions
Show workspace details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.WorkspacesShowRequest
requestOptions: Workspaces.RequestOptions
Delete workspace from account.
Rate Limits: 60 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
requestOptions: Workspaces.RequestOptions
Update a workspace.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
workspaceId: Frameio.Uuid —
request: Frameio.WorkspaceParams
requestOptions: Workspaces.RequestOptions
List workspaces for a given account.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
request: Frameio.WorkspacesIndexRequest
requestOptions: Workspaces.RequestOptions
Create workspace from an account.
Rate Limits: 10 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
request: Frameio.WorkspaceParams
requestOptions: Workspaces.RequestOptions
List files in a given folder.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FilesListRequest
requestOptions: Files.RequestOptions
Create new file under parent folder. Create file (local upload) and Create file (remote upload) have replaced this endpoint.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FileCreateParams
requestOptions: Files.RequestOptions
Show file details.
Use the include query parameter to selectively include additional properties in the response.
media_links.original and the user does not have permission to download the file then this endpoint will respond with a 403 Forbidden error. If the content is inaccessible because watermarking is required for this user and isn’t supported by the requested media_links, then the request will succeed but the unsupported media links will be set to null. Similarly, if a requested transcode link does not exist for a particular file (e.g. including media_links.video_h264_180 on a static image file) or transoding process hasn’t completed (i.e. the file’s status is “uploaded” rather than “transcoded”), then the link will also be set to null in the response payload. In short, the client must handle null media links gracefully.Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FilesShowRequest
requestOptions: Files.RequestOptions
Delete file by ID.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
requestOptions: Files.RequestOptions
Update file details.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.FileUpdateParams
requestOptions: Files.RequestOptions
Copy file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.FileCopyParams
requestOptions: Files.RequestOptions
Create new file under parent folder through remote upload.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FileCreateRemoteUploadParams
requestOptions: Files.RequestOptions
Move file to a folder or version_stack.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
request: Frameio.FileMoveParams
requestOptions: Files.RequestOptions
Create new file under parent folder through local upload.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
folderId: Frameio.Uuid —
request: Frameio.FileCreateLocalUploadParams
requestOptions: Files.RequestOptions
Show file upload status details.
Rate Limits: 5 calls per 1 second(s) per account_user
Parameters
accountId: Frameio.Uuid —
fileId: Frameio.Uuid —
requestOptions: Files.RequestOptions
Inspect details of the user associated with the bearer token.
Rate Limits: 100 calls per 1.00 minute(s) per account_user
Parameters
requestOptions: Users.RequestOptions