imagex-knowledge

Integrate veImageX server SDKs for image upload, management, and AI processing.

Updated Apr 30, 2026
One-click install
npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill imagex-knowledge-yuezhen-huang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: imagex-knowledge
Source: https://github.com/yuezhen-huang/my-bytedance-skillhub/tree/main/imagex-knowledge
Command: npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill imagex-knowledge-yuezhen-huang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Server-side developers integrating ByteDance's veImageX image platform often struggle to navigate its large API surface, choose between sync/async processing modes, and handle platform-specific error codes correctly. ## Core Features & Use Cases - Image Resource Management: Upload, query, delete, update, prefetch, and refresh cached images via APIs like ApplyImageUpload, CommitImageUpload, and UpdateImageUploadFiles. - AI Image Processing: Create synchronous (AIProcess) or asynchronous (CreateImageAITask) AI tasks for OCR, super-resolution, watermark erasure, and quality evaluation. - Error Handling Guidance: Map veImageX error codes (5000-series decoding errors, 600xxx add-on errors) to concrete remediation steps. - Use Case: A backend engineer needs to batch-process user-uploaded images with super-resolution. The Skill guides them to submit a CreateImageAITask with a workflow template, poll GetImageAITasks for status, and handle rate limits of 1 request/second. ## Quick Start Ask the AI how to upload an image to veImageX and run an async AI processing task using the Golang server SDK.

Frequently Asked Questions about imagex-knowledge

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I upload images to veImageX using the server SDK?

Use the SDK's integrated UploadImages method, which wraps the ApplyImageUpload and CommitImageUpload APIs. This handles obtaining the upload address and reporting completion in one call, rather than invoking the raw APIs separately.

What is the difference between veImageX sync and async AI image processing?

AIProcess runs synchronously with a 30-second timeout for real-time tasks, while CreateImageAITask submits asynchronous jobs with a 10-second submission timeout for batch workloads. Both are rate-limited to 1 request per second per user.

Which programming languages does the veImageX server SDK support?

The veImageX server SDK supports Golang, Java, Python, and PHP. Each language has official documentation on the Volcengine docs site covering installation and API usage.

Why does veImageX return error code 5000 or 5001 during image processing?

Error 5000 means decoder construction failed and 5001 means decoding failed, usually because the image format is unsupported or the source file is corrupted. Verify the original image integrity and confirm the format is supported before retrying.

Can veImageX APIs be called outside China regions?

No, veImageX API endpoints only support calls within the China region, corresponding to region cn-north-1. Requests from other regions are not supported by the service endpoints.

When should I use console templates instead of image processing APIs?

Basic operations like cropping, scaling, watermarking, and format conversion (e.g., JPEG to HEIC) should be configured as console templates and applied via the image URL. Reserve API calls for resource management and AI algorithm tasks.