API protocol
即梦 / Jimeng: parameters, scenarios and API guide
Preview guide
Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.
Direct answerThe current official index marks video generation 3.0/3.0 Pro documentation as being retired. This guide has no confirmed exact site Jimeng video model; retain verification notes without borrowing image or Seedance fields.
Updated · Reviewed
Purpose and workflows
Jimeng image and video tasks differ. A public video endpoint was not verified; image examples are not video requests.
This guide checks the site request contract; it does not claim paid generation acceptance for every scenario. Use the exact model, group and available endpoint shown in the marketplace. Replace example.com media and placeholder task IDs. Confirm a minimal request before adding references and advanced parameters. Consult marketplace pricing and actual billing for charges.
Models and endpoints
This family has no published executable site generation request here. The guide retains selection and migration information; a catalog entry is not endpoint acceptance.
Reference media formats
| Media | Fields | Encoding and transport | Preparation and limits |
|---|---|---|---|
| Images / frames | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
| Reference / edit video | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
| Reference audio | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
Parameters and combinations
- The current official index marks video generation 3.0/3.0 Pro documentation as being retired. This guide has no confirmed exact site Jimeng video model; retain verification notes without borrowing image or Seedance fields.
- Accepted unified video examples are not currently published. Review the family and requirements without inventing endpoints/model suffixes or restoring withdrawn Remix examples.
- Confirm the exact marketplace model, effective endpoint, group access and task response. Acceptance does not mean a finished video.
- Verify text generation, image input, output settings and terminal status before independently testing editing, extension, sound and multiple references.
| Field | Type | Use and constraints |
|---|---|---|
图片与视频任务区分 | 待核验 / verify | Image versus video task: verify the site contract for the exact model; do not reuse another family’s enums. |
模型版本、首帧和任务查询 | 待核验 / verify | Model version, first frame and polling: verify the site contract for the exact model; do not reuse another family’s enums. |
Scenarios and code examples
Check whether the exact model has an available endpoint and a published parameter contract. Verify minimal text input, a single image, output settings and terminal task results in that order. Do not construct model suffixes from another platform, or reuse another family’s prompt/content/contents schema. Unpublished scenarios have no submit action or executable sample.
Task results and downloads
Save id or task_id from submission. Poll GET /v1/videos/{task_id}: queued / in_progress lead to completed or failed. Read video_url on completion (some responses also expose metadata.url). Resolve relative URLs against the API origin. The site /content endpoint uses your site key; external downloads must not receive that key. Download expiring results promptly. Resume GET after a timeout rather than automatically repeating POST.
Complete unified video Python / JavaScript polling and download examples
Troubleshooting
| Symptom | Check |
|---|---|
| Image validation / URI error | Ensure a video or task ID was not placed in an image field; check the URL returns media |
| Unsupported content type / field | Check the exact family and content/contents/input schema; voice_id cannot be an audio URL |
| 400 conflicting fields | Check prompt/input, frames/references, and seconds/response_format exclusivity |
| HTTP success but task failed | Retain the site task ID, time, model, domain and redacted request; submission 200 is not output success |
| 404 or inaccessible task | Check domain, key access and task type; do not use IDs from another site or the official API |
| Local file cannot be fetched | Use a supported upload flow or a reachable HTTPS media URL |
Sources and scope
Use cases
- Choose video models and media formats
- Diagnose request and task failures
API protocols
/v1/models
FAQ
Does a task ID prove generation succeeded?
No. Save the site task ID, poll to a successful terminal state and verify the result. Inspect failures instead of automatically creating a new task.
Can I put a local image, video or WAV path in JSON?
No. URL fields require reachable media, not localhost, disk paths or browser-login links. Kling PCM WAV requires an enabled multipart voice endpoint (both sites returned 404 on 2026-11-15). Follow each family’s asset workflow for other media.
Can parameters and task IDs be reused across models?
Do not assume compatibility. Check the exact model, endpoint, casing, media role and exclusive fields. Editing, drafts and voices require accessible successful tasks of the correct kind. Official capabilities are not evidence of site acceptance.
Related guides
Official sources
- Jimeng documentation Official
兔子API