veImageX

https://www.volcengine.com/docs/508
Admin
veImageX is an all-in-one image processing and media solution by Volcengine that provides image...
Tokens:1,654,015
Snippets:12,068
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### DescribeImageXCompressUsage Request Example

Source: https://www.volcengine.com/docs/508/9415

Example of a GET request to the DescribeImageXCompressUsage endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=DescribeImageXCompressUsage&Version=2018-08-01&ServiceIds=s1,s2&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300
```

--------------------------------

### startUpWithConfig:

Source: https://www.volcengine.com/docs/508/1262414?lang=zh

Initializes the BDWebImageManager module with a configuration object.

```APIDOC
## - (void)startUpWithConfig:(BDWebImageStartUpConfig *)config

### Description
Initializes the BDWebImageManager module. Note: It is recommended to use TTSDKManager for initialization instead of calling this directly.

### Parameters
- **config** (BDWebImageStartUpConfig*) - Required - The configuration object used for initialization.
```

--------------------------------

### GetImageServiceSubscription Request Example

Source: https://www.volcengine.com/docs/508/9351

Example of a GET request to the GetImageServiceSubscription endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2018-08-01
```

--------------------------------

### startUpWithConfig:

Source: https://www.volcengine.com/docs/508/1262414?lang=zh

Initializes the manager with the provided configuration.

```APIDOC
## void startUpWithConfig:(id)config

### Description
Initializes the manager with the provided configuration.
```

--------------------------------

### GetResponseHeaderValidateKeys Request Example

Source: https://www.volcengine.com/docs/508/66013

Example of a GET request to the GetResponseHeaderValidateKeys endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=GetResponseHeaderValidateKeys&Version=2018-08-01
```

--------------------------------

### Install and Integrate Image Monitoring SDK

Source: https://www.volcengine.com/docs/508/177943?lang=zh

Methods for installing and initializing the image monitoring SDK via script or NPM.

```html
<head>
  <script src="https://unpkg.byted-static.com/volcengine/imagex-monitor/X.X.X/umd/index.js" />
  <script>
    const monitor = new window.ImageMonitor.Monitor({
      el: document,
      appId: xxxxx, // 请替换为您在集成准备获取的 appId
      region: 'cn' //中国
    });
    monitor.start()
  </script>
</head>
```

```bash
npm install @volcengine/imagex-monitor -S
```

```javascript
import { Monitor } from '@volcengine/imagex-monitor';

const monitor = new Monitor({
  // config
  el: document,
  appId: xxxxx, // 请替换为您在集成准备获取的 appId
  region: 'cn'  //中国
})
monitor.start()
```

--------------------------------

### GetAudioAuditResult Request Example

Source: https://www.volcengine.com/docs/508/1784437

Example of a GET request to the GetAudioAuditResult endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=GetAudioAuditResult&Version=2023-05-01&TaskId=971917**019018
```

--------------------------------

### start(key)

Source: https://www.volcengine.com/docs/508/1124892?lang=zh

启动上传任务。如果该上传任务被暂停，则再次调用此方法时将恢复上传。

```APIDOC
## start(key)

### Description
启动上传任务。如果该上传任务被暂停，则再次调用此方法时将恢复上传。如不传 key，则所有已添加的文件将开始上传。

### Parameters
- **key** (String) - Optional - 上传文件的 key 值
```

--------------------------------

### ApplyVpcUploadInfo Request Example

Source: https://www.volcengine.com/docs/508/1510754

Example of a GET request to the ApplyVpcUploadInfo endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=ApplyVpcUploadInfo&Version=2023-05-01&ServiceId=u3*k
```

--------------------------------

### 配置上传基本信息

Source: https://www.volcengine.com/docs/508/66130?lang=zh

在应用启动时配置必要的上传参数，建议在 didFinishLaunchingWithOptions 中执行。

```objective-c
/// 配置基本信息
NSDictionary *appInfo = @{
                          @"TTVideoEngineAID" : @(12345), /// appid
                          @"TTVideoEngineAppName" : @"test_appName",/// appName
                          @"TTVideoEngineChannel" : @"test_channel",
                          @"TTVideoEngineUserId"  : @"user_id",
                          };                           
[TTImageUploadClientTop configureAppInfo:appInfo];//图片的上传的配置
```

--------------------------------

### Monitor.start()

Source: https://www.volcengine.com/docs/508/658168

Initializes and starts the image monitoring SDK to track image loading performance.

```APIDOC
## Monitor.start()

### Description
Initializes the ImageMonitor instance and begins tracking image loading events within the specified element.

