AI Upscale API Documentation

Overview

Enhance the resolution of images and videos using AI super-resolution. Sharpens fine detail and reduces compression artifacts without visible upscale noise.

Primary Endpoint

POST/api/v1/userUpscale/start

Start upscale task

Request Parameters

Name	Type	Required	Description
name	string	No	Name of the upscale task
source_url	string	Yes	URL of the source image or video
webhook_url	string	No	HTTPS URL to receive task.completed / task.failed notifications. Best-effort delivery, single attempt, no retries; clients should treat the detail API as the source of truth.
webhook_token	string	No	Optional plaintext token returned in the X-A2e-Webhook-Token header so receivers can verify the request originated from a2e.

Request Example

curl -X POST "https://www.a2e.com.cn/api/v1/userUpscale/start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Upscale media",
  "source_url": "https://example.com/video.mp4",
  "webhook_url": "https://your-server.example.com/a2e/webhook",
  "webhook_token": "a-shared-secret"
}'

Related Endpoints

POST/api/v1/userUpscale/start

Start upscale task

GET/api/v1/userUpscale/allRecords

Get all task records

POST/api/v1/userUpscale/batchDetail

Batch query task details

GET/api/v1/userUpscale/{_id}

Get task details

DELETE/api/v1/userUpscale/{_id}

Delete task

Responses

200

Successful response

400

Bad Request

401

Unauthorized