# CogVideoX-5B API

> Cynhyrchu testun-i-fideo gyda CogVideoX-5B, gyda chefnogaeth LoRA a chyfradd fframiau addasadwy

Yn creu fideo byr o `prompt` testun. Dewiswch `video_size` rhagosodedig fel square_hd neu landscape_16_9, gosodwch `num_inference_steps` (1 i 50) a `guidance_scale` (0 i 20), ac ychwanegwch `negative_prompt`. Mae `export_fps` yn amrywio o 4 i 32, mae rhyngosod RIFE ymlaen yn ddiofyn, a gellir defnyddio un LoRA.

- Model id: `cogvideox-5b`
- Made by: Zhipu AI
- Category: Text to Video
- Output: video
- Price: $0.20 / video (cheapest run $0.20 (200 API credits))
- Run: `POST https://api.doitong.ru/v1/run/cogvideox-5b`
- Quote: `POST https://api.doitong.ru/v1/quote/cogvideox-5b`
- Docs page: https://doitong.com/cy/developers/models/cogvideox-5b

## Pricing

Price: **$0.20 / video**. Billed once per generated video.

The full example input below costs $0.20 = 200 API credits (1 video × 200 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.ru/v1/quote/cogvideox-5b` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `prompt` |  | string | yes |  |  | Anogiad a ddefnyddir fel sail ar gyfer cynhyrchu fideo. |
| `video_size` |  | object {width, height} \| enum (string) | no | `{"height":480,"width":720}` | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | Dimensiynau'r fideo a gynhyrchwyd. |
| `negative_prompt` |  | string | no | `` |  | Anogiad negyddol ar gyfer cynhyrchu fideo. |
| `loras` |  | array of object {path, scale} | no | `[]` |  | Darparwch un LoRA ar gyfer cynhyrchu delweddau; ni chefnogir LoRAs lluosog ar hyn o bryd. |
| `loras[].path` |  | string | yes |  |  | Lleoliad pwysau'r LoRA, wedi'i nodi fel URL neu lwybr. |
| `loras[].scale` |  | number | no | `1` | 0 – 4 | Lluosydd a gymhwysir i bwysau'r LoRA cyn ei uno â'r model sylfaenol. |
| `num_inference_steps` |  | integer | no | `50` | 1 – 50 | Cyfrif camau casglu i'w rhedeg. |
| `seed` |  | integer \| null | no |  |  | Hadau ar gyfer cynhyrchu fideo ailadroddadwy. Er mwyn atgynhyrchu'n union ar bob rhediad, rhaid cadw fersiwn y model, yr anogiad a'r hedyn heb eu newid. |
| `guidance_scale` |  | number | no | `7` | 0 – 20 | Glynu wrth yr anogiad pan fydd y model yn chwilio am fideo cysylltiedig i'w arddangos, wedi'i fynegi drwy raddfa CFG (Classifier Free Guidance). |
| `use_rife` |  | boolean | no | `true` |  | Yn galluogi rhyngosod fideo gyda RIFE. |
| `export_fps` |  | integer | no | `16` | 4 – 32 | Cyfradd ffrâm darged ar gyfer y fideo, yn FPS. |
| `enable_safety_checker` |  | boolean | no | `true` |  | Gellir llacio'r sgrinio drwy osod false, ar yr amod bod y galwr wedi'i awdurdodi. |

## Example input

Required parameters only:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.ru/v1/run/cogvideox-5b?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.ru/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.ru/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/cogvideox-5b?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.ru/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/cogvideox-5b", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.ru/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "cogvideox-5b",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "cogvideox-5b",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 200,
    "usd": "0.20",
    "charged": 200,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  },
  "output": {
    "video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    },
    "timings": {},
    "seed": 42,
    "prompt": "string"
  },
  "outputs": [
    {
      "type": "video",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_size": 1843200,
      "width": 1280,
      "height": 720,
      "duration": 5,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `video` | object {url, content_type, file_name, file_size} | URL sy'n pwyntio at y fideo a gynhyrchwyd. |
| `timings` | object |  |
| `seed` | integer | Yr hedyn gwirioneddol a ddefnyddiwyd ar gyfer cynhyrchu fideo, gan gynnwys y gwerth a ddewiswyd ar hap pan hepgorodd y mewnbwn hedyn. Fel arall, mae'n cyfateb i'r hedyn mewnbwn. |
| `prompt` | string | Anogiad a ddefnyddir i gynhyrchu'r fideo. |

## Related models

- [CogVideoX-5B · Image to Video](https://doitong.com/developers/models/cogvideox-5b/image-to-video.md) (`cogvideox-5b/image-to-video`): $0.20 / video
- [CogVideoX-5B · Video to Video](https://doitong.com/developers/models/cogvideox-5b/video-to-video.md) (`cogvideox-5b/video-to-video`): $0.20 / video
- [FLUX 3 Max Text to Video](https://doitong.com/developers/models/blackforestlabs/flux-3-max/text-to-video.md) (`blackforestlabs/flux-3-max/text-to-video`): from $0.0425 / second of output video
- [Grok Imagine Video 1.5 Text to Video](https://doitong.com/developers/models/xai/grok-imagine-video/v1.5/text-to-video.md) (`xai/grok-imagine-video/v1.5/text-to-video`): from $0.08 / second
- [Kling 3.0 Pro Text to Video](https://doitong.com/developers/models/kling-video/v3/pro/text-to-video.md) (`kling-video/v3/pro/text-to-video`): from $0.112 / second
- [LTX 2.5 Pro Text to Video](https://doitong.com/developers/models/lightricks/ltx-2.5/text-to-video/pro.md) (`lightricks/ltx-2.5/text-to-video/pro`): from $0.12 / second
- [MiniMax H3 Text to Video](https://doitong.com/developers/models/minimax/h3/text-to-video.md) (`minimax/h3/text-to-video`): from $0.05 / second
- [Seedance 2.0 Fast Text to Video](https://doitong.com/developers/models/bytedance/seedance-2.0/fast/text-to-video.md) (`bytedance/seedance-2.0/fast/text-to-video`): from $0.113 / second

## Links

- HTML page: https://doitong.com/developers/models/cogvideox-5b
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=cogvideox-5b
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.ru/v1/models/cogvideox-5b