@cloudinary/apps-api 2.2605.49

package/docs/MediaApi.md

@@ -0,0 +1,790 @@
+# MediaApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**analyzeAiVisionGeneral**](MediaApi.md#analyzeaivisiongeneraloperation) | **POST** /v2605/media/analysis/ai-vision | Generate AI Vision analysis (e.g. alt text) for an asset |
+| [**createThumbnailToken**](MediaApi.md#createthumbnailtoken) | **POST** /v2605/media/thumbnails/token | Generate a time-limited thumbnail access token |
+| [**getThumbnail**](MediaApi.md#getthumbnail) | **GET** /v2605/media/thumbnails/{resource_type}/{type}/{version}/{variant} | Fetch a rendered thumbnail for an asset |
+| [**listGoogleFonts**](MediaApi.md#listgooglefonts) | **GET** /v2605/media/fonts/google/web-fonts | List all available Google Web Fonts |
+| [**lookupFont**](MediaApi.md#lookupfontoperation) | **POST** /v2605/media/fonts/lookup | Look up font availability |
+| [**prepareUpload**](MediaApi.md#prepareuploadoperation) | **POST** /v2605/media/uploads/prepare | Prepare and sign upload parameters |
+| [**provisionFont**](MediaApi.md#provisionfontoperation) | **POST** /v2605/media/fonts/provision | Provision fonts into the cloud |
+| [**signAndUpload**](MediaApi.md#signandupload) | **POST** /v2605/media/uploads/sign-and-upload | Sign and upload an asset in one step |
+| [**uploadAsset**](MediaApi.md#uploadasset) | **POST** /v2605/media/uploads/{resource_type} | Upload an asset with a pre-signed signature |
+
+
+
+## analyzeAiVisionGeneral
+
+> AiVisionGeneralResponse analyzeAiVisionGeneral(analyzeAiVisionGeneralRequest)
+
+Generate AI Vision analysis (e.g. alt text) for an asset
+
+Proxies the public Cloudinary AI Vision Analyze API with the caller\'s OAuth token. Provide a source (uri or asset_id) and prompts; returns the model\'s responses. Requires the AI Vision add-on.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { AnalyzeAiVisionGeneralOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // AnalyzeAiVisionGeneralRequest (optional)
+    analyzeAiVisionGeneralRequest: ...,
+  } satisfies AnalyzeAiVisionGeneralOperationRequest;
+
+  try {
+    const data = await api.analyzeAiVisionGeneral(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **analyzeAiVisionGeneralRequest** | [AnalyzeAiVisionGeneralRequest](AnalyzeAiVisionGeneralRequest.md) |  | [Optional] |
+
+### Return type
+
+[**AiVisionGeneralResponse**](AiVisionGeneralResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | AI Vision analysis result |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createThumbnailToken
+
+> ThumbnailsTokenResponse createThumbnailToken(validFor)
+
+Generate a time-limited thumbnail access token
+
+Creates a short-lived token for authenticating thumbnail delivery requests. The token validity period defaults to the server setting but can be overridden with valid_for (in seconds).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { CreateThumbnailTokenRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // number (optional)
+    validFor: 8.14,
+  } satisfies CreateThumbnailTokenRequest;
+
+  try {
+    const data = await api.createThumbnailToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **validFor** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThumbnailsTokenResponse**](ThumbnailsTokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful authentication response with user identity and permissions |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getThumbnail
+
+> string getThumbnail(resourceType, type, version, variant, publicId, token)
+
+Fetch a rendered thumbnail for an asset
+
+Returns a pre-rendered thumbnail image for an asset in the specified variant (e.g. grid, preview, drilldown). Variant controls dimensions and format. If no token query param is provided, one is auto-generated.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { GetThumbnailRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // 'image' | 'video' | 'raw'
+    resourceType: resourceType_example,
+    // 'upload' | 'private' | 'authenticated'
+    type: type_example,
+    // string
+    version: version_example,
+    // 'grid' | 'grid_landscape' | 'grid_square' | 'grid_animated_landscape' | 'grid_animated_square' | 'preview' | 'drilldown' | 'template' | 'template_primary' | 'folder_thumbnail' | 'get_info' | 'list' | 'list_v2' | 'square90' | 'grid_preview' | 'grid_large_preview' | 'grid_large_preview_v2' | 'asset_picker_grid' | 'grid_video_square' | 'grid_video_landscape' | 'media_editor_widget' | 'play_video' | 'hls_video_preview' | 'video_segment' | 'video_stream' | 'audio_stream' | 'audio_segment'
+    variant: variant_example,
+    // string
+    publicId: publicId_example,
+    // string (optional)
+    token: token_example,
+  } satisfies GetThumbnailRequest;
+
+  try {
+    const data = await api.getThumbnail(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resourceType** | `image`, `video`, `raw` |  | [Defaults to `undefined`] [Enum: image, video, raw] |
+| **type** | `upload`, `private`, `authenticated` |  | [Defaults to `undefined`] [Enum: upload, private, authenticated] |
+| **version** | `string` |  | [Defaults to `undefined`] |
+| **variant** | `grid`, `grid_landscape`, `grid_square`, `grid_animated_landscape`, `grid_animated_square`, `preview`, `drilldown`, `template`, `template_primary`, `folder_thumbnail`, `get_info`, `list`, `list_v2`, `square90`, `grid_preview`, `grid_large_preview`, `grid_large_preview_v2`, `asset_picker_grid`, `grid_video_square`, `grid_video_landscape`, `media_editor_widget`, `play_video`, `hls_video_preview`, `video_segment`, `video_stream`, `audio_stream`, `audio_segment` |  | [Defaults to `undefined`] [Enum: grid, grid_landscape, grid_square, grid_animated_landscape, grid_animated_square, preview, drilldown, template, template_primary, folder_thumbnail, get_info, list, list_v2, square90, grid_preview, grid_large_preview, grid_large_preview_v2, asset_picker_grid, grid_video_square, grid_video_landscape, media_editor_widget, play_video, hls_video_preview, video_segment, video_stream, audio_stream, audio_segment] |
+| **publicId** | `string` |  | [Defaults to `undefined`] |
+| **token** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/jpeg`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Thumbnail image binary |  -  |
+| **400** | Bad request - missing cloud name or public_id |  -  |
+| **502** | Upstream thumbnail service error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listGoogleFonts
+
+> GoogleFontListingResponse listGoogleFonts()
+
+List all available Google Web Fonts
+
+Returns the full catalog of Google Web Fonts including font family name, available variants (weights/styles), and supported character subsets.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { ListGoogleFontsRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const api = new MediaApi();
+
+  try {
+    const data = await api.listGoogleFonts();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GoogleFontListingResponse**](GoogleFontListingResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## lookupFont
+
+> FontLookupResponse lookupFont(lookupFontRequest)
+
+Look up font availability
+
+Checks whether each requested font is available as a Cloudinary system font or a Google Web Font. Returns resolution status and source for each font declaration.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { LookupFontOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // LookupFontRequest (optional)
+    lookupFontRequest: ...,
+  } satisfies LookupFontOperationRequest;
+
+  try {
+    const data = await api.lookupFont(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **lookupFontRequest** | [LookupFontRequest](LookupFontRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FontLookupResponse**](FontLookupResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## prepareUpload
+
+> PrepareUploadResponse prepareUpload(prepareUploadRequest)
+
+Prepare and sign upload parameters
+
+Signs the provided upload parameters and returns a signature, api_key, and upload host. Use the returned credentials in a subsequent upload request. Requires Console authentication.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { PrepareUploadOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // PrepareUploadRequest (optional)
+    prepareUploadRequest: ...,
+  } satisfies PrepareUploadOperationRequest;
+
+  try {
+    const data = await api.prepareUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **prepareUploadRequest** | [PrepareUploadRequest](PrepareUploadRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PrepareUploadResponse**](PrepareUploadResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful authentication response with user identity and permissions |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## provisionFont
+
+> FontProvisioningResponse provisionFont(provisionFontRequest)
+
+Provision fonts into the cloud
+
+Resolves fonts against Cloudinary system fonts and Google Web Fonts, then uploads any Google-sourced fonts to the cloud (optionally into a target folder). Returns resolution details for each font. Requires OAuth authentication.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { ProvisionFontOperationRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // ProvisionFontRequest (optional)
+    provisionFontRequest: ...,
+  } satisfies ProvisionFontOperationRequest;
+
+  try {
+    const data = await api.provisionFont(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **provisionFontRequest** | [ProvisionFontRequest](ProvisionFontRequest.md) |  | [Optional] |
+
+### Return type
+
+[**FontProvisioningResponse**](FontProvisioningResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Fonts lookup successful |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## signAndUpload
+
+> SignAndUploadResponse signAndUpload(file, resourceType, publicId, folder, assetFolder, tags, type, overwrite, invalidate, context, metadata, transformation, format, eager, eagerAsync, eagerNotificationUrl, notificationUrl, displayName, useFilename, uniqueFilename, filenameOverride, accessMode, discardOriginalFilename, phash, async)
+
+Sign and upload an asset in one step
+
+Combines parameter signing and file upload into a single request. The gateway signs via Console API internally, then proxies the upload to Cloudinary. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires Console authentication.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { SignAndUploadRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // Blob | The binary file to upload
+    file: BINARY_DATA_HERE,
+    // string | The type of resource (image, video, raw, auto). Defaults to auto (optional)
+    resourceType: resourceType_example,
+    // string | Custom public identifier for the uploaded asset (optional)
+    publicId: publicId_example,
+    // string | Folder name where the file should be stored (optional)
+    folder: folder_example,
+    // string | Asset folder path in the Cloudinary repository (optional)
+    assetFolder: assetFolder_example,
+    // string | Comma-separated list of tags (optional)
+    tags: tags_example,
+    // string | Storage/delivery type (upload, private, authenticated) (optional)
+    type: type_example,
+    // string | Whether to overwrite an existing asset (true/false) (optional)
+    overwrite: overwrite_example,
+    // string | Whether to invalidate CDN cache (true/false) (optional)
+    invalidate: invalidate_example,
+    // string | Pipe-separated contextual metadata (optional)
+    context: context_example,
+    // string | Pipe-separated structured metadata (optional)
+    metadata: metadata_example,
+    // string | Transformation to apply on upload (optional)
+    transformation: transformation_example,
+    // string | Format to convert to (optional)
+    format: format_example,
+    // string | Eager transformations to generate (optional)
+    eager: eager_example,
+    // string | Whether to generate eager transformations asynchronously (true/false) (optional)
+    eagerAsync: eagerAsync_example,
+    // string | Webhook URL for eager transformation completion (optional)
+    eagerNotificationUrl: eagerNotificationUrl_example,
+    // string | Webhook URL for upload completion (optional)
+    notificationUrl: notificationUrl_example,
+    // string | Display name for the asset (optional)
+    displayName: displayName_example,
+    // string | Use original filename as public_id (true/false) (optional)
+    useFilename: useFilename_example,
+    // string | Append random characters to filename (true/false) (optional)
+    uniqueFilename: uniqueFilename_example,
+    // string | Override the original filename metadata (optional)
+    filenameOverride: filenameOverride_example,
+    // string | Access mode (public, authenticated) (optional)
+    accessMode: accessMode_example,
+    // string | Whether to discard original filename (true/false) (optional)
+    discardOriginalFilename: discardOriginalFilename_example,
+    // string | Whether to return perceptual hash (true/false) (optional)
+    phash: phash_example,
+    // string | Whether to perform upload asynchronously (true/false) (optional)
+    async: async_example,
+  } satisfies SignAndUploadRequest;
+
+  try {
+    const data = await api.signAndUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` | The binary file to upload | [Defaults to `undefined`] |
+| **resourceType** | `string` | The type of resource (image, video, raw, auto). Defaults to auto | [Optional] [Defaults to `undefined`] |
+| **publicId** | `string` | Custom public identifier for the uploaded asset | [Optional] [Defaults to `undefined`] |
+| **folder** | `string` | Folder name where the file should be stored | [Optional] [Defaults to `undefined`] |
+| **assetFolder** | `string` | Asset folder path in the Cloudinary repository | [Optional] [Defaults to `undefined`] |
+| **tags** | `string` | Comma-separated list of tags | [Optional] [Defaults to `undefined`] |
+| **type** | `string` | Storage/delivery type (upload, private, authenticated) | [Optional] [Defaults to `undefined`] |
+| **overwrite** | `string` | Whether to overwrite an existing asset (true/false) | [Optional] [Defaults to `undefined`] |
+| **invalidate** | `string` | Whether to invalidate CDN cache (true/false) | [Optional] [Defaults to `undefined`] |
+| **context** | `string` | Pipe-separated contextual metadata | [Optional] [Defaults to `undefined`] |
+| **metadata** | `string` | Pipe-separated structured metadata | [Optional] [Defaults to `undefined`] |
+| **transformation** | `string` | Transformation to apply on upload | [Optional] [Defaults to `undefined`] |
+| **format** | `string` | Format to convert to | [Optional] [Defaults to `undefined`] |
+| **eager** | `string` | Eager transformations to generate | [Optional] [Defaults to `undefined`] |
+| **eagerAsync** | `string` | Whether to generate eager transformations asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
+| **eagerNotificationUrl** | `string` | Webhook URL for eager transformation completion | [Optional] [Defaults to `undefined`] |
+| **notificationUrl** | `string` | Webhook URL for upload completion | [Optional] [Defaults to `undefined`] |
+| **displayName** | `string` | Display name for the asset | [Optional] [Defaults to `undefined`] |
+| **useFilename** | `string` | Use original filename as public_id (true/false) | [Optional] [Defaults to `undefined`] |
+| **uniqueFilename** | `string` | Append random characters to filename (true/false) | [Optional] [Defaults to `undefined`] |
+| **filenameOverride** | `string` | Override the original filename metadata | [Optional] [Defaults to `undefined`] |
+| **accessMode** | `string` | Access mode (public, authenticated) | [Optional] [Defaults to `undefined`] |
+| **discardOriginalFilename** | `string` | Whether to discard original filename (true/false) | [Optional] [Defaults to `undefined`] |
+| **phash** | `string` | Whether to return perceptual hash (true/false) | [Optional] [Defaults to `undefined`] |
+| **async** | `string` | Whether to perform upload asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SignAndUploadResponse**](SignAndUploadResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Asset uploaded successfully |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## uploadAsset
+
+> UploadAssetResponse uploadAsset(resourceType, file, signature, apiKey, timestamp, publicId, folder, tags, type, resourceType2, overwrite, invalidate, context, metadata, transformation, format, eager, async)
+
+Upload an asset with a pre-signed signature
+
+Uploads a file to Cloudinary using a signature and api_key obtained from the prepare endpoint. Accepts multipart/form-data (binary file) or application/json (URL or base64 data URI). Requires OAuth authentication.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MediaApi,
+} from '@cloudinary/apps-api';
+import type { UploadAssetRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MediaApi(config);
+
+  const body = {
+    // string | The resource type (image, video, raw, auto)
+    resourceType: resourceType_example,
+    // Blob | The binary file to upload
+    file: BINARY_DATA_HERE,
+    // string | The authentication signature for the upload request
+    signature: signature_example,
+    // string | The API key for authentication
+    apiKey: apiKey_example,
+    // string | Unix timestamp for signature validation (optional)
+    timestamp: timestamp_example,
+    // string | Custom public identifier for the uploaded asset (optional)
+    publicId: publicId_example,
+    // string | Folder name where the file should be stored (optional)
+    folder: folder_example,
+    // string | Comma-separated list of tags (optional)
+    tags: tags_example,
+    // string | Storage/delivery type (upload, private, authenticated) (optional)
+    type: type_example,
+    // string | The type of resource (image, video, raw, auto) (optional)
+    resourceType2: resourceType_example,
+    // string | Whether to overwrite an existing asset (true/false) (optional)
+    overwrite: overwrite_example,
+    // string | Whether to invalidate CDN cache (true/false) (optional)
+    invalidate: invalidate_example,
+    // string | Pipe-separated contextual metadata (optional)
+    context: context_example,
+    // string | Pipe-separated structured metadata (optional)
+    metadata: metadata_example,
+    // string | Transformation to apply on upload (optional)
+    transformation: transformation_example,
+    // string | Format to convert to (optional)
+    format: format_example,
+    // string | Eager transformations to generate (optional)
+    eager: eager_example,
+    // string | Whether to generate eager transformations asynchronously (true/false) (optional)
+    async: async_example,
+  } satisfies UploadAssetRequest;
+
+  try {
+    const data = await api.uploadAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resourceType** | `string` | The resource type (image, video, raw, auto) | [Defaults to `undefined`] |
+| **file** | `Blob` | The binary file to upload | [Defaults to `undefined`] |
+| **signature** | `string` | The authentication signature for the upload request | [Defaults to `undefined`] |
+| **apiKey** | `string` | The API key for authentication | [Defaults to `undefined`] |
+| **timestamp** | `string` | Unix timestamp for signature validation | [Optional] [Defaults to `undefined`] |
+| **publicId** | `string` | Custom public identifier for the uploaded asset | [Optional] [Defaults to `undefined`] |
+| **folder** | `string` | Folder name where the file should be stored | [Optional] [Defaults to `undefined`] |
+| **tags** | `string` | Comma-separated list of tags | [Optional] [Defaults to `undefined`] |
+| **type** | `string` | Storage/delivery type (upload, private, authenticated) | [Optional] [Defaults to `undefined`] |
+| **resourceType2** | `string` | The type of resource (image, video, raw, auto) | [Optional] [Defaults to `undefined`] |
+| **overwrite** | `string` | Whether to overwrite an existing asset (true/false) | [Optional] [Defaults to `undefined`] |
+| **invalidate** | `string` | Whether to invalidate CDN cache (true/false) | [Optional] [Defaults to `undefined`] |
+| **context** | `string` | Pipe-separated contextual metadata | [Optional] [Defaults to `undefined`] |
+| **metadata** | `string` | Pipe-separated structured metadata | [Optional] [Defaults to `undefined`] |
+| **transformation** | `string` | Transformation to apply on upload | [Optional] [Defaults to `undefined`] |
+| **format** | `string` | Format to convert to | [Optional] [Defaults to `undefined`] |
+| **eager** | `string` | Eager transformations to generate | [Optional] [Defaults to `undefined`] |
+| **async** | `string` | Whether to generate eager transformations asynchronously (true/false) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadAssetResponse**](UploadAssetResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`, `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Asset uploaded successfully |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+