Omni API Docs

快速开始

创建第一个 Omni API 任务。

快速开始

这一页展示从 API Key 到任务结果的最短路径。

1. 创建 API Key

打开 Console，使用 Google 或邮箱登录，然后创建 API Key。正式产品里应把 API Key 保存在服务端。

export OMNI_API_KEY="your_api_key"
export OMNI_API_BASE="https://omniapi.net"

2. 查看模型

curl "$OMNI_API_BASE/api/omni/models"

响应会包含模型组、任务类型、输入 schema 和输出 schema。公开目录只展示已经 ready 的模型组。

3. 创建纯文本任务

纯文本任务可以直接创建。

curl -X POST "$OMNI_API_BASE/api/omni/tasks/create" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model_group":"omni-image-aio",
    "task_type":"text_to_image",
    "inputs":{"prompt":"a clean studio product photo"}
  }'

创建响应会返回 portal_task_id、状态、队列信息，以及可用时的输出访问方式。

4. 创建带文件的任务

编辑类任务先申请预签名上传地址，完成上传后，再用返回的 canonical input_manifest 一次性创建任务。

curl -X POST "$OMNI_API_BASE/api/omni/tasks/presign" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model_group":"omni-image-aio",
    "task_type":"single_image_edit",
    "files":[
      {"name":"source_image","filename":"input.png","content_type":"image/png","size_bytes":12345}
    ]
  }'

curl -X PUT "{uploads[0].upload_url}" \
  -H "Content-Type: image/png" \
  --data-binary @input.png

curl -X POST "$OMNI_API_BASE/api/omni/tasks/create" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model_group":"omni-image-aio",
    "task_type":"single_image_edit",
    "inputs":{"prompt":"make the product photo cleaner"},
    "input_manifest":{"items":[{"name":"source_image","role":"source_image","object_ref":"inputs/.../input.png","filename":"input.png","media_type":"image","content_type":"image/png","size_bytes":12345}]}
  }'

5. 查询状态

curl "$OMNI_API_BASE/api/omni/tasks/{portal_task_id}" \
  -H "Authorization: Bearer $OMNI_API_KEY"

排队中的任务会返回队列信息。图像、视频和音频任务成功后，输出通过对象存储 URL 返回。