### Parameters
- **el** (HTMLElement) - Required - The DOM element to monitor (e.g., document).
- **appId** (string) - Required - The unique identifier for the application obtained from the console.
- **region** (string) - Required - The region code (e.g., 'cn').

### Usage
```javascript
import { Monitor } from '@volcengine/imagex-monitor';

const monitor = new Monitor({
  el: document,
  appId: 'xxxxx',
  region: 'cn'
})
monitor.start()
```
```

--------------------------------

### GetImageStorageVersionFiles Request Example

Source: https://www.volcengine.com/docs/508/1359366?lang=zh

Example of a GET request to the GetImageStorageVersionFiles endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageStorageVersionFiles&Version=2023-05-01&ServiceId=test
```

--------------------------------

### Upload Resources with PHP SDK

Source: https://www.volcengine.com/docs/508/1274186

Demonstrates how to initialize the ImageX client and upload images by specifying the service ID and file paths. Ensure the SDK is installed and configured with appropriate credentials before execution.

```php
<?php
include_once(__DIR__ . '/../../../vendor/autoload.php');


use Volc\Service\ImageX\V2\Imagex;


$client = Imagex::getInstance();


// call below method if you dont set ak and sk in ～/.volc/config
// $client->setAccessKey("ak");
// $client->setSecretKey("sk");


$params = array();
$params["ServiceId"] = "imagex service id";
// 指定上传域名，域名格式参考 https://www.volcengine.com/docs/508/1537728
//$params["UploadHost"] = "upload host";
$filePaths = array("image path 1");


$response = $client->uploadImages($params, $filePaths);
print_r($response);
```

--------------------------------

### GetImageAddOnTag Request Example

Source: https://www.volcengine.com/docs/508/1327583

Example of a GET request to the GetImageAddOnTag endpoint.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageAddOnTag&Version=2023-05-01&Key=功能属性&Type=AI
```

--------------------------------

### Env.init 初始化 SDK

Source: https://www.volcengine.com/docs/508/148786?lang=zh

在 Application#onCreate 中初始化 SDK，配置应用信息及云控参数。

```APIDOC
## Env.init

### 初始化配置
Env.openAppLog(false);
Env.init(new Config.Builder()
        .setApplicationContext(context)
        .setAppID("your app id")
        .setAppName("your app English name")
        .setAppVersion(BuildConfig.VERSION_NAME)
        .setAppChannel("channel name")
        .setOpenUploadCloudControl(true)
        .build());
```

--------------------------------

### Request Example for DescribeImageXHitRateRequestData

Source: https://www.volcengine.com/docs/508/1211122

Example GET request for the DescribeImageXHitRateRequestData API.

```http
GET https://imagex.volcengineapi.com/?Action=DescribeImageXHitRateRequestData&Version=2023-05-01&ServiceIds=s1,s2&DomainNames=d1,d2&GroupBy=DomainName&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300
```

--------------------------------

### start()

Source: https://www.volcengine.com/docs/508/1272434?lang=zh

Starts the monitoring and reporting process.

```APIDOC
## start()

### Description
Call this method to begin monitoring and reporting image loading events.

### Signature
`() => void`
```

--------------------------------

### DescribeImageXBillingRequestCntUsage Request Example

Source: https://www.volcengine.com/docs/508/1130795

A GET request example for the DescribeImageXBillingRequestCntUsage API.

```http
GET https://imagex.volcengineapi.com/?Action=DescribeImageXBillingRequestCntUsage&Version=2018-08-01&ServiceIds=s1,s2&AdvFeats=a1,a2&GroupBy=AdvFeat&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300
```

--------------------------------

### SDK Initialization and Usage

Source: https://www.volcengine.com/docs/508/1124892

How to initialize the TTUploader instance, set up event listeners, and add files for upload.

```APIDOC
## SDK Initialization and Usage

### Description
Initialize the `TTUploader` instance with required user and application credentials, configure event listeners for upload status, and add files to the upload queue.

### Configuration Parameters
- **userId** (String) - Required - Unique identifier for the user.
- **appId** (Number) - Required - Application ID from the veImageX console.
- **imageConfig** (Object) - Required - Configuration object containing `serviceId`.
- **uploadHost** (String) - Optional - Custom upload domain.

### Event Listeners
- **error**: Triggered when an upload fails.
- **progress**: Triggered during upload, provides `percent`.
- **complete**: Triggered when the upload finishes successfully.

