> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gmicloud.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# wan2.6-r2v

> API usage guide for wan2.6-r2v.

{/* source_model_id: wan2.6-r2v */}

{/* source_updated_at: 1782168382 */}

**Model ID**

```bash theme={null}
wan2.6-r2v
```

**Calling method:** async

# wan2.6-r2v API Usage Guide

## Overview

**wan2.6-r2v** performs reference-to-video generation.

Requests are submitted via the request-queue API and results are retrieved by polling.

## Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Submit Video Generation Request

### Base URL

```
https://console.gmicloud.ai
```

### Endpoint

```
POST /api/v1/ie/requestqueue/apikey/requests
```

### Request Format

```bash theme={null}
curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "wan2.6-r2v",
    "payload": {
      "prompt": "character1 walks into a cozy cafe and greets character2 at the counter",
      "reference_video_urls": [
        "https://example.com/character1.mp4",
        "https://example.com/character2.mp4"
      ],
      "negative_prompt": "blurry, low quality, distorted",
      "size": "1920*1080",
      "duration": 10,
      "shot_type": "single",
      "watermark": false,
      "seed": 424242
    }
  }'
```

### Request Parameters

| Parameter                      | Type                    | Required | Description                                                                                  | Default      | Constraints                                                                                                                                   |
| ------------------------------ | ----------------------- | -------- | -------------------------------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `model`                        | string                  | Yes      | Model identifier                                                                             | -            | Must be `"wan2.6-r2v"`                                                                                                                        |
| `payload.prompt`               | string                  | No       | Text prompt describing the scene; reference characters with `character1`, `character2`, etc. | ""           | Max 1500 characters                                                                                                                           |
| `payload.reference_video_urls` | array of strings (URLs) | Yes      | Reference videos used to extract appearance/voice                                            | -            | 1–3 videos; each contains one character; order maps to `character1..3`                                                                        |
| `payload.negative_prompt`      | string                  | No       | What to avoid in the video                                                                   | ""           | Max 500 characters                                                                                                                            |
| `payload.size`                 | string (enum)           | No       | Output resolution                                                                            | "1920\*1080" | Options: "1280\*720", "720\*1280", "960\*960", "1088\*832", "832\*1088", "1920\*1080", "1080\*1920", "1440\*1440", "1632\*1248", "1248\*1632" |
| `payload.duration`             | integer (enum)          | No       | Video length in seconds                                                                      | 5            | Options: 5, 10                                                                                                                                |
| `payload.shot_type`            | string (enum)           | No       | Single vs multi-shot sequencing                                                              | "single"     | Options: "single", "multi"                                                                                                                    |
| `payload.watermark`            | boolean                 | No       | Add fixed `AI Generated` watermark                                                           | false        | -                                                                                                                                             |
| `payload.seed`                 | integer                 | No       | Random seed for reproducibility                                                              | -            | 0–2147483647                                                                                                                                  |

### Response

```json theme={null}
{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "model": "wan2.6-r2v",
  "status": "queued",
  "created_at": 1750442925,
  "updated_at": 1750442925,
  "queued_at": 1750442925
}
```

## Check Request Status

### Endpoint

```
GET /api/v1/ie/requestqueue/apikey/requests/{request_id}
```

### Example

```bash theme={null}
curl -X GET "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response

```json theme={null}
{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "your-org-id",
  "model": "wan2.6-r2v",
  "status": "success",
  "is_public": false,
  "payload": {
    "prompt": "character1 walks into a cozy cafe and greets character2 at the counter",
    "reference_video_urls": [
      "https://example.com/character1.mp4",
      "https://example.com/character2.mp4"
    ],
    "negative_prompt": "blurry, low quality, distorted",
    "size": "1920*1080",
    "duration": 10,
    "shot_type": "single",
    "watermark": false,
    "seed": 424242
  },
  "outcome": {
    "video_url": "https://storage.googleapis.com/bucket/generated-video.mp4",
    "thumbnail_image_url": "https://storage.googleapis.com/bucket/thumbnail.jpg"
  },
  "created_at": 1750442925,
  "updated_at": 1750442930,
  "queued_at": 1750442925
}
```

## Request Status Values

| Status       | Description                             |
| ------------ | --------------------------------------- |
| `queued`     | Request is waiting to be processed      |
| `processing` | Video generation is in progress         |
| `success`    | Video generation completed successfully |
| `failed`     | Video generation failed                 |
| `cancelled`  | Request was cancelled                   |

## List Your Requests

### Endpoint

```
GET /api/v1/ie/requestqueue/apikey/requests?model_id=wan2.6-r2v
```

### Example

```bash theme={null}
curl -X GET "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests?model_id=wan2.6-r2v" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## List Available Models

### Endpoint

```
GET /api/v1/apikey/models
```

### Example

```bash theme={null}
curl -X GET "https://api.example.com/api/v1/apikey/models" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response

```json theme={null}
{
    "model_ids": [
        "wan2.6-t2v",
        "wan2.6-i2v",
        "wan2.6-r2v"
    ]
}
```