API Reference

This reference gives developers and automation agents one compact place to find Weydub API endpoints, access checks, request shape, async behavior, billing/retention rules, and troubleshooting signals.

Request Basics

Some legacy infrastructure names may still appear in public demo assets or older account paths. Treat this Weydub API documentation as the current product-facing contract.

Before You Call

Authentication

Most requests use headers:

Content-Type: application/json
AppKey: $WEYDUB_APP_KEY
AppSign: md5(md5(request_body) + $WEYDUB_APP_SECRET)

Sign the exact compact JSON body that will be sent. Read Auth and signing before debugging signature failures.

Unsigned exception:

POST /v-w-c/enum/query2

The enum query endpoint is used for dynamic language/status lists and does not require signing.

Endpoint Index

Create Video Task

POST /v-w-c/gateway/ve/work/free

Common workflows using this endpoint:

Minimal request:

{
  "urls": ["https://example.com/demo.mp4"],
  "needChineseOcclude": 1,
  "videoInpaintLang": "all",
  "callback": "https://your-domain.example/webhooks/weydub"
}

Typical create response fields:

Query Video Status

POST /v-w-c/gateway/ve/work/status

{
  "idWorks": [488026661]
}

Status values:

Successful video tasks can include videoUrl, coverUrl, srcSrtUrl, tgtSrtUrl, sourceVideoUrl, ttsMetaResult, wyVoiceParam, and task metadata.

Image Tasks

Current public create endpoint:

POST /v-w-c/gateway/ve/image/translate

Redo endpoint:

POST /v-w-c/gateway/ve/image/translate/redo

Image translation request:

{
  "srcLang": "en",
  "tgtLang": "es",
  "translateOn": 1,
  "synthesisOn": 1,
  "commodityFilterOn": 0,
  "downloadInfo": "{\"url\":\"https://example.com/product.png\",\"fileName\":\"product.png\",\"id\":12345,\"materialName\":\"product.png\"}",
  "app": "WD"
}

Image text removal request:

{
  "srcLang": "en",
  "tgtLang": "en",
  "translateOn": 0,
  "synthesisOn": 1,
  "commodityFilterOn": 0,
  "downloadInfo": "{\"url\":\"https://example.com/banner.png\",\"fileName\":\"banner.png\",\"id\":12346,\"materialName\":\"banner.png\"}",
  "app": "WD"
}

Read Image translation before implementing image jobs because downloadInfo, downloadInfos, and redo result must keep their documented string shape.

Enum Query

POST /v-w-c/enum/query2

This endpoint does not require AppSign.

{
  "text": "Lang"
}

Common enum names:

Billing, Limits, And Retention

Callback Summary

Pass a callback URL in create requests when supported. Weydub sends the completed work item directly to your server, without the outer code / msg / body wrapper used by polling responses.

Callback handling rules:

• Verify Callback-Sign using the raw callback request body and your AppSecret.
• Return HTTP 200 plus any non-empty body only after durable storage succeeds.
• Make handlers idempotent by work/task ID.
• Failed callbacks for tasks created within the last 24 hours are retried about every 30 minutes.
• If a redo changes video or image content, the output URL can change; store the newest result URL.

Read Async task model for callback details.

Troubleshooting

Agent Contract

Automation agents should:

• Load llms.txt and Weydub API Skill.
• Use Demo scenarios before customer media.
• Keep credentials in environment variables or a secret manager.
• Persist IDs before reporting success to users.
• Model jobs as submitted -> processing -> succeeded | failed | timed_out.
• Never expose AppSecret or invent enabled endpoints.