### Example
```javascript
import TTUploader from 'tt-uploader-miniprogram';

const uploader = new TTUploader({
    userId: 'volcengine-user1',
    appId: 7827,
    imageConfig: {
        serviceId: 'hj7f'
    }
});

uploader.on('progress', (info) => {
    console.log('Upload progress:', info.percent);
});

const key = uploader.addImageFile({
   path: 'file_path',
   size: 1234,
   stsToken: { ... },
   fileExtension: '.png'
});

uploader.start(key);
```
```

--------------------------------

### GetAllCerts API Request Example

Source: https://www.volcengine.com/docs/508/66017?lang=zh

A GET request example to retrieve all certificates.

```http
GET https://imagex.volcengineapi.com/?Action=GetAllCerts&Version=2018-08-01
```

--------------------------------

### Initialize SDK Instance

Source: https://www.volcengine.com/docs/508/1124892

Configure the SDK instance with required user, application, and service identifiers, including optional custom upload hosts.

```javascript
const uploader = new TTUploader({
    userId: 'Test1',  //必填，自定义用户 ID，用于定位某用户的日志。
    appId: 67**23,  //必填，应用 ID，用于定位某业务应用的日志。
    imageConfig: {  //必填，图片上传配置。
        serviceId: 'hi****2t'  //必填，服务 ID，用于指定文件上传所在服务。
    },
    uploadHost: 'hi****2t.up.imagex-accelerate.volces.com' // 使用服务对应的上传域名进行上传，需要将对应的域名加入白名单
});
```

--------------------------------

### PreviewImageUploadFile API Request Example

Source: https://www.volcengine.com/docs/508/1327596

A GET request example for the PreviewImageUploadFile API.

```http
GET https://imagex.volcengineapi.com/?Action=PreviewImageUploadFile&Version=2023-05-01&ServiceId=8h**9q&StoreUri=tos-cn-i-8h**9q/imagexdemo.heif
```

--------------------------------

### GetDomainConfig Request Example

Source: https://www.volcengine.com/docs/508/9366?lang=zh

Example of a GET request to retrieve domain configuration settings.

```http
GET https://imagex.volcengineapi.com/?Action=GetDomainConfig&Version=2018-08-01&DomainName=example.volcimagex.cn&ServiceId=yl***yn

{
    "ServiceId":"yl***yn",
    "DomainName":"example.volcimagex.cn",
}
```

--------------------------------

### Initialize ImagePipelineFactory

Source: https://www.volcengine.com/docs/508/1262419

Example of configuring and initializing the ImagePipelineFactory. This should only be executed once per process.

```java
ImagePipelineConfig config = ImagePipelineConfig.newBuilder() .setXXX(xxx) .setYYY(yyy) .build(); 
ImagePipelineFactory factory = new ImagePipelineFactory(config); 
ImagePipeline pipeline = factory.getImagePipeline();
```

--------------------------------

### GetImageEraseModels Request Example

Source: https://www.volcengine.com/docs/508/1254832

Example of a GET request to retrieve image restoration models.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageEraseModels&Version=2023-05-01&Type=0
```

--------------------------------

### Asynchronous AI Task Initialization (PHP)

Source: https://www.volcengine.com/docs/508/111898

Demonstrates the initial setup for an asynchronous AI task using the PHP SDK.

```PHP
<?php
include_once(__DIR__ . '../../../../vendor/autoload.php');

use Volc\Service\ImageX\V2\Imagex;

$client = Imagex::getInstance();

// 强烈建议不要把 ak 和 sk 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 ak 和 sk，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ak 和 sk。
$client->setAccessKey("ak");
$client->setSecretKey("sk");
```

--------------------------------

### SDK Initialization with Temporary Credentials

Source: https://www.volcengine.com/docs/508/1250175

How to initialize the service using temporary AK, SK, and SessionToken.

```APIDOC
## Initialization (Temporary Credentials)

```typescript
import { imagex } from "@volcengine/openapi";

const imagexService = imagex.defaultService;

// Set temporary credentials
imagexService.setAccessKeyId(AccessKeyId);
imagexService.setSecretKey(SecretKey);
imagexService.setSessionToken(SessionToken);
```
```

--------------------------------

### GetCompressTaskInfo Request Example

Source: https://www.volcengine.com/docs/508/1112506

Example of a GET request to retrieve compression task information.

```http
GET https://imagex.volcengineapi.com/?Action=GetCompressTaskInfo&Version=2018-08-01&ServiceId=7j%2A%2A6&TaskId=82370%2A%2A%2A12102
```

--------------------------------

### Compile Demo via Command Line

Source: https://www.volcengine.com/docs/508/1283729?lang=zh

Use Gradle to clone and build the debug version of the application.

```shell
git clone https://github.com/volcengine/ImageXDemo-Android
cd ImageXDemo-Android
./gradlew :app:installdebug
```

