> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crun.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Vidu Q3 - Reference to Video
> Use Vidu Q3 reference-to-video to generate videos from one or more reference images.
## Query Task Status
After submitting a task, use the unified query endpoint to check progress and retrieve results:
Learn how to query task status and retrieve generation results
For production use, we recommend using the `callback_url` parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.
## Related Resources
Explore all available models
Check credits and account usage
## OpenAPI
````yaml models/vidu/q3/reference-to-video.json post /api/v1/client/job/CreateTask
openapi: 3.0.0
info:
title: Crun Vidu Q3 API
description: crun.ai Vidu Q3 API Documentation
version: 1.0.0
contact:
name: Technical Support
email: support@crun.ai
servers:
- url: https://api.crun.ai
description: API Server
security:
- ApiKeyAuth: []
paths:
/api/v1/client/job/CreateTask:
post:
summary: Vidu Q3 reference to video
operationId: vidu/q3-r2v
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- vidu/q3-r2v
description: |-
The model name to use for generation. Required field.
- Must be `vidu/q3-r2v` for this endpoint
callback_url:
type: string
format: uri
description: >-
Optional. Callback URL for receiving task completion
notifications.
- System will POST task status and results to this URL when
generation completes
- Callback payloads structure is consistent with the `data`
object returned by the task status query
- Your callback endpoint should accept POST requests with
JSON payload containing results
- It returns an HTTP 200 status code upon successful receipt
example: https://your-domain.com/api/callback
input:
type: object
description: >-
Input parameters for Vidu Q3 reference-to-video generation.
Reference images in `img_urls` are mapped to subjects
internally.
properties:
prompt:
type: string
description: Text prompt to guide generated video content.
maxLength: 5000
example: >-
A cinematic shot where the character turns around and
smiles while the camera slowly pushes in.
img_urls:
type: array
description: >-
Reference image URLs used to preserve
character/style/scene consistency.
items:
type: string
format: uri
minItems: 1
maxItems: 7
example:
- https://example.com/reference-1.jpg
- https://example.com/reference-2.jpg
aspect_ratio:
type: string
description: Output video aspect ratio.
enum:
- '16:9'
- '9:16'
- '4:3'
- '3:4'
- '1:1'
- auto
default: '16:9'
example: '16:9'
resolution:
type: string
description: Output video resolution.
enum:
- 540p
- 720p
- 1080p
default: 720p
example: 720p
duration:
type: integer
description: Video duration in seconds.
minimum: 1
maximum: 16
default: 5
example: 5
audio:
type: boolean
description: Whether to generate audio along with the video.
default: false
example: true
audio_type:
type: string
description: >-
Audio generation mode. This field is only effective when
`audio` is `true`.
enum:
- all
- speech_only
- sound_effect_only
default: all
example: all
moderation:
type: string
description: >-
Content moderation switch. Use `enabled` to enable
moderation and `disabled` to disable it. Defaults to
`enabled`.
enum:
- disabled
- enabled
default: enabled
example: enabled
required:
- prompt
- img_urls
example:
model: vidu/q3-r2v
callback_url: https://your-domain.com/api/callback
input:
prompt: >-
A portrait subject walks toward camera with natural motion and
soft cinematic lighting.
img_urls:
- https://example.com/reference-1.jpg
- https://example.com/reference-2.jpg
aspect_ratio: '16:9'
resolution: 720p
duration: 5
audio: true
audio_type: all
moderation: enabled
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
task_id:
type: string
description: >-
Task ID, can be used with Get Task Details
endpoint to query task status
example: task_12345678
example:
code: 200
message: success
data:
task_id: task_12345678
'422':
description: Validation Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
errors:
type: array
description: Detailed validation error messages
items:
type: string
example:
- >-
Value error, Invalid input for model vidu/q3-r2v:
aspect_ratio: Input should be '16:9', '9:16', '4:3',
'3:4', '1:1' or 'auto'
example:
code: 422
message: Missing Params or Type Error
errors:
- >-
Value error, Invalid input for model vidu/q3-r2v:
aspect_ratio: Input should be '16:9', '9:16', '4:3', '3:4',
'1:1' or 'auto'
'500':
$ref: '#/components/responses/Error'
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 455
- 500
- 501
- 505
description: >-
Response status code
- **200**: Success - Request has been processed successfully
- **401**: Unauthorized - Authentication credentials are missing or
invalid
- **402**: Insufficient Credits - Account does not have enough
credits to perform the operation
- **404**: Not Found - The requested resource or endpoint does not
exist
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **455**: Service Unavailable - System is currently undergoing
maintenance
- **500**: Server Error - An unexpected error occurred while
processing the request
- **501**: Generation Failed - Content generation task failed
- **505**: Feature Disabled - The requested feature is currently
disabled
message:
type: string
description: Response message, error description when failed
example: success
responses:
Error:
description: Server Error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
All APIs require authentication via API Key.
Get API Key:
1. Visit [API Key Management Page](https://crun.ai/user-api-key) to get
your API Key
Usage:
Add to request header:
x-api-key: YOUR_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately
in the management page
````