Cloudinary API reference

New to Corsair? See API access, authentication, and error handling.

Adaptive

getAdaptiveStreamingProfiles

adaptive.getAdaptiveStreamingProfiles List streaming profiles Risk: read

await corsair.cloudinary.api.adaptive.getAdaptiveStreamingProfiles({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

Analysis

getAnalysisTaskStatus

analysis.getAnalysisTaskStatus Get analysis task status Risk: read

await corsair.cloudinary.api.analysis.getAnalysisTaskStatus({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`task_id`	`string`	Yes	—

Output: Record<string, any>

Asset

createAssetRelationsByAssetId

asset.createAssetRelationsByAssetId Add related assets by asset ID Risk: write

await corsair.cloudinary.api.asset.createAssetRelationsByAssetId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_id`	`string`	Yes	—

Output: Record<string, any>

createAssetRelationsByPublicId

asset.createAssetRelationsByPublicId Add related assets by public ID Risk: write

await corsair.cloudinary.api.asset.createAssetRelationsByPublicId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—
`public_id`	`string`	Yes	—

Output: Record<string, any>

deleteAssetRelationsByAssetId

asset.deleteAssetRelationsByAssetId Remove related assets by asset ID Risk: destructive

await corsair.cloudinary.api.asset.deleteAssetRelationsByAssetId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

deleteAssetRelationsByPublicId

asset.deleteAssetRelationsByPublicId Remove related assets by public ID Risk: destructive

await corsair.cloudinary.api.asset.deleteAssetRelationsByPublicId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—
`public_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

destroyAsset

asset.destroyAsset Destroy asset by public ID Risk: destructive · Irreversible

await corsair.cloudinary.api.asset.destroyAsset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

destroyAssetById

asset.destroyAssetById Destroy asset by asset ID Risk: destructive · Irreversible

await corsair.cloudinary.api.asset.destroyAssetById({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

updateAssetMetadata

asset.updateAssetMetadata Update asset metadata values Risk: write

await corsair.cloudinary.api.asset.updateAssetMetadata({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

uploadAsset

asset.uploadAsset Upload media asset Risk: write

await corsair.cloudinary.api.asset.uploadAsset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Assets

searchAssets

assets.searchAssets Search assets with Lucene-like expressions Risk: read

await corsair.cloudinary.api.assets.searchAssets({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

searchVisualAssets

assets.searchVisualAssets Visual search for similar assets Risk: read

await corsair.cloudinary.api.assets.searchVisualAssets({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

Chunk

uploadChunk

chunk.uploadChunk Upload a file chunk for large uploads (requires content_range and x_unique_upload_id) Risk: write

await corsair.cloudinary.api.chunk.uploadChunk({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Cloudinary

pingCloudinaryServers

cloudinary.pingCloudinaryServers Ping Cloudinary servers Risk: read

await corsair.cloudinary.api.cloudinary.pingCloudinaryServers({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`status`	`string`	Yes	—

Config

getConfig

config.getConfig Get product environment config Risk: read

await corsair.cloudinary.api.config.getConfig({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

Context

manageContext

context.manageContext Add or remove contextual metadata Risk: write

await corsair.cloudinary.api.context.manageContext({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Create

createTrigger

create.createTrigger Create webhook trigger Risk: write

await corsair.cloudinary.api.create.createTrigger({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`uri`	`string`	Yes	—
`event_type`	`string`	Yes	—
`additive`	`boolean`	No	—
`auth_scheme`	`string`	No	—

Datasource

searchDatasourceInMetadataField

datasource.searchDatasourceInMetadataField Search datasource in metadata field Risk: read

await corsair.cloudinary.api.datasource.searchDatasourceInMetadataField({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—
`term`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output: Record<string, any>

Delete

deleteTrigger

delete.deleteTrigger Delete webhook trigger Risk: destructive · Irreversible

await corsair.cloudinary.api.delete.deleteTrigger({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`trigger_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

Derived

deleteDerivedResources

derived.deleteDerivedResources Delete derived resources Risk: destructive · Irreversible

await corsair.cloudinary.api.derived.deleteDerivedResources({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

Entries

deleteEntriesInMetadataFieldDatasource

entries.deleteEntriesInMetadataFieldDatasource Delete datasource entries Risk: destructive

await corsair.cloudinary.api.entries.deleteEntriesInMetadataFieldDatasource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

restoreEntriesInMetadataFieldDatasource

entries.restoreEntriesInMetadataFieldDatasource Restore datasource entries Risk: write

await corsair.cloudinary.api.entries.restoreEntriesInMetadataFieldDatasource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

File

uploadFileAutoDetect

file.uploadFileAutoDetect Upload with auto resource type detection Risk: write

await corsair.cloudinary.api.file.uploadFileAutoDetect({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Folder

createFolder

folder.createFolder Create a new asset folder Risk: write

await corsair.cloudinary.api.folder.createFolder({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`path`	`string`	No	—
`external_id`	`string`	No	—

deleteFolder

folder.deleteFolder Delete an empty folder Risk: destructive · Irreversible

await corsair.cloudinary.api.folder.deleteFolder({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

showFolder

folder.showFolder List subfolders in a folder Risk: read

await corsair.cloudinary.api.folder.showFolder({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`folders`	`object[]`	No	—

folders full type

{
  name: string,
  path?: string,
  external_id?: string
}[]

updateFolder

folder.updateFolder Rename or move a folder Risk: write

await corsair.cloudinary.api.folder.updateFolder({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—
`to_folder`	`any`	No	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`path`	`string`	No	—
`external_id`	`string`	No	—

Folders

searchFolders

folders.searchFolders Search asset folders Risk: read

await corsair.cloudinary.api.folders.searchFolders({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`expression`	`any`	No	—
`sort_by`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`folders`	`object[]`	No	—

folders full type

{
  name: string,
  path?: string,
  external_id?: string
}[]

searchFoldersV2

folders.searchFoldersV2 Search folders (v2 POST) Risk: read

await corsair.cloudinary.api.folders.searchFoldersV2({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`folders`	`object[]`	No	—

folders full type

{
  name: string,
  path?: string,
  external_id?: string
}[]

Generate

generateArchive

generate.generateArchive Generate ZIP/TGZ archive of assets Risk: write

await corsair.cloudinary.api.generate.generateArchive({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

Image

createImageFromText

image.createImageFromText Generate an image from text Risk: write

await corsair.cloudinary.api.image.createImageFromText({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Images

listImages

images.listImages List image assets Risk: read

await corsair.cloudinary.api.images.listImages({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`any`	No	—
`prefix`	`any`	No	—
`public_ids`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`start_at`	`any`	No	—
`direction`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderation`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

Live

activateLiveStream

live.activateLiveStream Manually activate a live stream Risk: write

await corsair.cloudinary.api.live.activateLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

createLiveStream

live.createLiveStream Create a new live stream Risk: write

await corsair.cloudinary.api.live.createLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

createLiveStreamOutput

live.createLiveStreamOutput Create a live stream output Risk: write

await corsair.cloudinary.api.live.createLiveStreamOutput({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

deleteLiveStream

live.deleteLiveStream Delete a live stream Risk: destructive · Irreversible

await corsair.cloudinary.api.live.deleteLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

deleteLiveStreamOutput

live.deleteLiveStreamOutput Delete a live stream output Risk: destructive · Irreversible

await corsair.cloudinary.api.live.deleteLiveStreamOutput({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—
`liveStreamOutputId`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getLiveStream

live.getLiveStream Get live stream details Risk: read

await corsair.cloudinary.api.live.getLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

getLiveStreamOutput

live.getLiveStreamOutput Get live stream output details Risk: read

await corsair.cloudinary.api.live.getLiveStreamOutput({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—
`liveStreamOutputId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

getLiveStreamOutputs

live.getLiveStreamOutputs List live stream outputs Risk: read

await corsair.cloudinary.api.live.getLiveStreamOutputs({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output: object \| object[]

Output full type

{
  next_cursor?: string | null,
  total_count?: number,
  live_streams?: {
    id: string,
    name?: string,
    status?: string,
    uri?: string,
    stream_key?: string,
    created_at?: string
  }[]
} | {
  id: string,
  name?: string,
  status?: string,
  uri?: string,
  stream_key?: string,
  created_at?: string
}[]

getLiveStreams

live.getLiveStreams List live streams Risk: read

await corsair.cloudinary.api.live.getLiveStreams({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output: object \| object[]

Output full type

{
  next_cursor?: string | null,
  total_count?: number,
  live_streams?: {
    id: string,
    name?: string,
    status?: string,
    uri?: string,
    stream_key?: string,
    created_at?: string
  }[]
} | {
  id: string,
  name?: string,
  status?: string,
  uri?: string,
  stream_key?: string,
  created_at?: string
}[]

idleLiveStream

live.idleLiveStream Put a live stream into idle state Risk: write

await corsair.cloudinary.api.live.idleLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

updateLiveStream

live.updateLiveStream Update live stream configuration Risk: write

await corsair.cloudinary.api.live.updateLiveStream({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

updateLiveStreamOutput

live.updateLiveStreamOutput Update live stream output configuration Risk: write

await corsair.cloudinary.api.live.updateLiveStreamOutput({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`liveStreamId`	`string`	Yes	—
`liveStreamOutputId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`uri`	`string`	No	—
`stream_key`	`string`	No	—
`created_at`	`string`	No	—

Mapping

createUploadMapping

mapping.createUploadMapping Create upload mapping Risk: write

await corsair.cloudinary.api.mapping.createUploadMapping({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`folder`	`string`	Yes	—
`template`	`string`	No	—

deleteUploadMapping

mapping.deleteUploadMapping Delete upload mapping Risk: destructive · Irreversible

await corsair.cloudinary.api.mapping.deleteUploadMapping({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getUploadMappingDetails

mapping.getUploadMappingDetails Get upload mapping details Risk: read

await corsair.cloudinary.api.mapping.getUploadMappingDetails({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—

Output

Name	Type	Required	Description
`folder`	`string`	Yes	—
`template`	`string`	No	—

updateUploadMapping

mapping.updateUploadMapping Update upload mapping Risk: write

await corsair.cloudinary.api.mapping.updateUploadMapping({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`folder`	`string`	Yes	—

Output

Name	Type	Required	Description
`folder`	`string`	Yes	—
`template`	`string`	No	—

Mappings

getUploadMappings

mappings.getUploadMappings List upload mappings Risk: read

await corsair.cloudinary.api.mappings.getUploadMappings({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`mappings`	`object[]`	No	—

mappings full type

{
  folder: string,
  template?: string
}[]

Metadata

createMetadataField

metadata.createMetadataField Create metadata field definition Risk: write

await corsair.cloudinary.api.metadata.createMetadataField({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

createMetadataRule

metadata.createMetadataRule Create metadata rule Risk: write

await corsair.cloudinary.api.metadata.createMetadataRule({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`condition`	`Record<string, any>`	No	—
`result`	`Record<string, any>`	No	—

deleteMetadataField

metadata.deleteMetadataField Delete metadata field Risk: destructive · Irreversible

await corsair.cloudinary.api.metadata.deleteMetadataField({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

deleteMetadataRule

metadata.deleteMetadataRule Delete metadata rule Risk: destructive · Irreversible

await corsair.cloudinary.api.metadata.deleteMetadataRule({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`metadata_rule_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getMetadataFieldById

metadata.getMetadataFieldById Get metadata field by external ID Risk: read

await corsair.cloudinary.api.metadata.getMetadataFieldById({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

listMetadataFields

metadata.listMetadataFields List metadata fields Risk: read

await corsair.cloudinary.api.metadata.listMetadataFields({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_ids`	`any`	No	—

Output

Name	Type	Required	Description
`metadata_fields`	`object[]`	No	—

metadata_fields full type

{
  external_id: string,
  label?: string,
  type?: string,
  mandatory?: boolean,
  default_value?: any,
  datasource?: {
    values?: Record<string, any>[]
  }
}[]

listMetadataRules

metadata.listMetadataRules List metadata rules Risk: read

await corsair.cloudinary.api.metadata.listMetadataRules({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`rules`	`object[]`	No	—

rules full type

{
  id: string,
  name?: string,
  condition?: Record<string, any>,
  result?: Record<string, any>
}[]

orderMetadataFieldDatasource

metadata.orderMetadataFieldDatasource Order metadata field datasource Risk: write

await corsair.cloudinary.api.metadata.orderMetadataFieldDatasource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

reorderMetadataField

metadata.reorderMetadataField Reorder a metadata field Risk: write

await corsair.cloudinary.api.metadata.reorderMetadataField({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

reorderMetadataFields

metadata.reorderMetadataFields Reorder all metadata fields Risk: write

await corsair.cloudinary.api.metadata.reorderMetadataFields({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

searchMetadataFieldDatasource

metadata.searchMetadataFieldDatasource Search all metadata datasources Risk: read

await corsair.cloudinary.api.metadata.searchMetadataFieldDatasource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`term`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output: Record<string, any>

updateMetadataField

metadata.updateMetadataField Update metadata field definition Risk: write

await corsair.cloudinary.api.metadata.updateMetadataField({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

updateMetadataFieldDatasource

metadata.updateMetadataFieldDatasource Update metadata field datasource Risk: write

await corsair.cloudinary.api.metadata.updateMetadataFieldDatasource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`external_id`	`string`	Yes	—
`label`	`string`	No	—
`type`	`string`	No	—
`mandatory`	`boolean`	No	—
`default_value`	`any`	No	—
`datasource`	`object`	No	—

datasource full type

{
  values?: Record<string, any>[]
}

updateMetadataRule

metadata.updateMetadataRule Update metadata rule Risk: write

await corsair.cloudinary.api.metadata.updateMetadataRule({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`metadata_rule_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`condition`	`Record<string, any>`	No	—
`result`	`Record<string, any>`	No	—

Multi

createMultiResource

multi.createMultiResource Create animation from multiple images Risk: write

await corsair.cloudinary.api.multi.createMultiResource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Preset

createUploadPreset

preset.createUploadPreset Create upload preset Risk: write

await corsair.cloudinary.api.preset.createUploadPreset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`unsigned`	`boolean`	No	—
`settings`	`Record<string, any>`	No	—

deleteUploadPreset

preset.deleteUploadPreset Delete upload preset Risk: destructive · Irreversible

await corsair.cloudinary.api.preset.deleteUploadPreset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getUploadPreset

preset.getUploadPreset Get upload preset Risk: read

await corsair.cloudinary.api.preset.getUploadPreset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`unsigned`	`boolean`	No	—
`settings`	`Record<string, any>`	No	—

updateUploadPreset

preset.updateUploadPreset Update upload preset Risk: write

await corsair.cloudinary.api.preset.updateUploadPreset({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`unsigned`	`boolean`	No	—
`settings`	`Record<string, any>`	No	—

Presets

listUploadPresets

presets.listUploadPresets List upload presets Risk: read

await corsair.cloudinary.api.presets.listUploadPresets({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`presets`	`object[]`	No	—

presets full type

{
  name: string,
  unsigned?: boolean,
  settings?: Record<string, any>
}[]

Raw

listRawFiles

raw.listRawFiles List raw assets Risk: read

await corsair.cloudinary.api.raw.listRawFiles({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`any`	No	—
`prefix`	`any`	No	—
`public_ids`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`start_at`	`any`	No	—
`direction`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderation`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

Resource

explicitResource

resource.explicitResource Explicitly update or generate derived assets Risk: write

await corsair.cloudinary.api.resource.explicitResource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

explodeResource

resource.explodeResource Explode multi-page resource into separate images Risk: write

await corsair.cloudinary.api.resource.explodeResource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

getResourceByAssetId

resource.getResourceByAssetId Get resource by asset ID Risk: read

await corsair.cloudinary.api.resource.getResourceByAssetId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_id`	`string`	Yes	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`quality_analysis`	`any`	No	—
`accessibility_analysis`	`any`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

getResourceByPublicId

resource.getResourceByPublicId Get resource by public ID Risk: read

await corsair.cloudinary.api.resource.getResourceByPublicId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—
`public_id`	`string`	Yes	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`quality_analysis`	`any`	No	—
`accessibility_analysis`	`any`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

listResourceTypes

resource.listResourceTypes List available resource types Risk: read

await corsair.cloudinary.api.resource.listResourceTypes({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`resource_types`	`string[]`	Yes	—

renameResource

resource.renameResource Rename or move resource public ID Risk: write

await corsair.cloudinary.api.resource.renameResource({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

updateResourceByAssetId

resource.updateResourceByAssetId Update resource by asset ID Risk: write

await corsair.cloudinary.api.resource.updateResourceByAssetId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

updateResourceByPublicId

resource.updateResourceByPublicId Update resource by public ID Risk: write

await corsair.cloudinary.api.resource.updateResourceByPublicId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—
`public_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

updateResourceTags

resource.updateResourceTags Add, remove, or replace resource tags Risk: write

await corsair.cloudinary.api.resource.updateResourceTags({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

Resources

deleteResourcesByAssetId

resources.deleteResourcesByAssetId Delete resources by asset IDs Risk: destructive · Irreversible

await corsair.cloudinary.api.resources.deleteResourcesByAssetId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

deleteResourcesByPublicId

resources.deleteResourcesByPublicId Delete resources by public ID Risk: destructive · Irreversible

await corsair.cloudinary.api.resources.deleteResourcesByPublicId({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

deleteResourcesByTags

resources.deleteResourcesByTags Delete resources by tag Risk: destructive · Irreversible

await corsair.cloudinary.api.resources.deleteResourcesByTags({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`tag`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getResourcesByAssetFolder

resources.getResourcesByAssetFolder List assets in a folder Risk: read

await corsair.cloudinary.api.resources.getResourcesByAssetFolder({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_folder`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`tags`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

getResourcesByContext

resources.getResourcesByContext Get resources by context metadata Risk: read

await corsair.cloudinary.api.resources.getResourcesByContext({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`key`	`any`	No	—
`value`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`tags`	`any`	No	—
`moderations`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

getResourcesInModeration

resources.getResourcesInModeration Get resources in moderation queue Risk: read

await corsair.cloudinary.api.resources.getResourcesInModeration({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`moderation_kind`	`string`	Yes	—
`status`	`string`	Yes	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`tags`	`any`	No	—
`moderations`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

listResourcesByAssetIds

resources.listResourcesByAssetIds List resources by asset IDs Risk: read

await corsair.cloudinary.api.resources.listResourcesByAssetIds({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`asset_ids`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

listResourcesByExternalIds

resources.listResourcesByExternalIds List resources by external IDs Risk: read

await corsair.cloudinary.api.resources.listResourcesByExternalIds({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`external_ids`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

listResourcesByTag

resources.listResourcesByTag List resources by tag Risk: read

await corsair.cloudinary.api.resources.listResourcesByTag({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`tag`	`string`	Yes	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderations`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

listResourcesByType

resources.listResourcesByType List resources by type Risk: read

await corsair.cloudinary.api.resources.listResourcesByType({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—
`prefix`	`any`	No	—
`public_ids`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`start_at`	`any`	No	—
`direction`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderation`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]

publishResources

resources.publishResources Publish resources to public access Risk: write

await corsair.cloudinary.api.resources.publishResources({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

restoreResources

resources.restoreResources Restore deleted resources by public ID Risk: write

await corsair.cloudinary.api.resources.restoreResources({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`string`	Yes	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`string`	Yes	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

restoreResourcesByAssetIds

resources.restoreResourcesByAssetIds Restore resources by asset IDs Risk: write

await corsair.cloudinary.api.resources.restoreResourcesByAssetIds({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Root

getRootFolders

root.getRootFolders List root folders Risk: read

await corsair.cloudinary.api.root.getRootFolders({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`folders`	`object[]`	No	—

folders full type

{
  name: string,
  path?: string,
  external_id?: string
}[]

Slideshow

createSlideshow

slideshow.createSlideshow Create video slideshow from assets Risk: write

await corsair.cloudinary.api.slideshow.createSlideshow({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output

Name	Type	Required	Description
`asset_id`	`string`	Yes	—
`public_id`	`string`	Yes	—
`resource_type`	`image \| video \| raw`	No	—
`type`	`string`	No	—
`format`	`string`	No	—
`version`	`number`	No	—
`url`	`string`	No	—
`secure_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`bytes`	`number`	No	—
`created_at`	`string`	No	—
`tags`	`string[]`	No	—
`context`	`Record<string, any>`	No	—
`metadata`	`Record<string, any>`	No	—
`asset_folder`	`string`	No	—
`display_name`	`string`	No	—
`status`	`string`	No	—

Sprite

generateSprite

sprite.generateSprite Generate sprite from images (deprecated) Risk: write

await corsair.cloudinary.api.sprite.generateSprite({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

Streaming

createStreamingProfile

streaming.createStreamingProfile Create adaptive streaming profile Risk: write

await corsair.cloudinary.api.streaming.createStreamingProfile({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—

Output: Record<string, any>

deleteStreamingProfile

streaming.deleteStreamingProfile Delete streaming profile Risk: destructive · Irreversible

await corsair.cloudinary.api.streaming.deleteStreamingProfile({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

getStreamingProfileDetails

streaming.getStreamingProfileDetails Get streaming profile details Risk: read

await corsair.cloudinary.api.streaming.getStreamingProfileDetails({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output: Record<string, any>

updateStreamingProfile

streaming.updateStreamingProfile Update streaming profile Risk: write

await corsair.cloudinary.api.streaming.updateStreamingProfile({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output: Record<string, any>

Transformation

createTransformation

transformation.createTransformation Create named transformation Risk: write

await corsair.cloudinary.api.transformation.createTransformation({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`transformation`	`string`	No	—
`allowed_for_strict`	`boolean`	No	—
`used`	`boolean`	No	—

getTransformation

transformation.getTransformation Get transformation details Risk: read

await corsair.cloudinary.api.transformation.getTransformation({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`transformation`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`transformation`	`string`	No	—
`allowed_for_strict`	`boolean`	No	—
`used`	`boolean`	No	—

Transformation2

deleteTransformation2

transformation2.deleteTransformation2 Delete named transformation Risk: destructive · Irreversible

await corsair.cloudinary.api.transformation2.deleteTransformation2({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`transformation`	`string`	Yes	—

Output

Name	Type	Required	Description
`result`	`string`	No	—

updateTransformation2

transformation2.updateTransformation2 Update named transformation Risk: write

await corsair.cloudinary.api.transformation2.updateTransformation2({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`transformation`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`transformation`	`string`	No	—
`allowed_for_strict`	`boolean`	No	—
`used`	`boolean`	No	—

Transformations

getTransformations

transformations.getTransformations List transformations Risk: read

await corsair.cloudinary.api.transformations.getTransformations({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`named`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`transformations`	`object[]`	No	—

transformations full type

{
  name?: string,
  transformation?: string,
  allowed_for_strict?: boolean,
  used?: boolean
}[]

Triggers

getTriggers

triggers.getTriggers List webhook triggers Risk: read

await corsair.cloudinary.api.triggers.getTriggers({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`event_type`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`triggers`	`object[]`	No	—

triggers full type

{
  id: string,
  uri: string,
  event_type: string,
  additive?: boolean,
  auth_scheme?: string
}[]

Update

updateTrigger

update.updateTrigger Update webhook trigger Risk: write

await corsair.cloudinary.api.update.updateTrigger({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`trigger_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`uri`	`string`	Yes	—
`event_type`	`string`	Yes	—
`additive`	`boolean`	No	—
`auth_scheme`	`string`	No	—

Usage

getUsage

usage.getUsage Get account usage details Risk: read

await corsair.cloudinary.api.usage.getUsage({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`date`	`any`	No	—

Output

Name	Type	Required	Description
`plan`	`string`	No	—
`last_updated`	`string`	No	—
`credits`	`Record<string, any>`	No	—
`storage`	`Record<string, any>`	No	—
`bandwidth`	`Record<string, any>`	No	—
`resources`	`number`	No	—
`derived_resources`	`number`	No	—

Video

getVideoViews

video.getVideoViews Get video analytics views Risk: read

await corsair.cloudinary.api.video.getVideoViews({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`public_ids`	`any`	No	—
`start_date`	`any`	No	—
`end_date`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—

Output: Record<string, any>

Videos

videos.listVideos List video assets Risk: read

await corsair.cloudinary.api.videos.listVideos({});

Input

Name	Type	Required	Description
`query`	`Record<string, any>`	No	—
`body`	`any`	No	—
`file`	`custom`	No	—
`resource_type`	`image \| video \| raw \| auto`	No	—
`upload_resource_type`	`image \| video \| raw \| auto`	No	—
`type`	`any`	No	—
`prefix`	`any`	No	—
`public_ids`	`any`	No	—
`max_results`	`any`	No	—
`next_cursor`	`any`	No	—
`start_at`	`any`	No	—
`direction`	`any`	No	—
`context`	`any`	No	—
`metadata`	`any`	No	—
`moderation`	`any`	No	—
`tags`	`any`	No	—
`fields`	`any`	No	—

Output

Name	Type	Required	Description
`next_cursor`	`string \| null`	No	—
`total_count`	`number`	No	—
`resources`	`object[]`	No	—

resources full type

{
  asset_id: string,
  public_id: string,
  resource_type?: image | video | raw,
  type?: string,
  format?: string,
  version?: number,
  url?: string,
  secure_url?: string,
  width?: number,
  height?: number,
  bytes?: number,
  created_at?: string,
  tags?: string[],
  context?: Record<string, any>,
  metadata?: Record<string, any>,
  asset_folder?: string,
  display_name?: string,
  status?: string
}[]