--------------------------------

### GetImageMigrateTasks Request Example

Source: https://www.volcengine.com/docs/508/1108670

Example of a GET request to retrieve image migration tasks.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageMigrateTasks&Version=2018-08-01&TaskId=648c0**1cab5d0&Region=cn
```

--------------------------------

### AppLog.start()

Source: https://www.volcengine.com/docs/508/176063?lang=zh

在确保获得用户授权并进入业务场景后，调用此方法手动启动 Applog 模块，开始进行日志上报和数据采集操作。

```APIDOC
### AppLog.start()

#### Description
手动启动 Applog 模块，开始日志上报和数据采集。请在获得用户授权后调用。

#### Method
`AppLog.start()`
```

--------------------------------

### GetImageTranscodeDetails Request Example

Source: https://www.volcengine.com/docs/508/1107749

Example of a GET request to retrieve image transcoding details.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageTranscodeDetails&Version=2018-08-01&QueueId=64993499**0df83eb707812&StartTime=1687276800&EndTime=1687967999&Offset=0&Limit=10
```

--------------------------------

### MonitorInitOptions

Source: https://www.volcengine.com/docs/508/1272435?lang=zh

Configuration options for initializing the image loading monitor.

```APIDOC
## MonitorInitOptions

### Description
Configuration object used to initialize the image loading listener in the veImageX SDK.

### Parameters
- **el** (string | HTMLElement) - Required - The element to monitor. Can be a specific img/picture tag or a selector string.
- **selector** (string) - Optional - Filter selector for monitored elements. Defaults to 'img'.
- **region** ("cn" | "sg") - Required - The region, which affects the reporting domain.
- **appId** (number) - Required - The application ID.
- **enableCloudConfig** (boolean) - Optional - Whether to enable cloud configuration delivery.
- **userUniqueId** (string) - Optional - Unique identifier for the user.
- **defaultConfig** (object) - Optional - Default configuration including report rates.
- **include** (RegExp[]) - Optional - Regex rules for URLs to include in reporting.
- **exclude** (RegExp[]) - Optional - Regex rules for URLs to exclude from reporting.
- **css** (boolean) - Optional - Whether to monitor and report image loading within CSS.
```

--------------------------------

### GetVideoAuditResult Request Example

Source: https://www.volcengine.com/docs/508/1784439?lang=zh

Example of a GET request to the GetVideoAuditResult endpoint with various query parameters.

```http
GET https://imagex.volcengineapi.com/?Action=GetVideoAuditResult&Version=2023-05-01&AuditSuggestion=nopass&ImageType=fail&Limit=10&Marker=6940d****125072&Problem=video_porn&TaskId=971917**019018&Type=UrlFile
```

--------------------------------

### GetImageAuditTaskResult Request Example

Source: https://www.volcengine.com/docs/508/1784436?lang=zh

Example of a GET request to retrieve image audit task results.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageAuditTaskResult&Version=2023-05-01&AuditSuggestion=nopass&ImageType=fail&Limit=10&Marker=6940d****125072&Problem=porn&TaskId=971917**019018&Type=UrlFile
```

--------------------------------

### start

Source: https://www.volcengine.com/docs/508/66132?lang=zh

开始执行上传任务。

```APIDOC
## start

### 描述
根据文件 key 开始上传任务。

### 参数
- **Key** (String) - 必填 - addImageFile 返回的文件 key

### 示例
```javascript
ttUploader.start(fileKey);
```
```

--------------------------------

### SDK Initialization with Permanent Credentials

Source: https://www.volcengine.com/docs/508/1250175

How to initialize the service using permanent AK/SK credentials.

```APIDOC
## Initialization (Permanent Credentials)

```typescript
import { imagex } from "@volcengine/openapi";

const imagexService = imagex.defaultService;

// Set permanent credentials
imagexService.setAccessKeyId(AccessKeyId);
imagexService.setSecretKey(SecretKey);
```
```

--------------------------------

### DescribeImageXEdgeRequestTraffic Request Example

Source: https://www.volcengine.com/docs/508/177110

A GET request example for the DescribeImageXEdgeRequestTraffic API with various query parameters.

```http
GET https://imagex.volcengineapi.com/?Action=DescribeImageXEdgeRequestTraffic&Version=2018-08-01&DomainNames=xxx.com%2Cyyy.com&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=DomainName&Interval=300&Isp=%E7%A7%BB%E5%8A%A8%2C%E8%81%94%E9%80%9A&Protocols=HTTP%2CHTTPS&Regions=%E4%B8%AD%E5%9B%BD%E5%A4%A7%E9%99%86&ServiceIds=ysl%2A%2A%2A%2C4qp%2A%2A%2A&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00&UserCountry=%E4%B8%AD%E5%9B%BD&UserProvince=%E5%8C%97%E4%BA%AC
```

--------------------------------

### Synchronous AI Image Processing in Go

Source: https://www.volcengine.com/docs/508/136551

Demonstrates how to initialize the ImageX service and execute an AI processing task using a workflow template. Ensure environment variables for AccessKey and SecretKey are configured securely before execution.

```go
package imagex_test

