---
title: "Submit Omni Reference Task"
method: POST
path: "/v1/common_task/omni_reference/task/submit"
---

# Submit Omni Reference Task

`POST /v1/common_task/omni_reference/task/submit`

Submit an Omni Reference video generation task. Omni Reference is an advanced video editing/generation feature that supports reference images and videos to guide the generation process. Supports multiple AI models with customizable resolution, aspect ratio, duration, and other parameters.

## Headers

- `Topview-Uid` string, required
- `Authorization` string, required

## Request body

- object
  - `model` string, required — Model name, e.g., 'Kling O3 Video-Edit', 'Kling O1 Video-Edit', etc.
  - `prompt` string, required — Positive prompt describing the video to generate. Supports reference syntax: <<<ImageN>>> for image references and <<<VideoN>>> for video references (e.g., '<<<Image1>>> person dancing to <<<Video1>>> background')
  - `inputImages` object[] — List of reference images. Each image can be referenced in prompt using <<<ImageN>>> syntax (optional)
    - `fileId` string — File ID returned from /upload endpoint
    - `name` string — Reference name used in prompt, e.g., 'Image1', 'Image2', corresponding to <<<Image1>>>, <<<Image2>>> in prompt
  - `inputVideos` object[] — List of reference videos. Each video can be referenced in prompt using <<<VideoN>>> syntax (optional)
    - `fileId` string — File ID of the uploaded video
    - `name` string — Reference name used in prompt, e.g., 'Video1', 'Video2', corresponding to <<<Video1>>>, <<<Video2>>> in prompt
  - `aspectRatio` string — Aspect ratio such as '16:9', '9:16', '1:1', etc. (optional, depends on model support)
  - `resolution` 480 | 720 | 1080 — Video resolution: 480 or 720 or 1080 (optional)
  - `duration` integer — Video duration in seconds. Supported values depend on the model used (optional)
  - `generatingCount` integer — Number of videos to generate: 1-4 (optional, default: 1)
  - `internetSearch` boolean — Whether to enable internet search for better results (optional, default: false)
  - `boardId` string — Board ID. When provided, creates a board task record in the system (optional)
  - `noticeUrl` string — Callback URL for task completion notifications. Please refer to the [API documentation](https://docs.topview.ai/reference/post_notice-notice-url-check#/) for details (optional)

## Response `200`

Task submitted successfully

- object
  - `code` string — Response status code
  - `message` string — Response message
  - `result` object — Task submission result
    - `taskId` string — Task ID for subsequent result queries
    - `status` 'init' | 'running' | 'success' | 'fail' — Task status, initial value is 'init'
    - `boardTaskIds` string[] — List of board task IDs (returned if task is associated with a board)
    - `boardId` string — Board ID (returned if task is associated with a board)
    - `noticeUuid` string — Notification UUID for async callback tracking

---

[API](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme.md) · [All operations](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/topview/image-character-swap-apis-editable-in-readme/revisions/83cd46ca7859/schema)