import (
        "context"
        "encoding/json"
        "fmt"
        "testing"

        "github.com/volcengine/volc-sdk-golang/base"
        imagex "github.com/volcengine/volc-sdk-golang/service/imagex/v2"
)

func Test_AIProcess(t *testing.T) {
        instance := imagex.NewInstance()

        instance.SetCredential(base.Credentials{
              // 强烈建议不要把 ak 和 sk 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 ak 和 sk，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ak 和 sk。
                AccessKeyID:     "ak",
                SecretAccessKey: "sk",
        })

        param := &imagex.AIProcessReq{
                AIProcessBody: &imagex.AIProcessBody{
                  ServiceID: "91**2g", // 必选。服务 ID。
                  WorkflowTemplateID: "system_workflow_ai_bgfill",   // 必选。模板 ID。固定取值。
                  WorkflowParameter: "{\"Input\":{\"ObjectKey\":\"example.webp\",\"DataType\":\"uri\"},\"BgfillParam\":{\"Model\":3,\"Top\":0.1,\"Bottom\":0.1,\"Left\":0.1,\"Right\":0.1}}", // 必选。根据本文模板说明 > 输入参数，设置该参数取值。
 },
        }
        
        resp, err := instance.AIProcess(context.Background(), param)

        if err != nil {
                fmt.Printf("error %v", err)
        } else {
                t, _ := json.Marshal(resp)
                fmt.Printf("success %v", string(t))
        }
}
```

--------------------------------

### GetImageAllDomainCert API Request Example

Source: https://www.volcengine.com/docs/508/146801?lang=zh

Example of a GET request to retrieve all domain and certificate information.

```http
GET https://imagex.volcengineapi.com/Action=GetImageAllDomainCert&Version=2018-08-01
```

--------------------------------

### GetImageSettings Request Example

Source: https://www.volcengine.com/docs/508/1324617

Example of a GET request to retrieve image settings for the HEIF category.

```http
GET https://imagex.volcengineapi.com/?Action=GetImageSettings&Version=2023-05-01&AppId=56**80&Category=HEIF
```

--------------------------------

### Install ImageX SDK

Source: https://www.volcengine.com/docs/508/1121833?lang=zh

Use yarn to add the ImageX package to your Douyin mini program project.

```bash
yarn add @volcengine/imagex-mp-douyin
```

--------------------------------

### DescribeImageXRequestCntUsage Request Example

Source: https://www.volcengine.com/docs/508/1209561

Example of a GET request to the DescribeImageXRequestCntUsage endpoint with various query parameters.

```http
GET https://imagex.volcengineapi.com/?Action=DescribeImageXRequestCntUsage&Version=2023-05-01&ServiceIds=s1,s2&AdvFeats=a1,a2&Templates=t1,t2&GroupBy=AdvFeat&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300
```

--------------------------------

### Fresco.initialize

Source: https://www.volcengine.com/docs/508/1262419

Initializes the Fresco framework with various configuration options.

```APIDOC
## public static void initialize(Context context)

### Description
Initializes the Fresco framework using default configurations.

### Parameters
- **context** (Context) - Required - Application context object.

## public static void initialize(Context context, @Nullable ImagePipelineConfig imagePipelineConfig)

### Description
Initializes the Fresco framework with a custom image pipeline configuration.

### Parameters
- **context** (Context) - Required - Application context object.
- **imagePipelineConfig** (@Nullable ImagePipelineConfig) - Optional - Image pipeline configuration.

## public static void initialize(Context context, @Nullable ImagePipelineConfig imagePipelineConfig, @Nullable DraweeConfig draweeConfig, boolean useNativeCode)

### Description
Initializes the Fresco framework with custom image pipeline and Drawee configurations, with an option to enable native code.

### Parameters
- **context** (Context) - Required - Application context object.
- **imagePipelineConfig** (@Nullable ImagePipelineConfig) - Optional - Image pipeline configuration.
- **draweeConfig** (@Nullable DraweeConfig) - Optional - Drawee configuration.
- **useNativeCode** (boolean) - Required - Whether to use native code.
```
Tokens:
Raw