# see2ai_image_generation_v1

> SEE2AI 标准图像生成服务，支持文字生成图片，也支持传入参考图进行可控创作。适合海报、商品图、视觉素材等需要快速出图和统一托管结果的场景。

## 📖 接入指引

**Endpoint**: `POST /api/v1/actions/see2ai_image_generation_v1`

**认证方式**: Bearer Token (租户 API Key)

### Endpoints

| Method | Path | Purpose |
| --- | --- | --- |
| `POST` | `/api/v1/actions/see2ai_image_generation_v1` | Submit the standard action request. |
| `POST` | `/api/v1/actions/see2ai_image_generation_v1/async` | Submit an asynchronous standard image job. Returns `task_id` and initial `status`. |
| `GET` | `/api/v1/actions/see2ai_image_generation_v1/status/{task_id}` | Poll the standard image job. When completed, read final images from `result_urls`. |

### Async Result Flow

1. Submit the generation request and save the returned `task_id`.
2. Poll `GET /api/v1/actions/see2ai_image_generation_v1/status/{task_id}` with the same API key until the task reaches a terminal status.
3. Read the final artifact URL from the status response. Use `image_url` for UniWorld and `result_urls` for image/video actions.

> **⚠️ 重要提示**
> 
> 本 API 是 SEE2AI 平台标准化封装后的接口，**参数格式与任何上游 API 不同**。
> 请直接使用下方 Schema 中定义的参数，无需参考其他文档。
> 
> *例如：*
> *- 文本模型参数可能是 `query` 而不是 `messages` 数组*
> *- 视频模型参数可能是 `brief` (创意简报) 而不是复杂的配置项*

## 📥 输入参数 (Input Schema)

```json
{
  "properties": {
    "prompt": {
      "description": "目标图像的文字说明，最多 20,000 个字符。",
      "maxLength": 20000,
      "title": "Prompt",
      "type": "string"
    },
    "input_urls": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "可选公网参考图片 URL。留空时直接按文字说明生成图片；如果只有本地文件，请先调用 `see2ai_storage_upload_v1` 上传后再传入返回的 URL。",
      "title": "Input Urls"
    },
    "image_input": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "`input_urls` 的兼容别名。新调用建议优先使用 `input_urls`。",
      "title": "Image Input"
    },
    "aspect_ratio": {
      "default": "auto",
      "description": "目标图片宽高比。",
      "enum": [
        "auto",
        "1:1",
        "9:16",
        "16:9",
        "4:3",
        "3:4"
      ],
      "title": "Aspect Ratio",
      "type": "string"
    },
    "resolution": {
      "default": "2K",
      "description": "目标输出分辨率。",
      "enum": [
        "1K",
        "2K",
        "4K"
      ],
      "title": "Resolution",
      "type": "string"
    }
  },
  "required": [
    "prompt"
  ],
  "title": "ImageGenerationInput",
  "type": "object"
}
```

### 参数说明

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| `prompt` | string | ✅ 是 | `-` | 目标图像的文字说明，最多 20,000 个字符。 |
| `input_urls` | array / null | ❌ 否 | `-` | 可选公网参考图片 URL。留空时直接按文字说明生成图片；如果只有本地文件，请先调用 `see2ai_storage_upload_v1` 上传后再传入返回的 URL。 |
| `image_input` | array / null | ❌ 否 | `-` | `input_urls` 的兼容别名。新调用建议优先使用 `input_urls`。 |
| `aspect_ratio` | string enum | ❌ 否 | `auto` | 目标图片宽高比。 |
| `resolution` | string enum | ❌ 否 | `2K` | 目标输出分辨率。 |

## 📤 输出结果 (Output Schema)

```json
{
  "properties": {
    "input_tokens": {
      "default": 0,
      "description": "输入消耗的词元数量",
      "title": "Input Tokens",
      "type": "integer"
    },
    "output_tokens": {
      "default": 0,
      "description": "输出消耗的词元数量",
      "title": "Output Tokens",
      "type": "integer"
    },
    "total_tokens": {
      "default": 0,
      "description": "总消耗的词元数量",
      "title": "Total Tokens",
      "type": "integer"
    },
    "model": {
      "default": "",
      "description": "实际使用的 SEE2AI 化身模型名称（由各 action 显式填写）",
      "title": "Model",
      "type": "string"
    },
    "source": {
      "default": "see2ai",
      "description": "服务来源（统一 `see2ai`；真实路由仅平台内部可见）",
      "title": "Source",
      "type": "string"
    },
    "cost_points": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "预先计算的扣费词元（如果插件内部已经计算好费用，则直接使用此值，忽略基于词元的计算）",
      "title": "Cost Points"
    },
    "result_urls": {
      "default": [],
      "description": "SEE2AI 托管的结果图片 URL 列表。",
      "items": {
        "type": "string"
      },
      "title": "Result Urls",
      "type": "array"
    },
    "task_id": {
      "description": "生成任务 ID。",
      "title": "Task Id",
      "type": "string"
    },
    "cost_time": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "处理耗时，单位毫秒。",
      "title": "Cost Time"
    },
    "state": {
      "description": "任务最终状态。",
      "title": "State",
      "type": "string"
    },
    "provider_config_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "内部配置 ID，用于平台审计追踪。",
      "title": "Provider Config Id"
    },
    "warnings": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "前置校验器返回的非阻断优化建议。",
      "title": "Warnings"
    }
  },
  "required": [
    "task_id",
    "state"
  ],
  "title": "ImageGenerationOutput",
  "type": "object"
}
```

### 输出字段说明

| 字段名 | 类型 | 说明 |
|--------|------|------|
| `input_tokens` | integer | 输入消耗的词元数量 |
| `output_tokens` | integer | 输出消耗的词元数量 |
| `total_tokens` | integer | 总消耗的词元数量 |
| `model` | string | 实际使用的 SEE2AI 化身模型名称（由各 action 显式填写） |
| `source` | string | 服务来源（统一 `see2ai`；真实路由仅平台内部可见） |
| `cost_points` | integer / null | 预先计算的扣费词元（如果插件内部已经计算好费用，则直接使用此值，忽略基于词元的计算） |
| `result_urls` | array | SEE2AI 托管的结果图片 URL 列表。 |
| `task_id` | string | 生成任务 ID。 |
| `cost_time` | integer / null | 处理耗时，单位毫秒。 |
| `state` | string | 任务最终状态。 |
| `provider_config_id` | integer / null | 内部配置 ID，用于平台审计追踪。 |
| `warnings` | array / null | 前置校验器返回的非阻断优化建议。 |

## 💡 调用示例

### cURL 示例

```bash
curl -X POST "https://see2ai.com/api/v1/actions/see2ai_image_generation_v1" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer sk-your-tenant-api-key" \
     -d '{
  "prompt": "Create a clean product visual with clear composition.",
  "aspect_ratio": "auto",
  "resolution": "2K"
}'
```

### Python 示例

```python
import requests

API_KEY = "sk-your-tenant-api-key"
ENDPOINT = "https://see2ai.com/api/v1/actions/see2ai_image_generation_v1"

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {API_KEY}"
}

payload = {
  "prompt": "Create a clean product visual with clear composition.",
  "aspect_ratio": "auto",
  "resolution": "2K"
}

response = requests.post(ENDPOINT, json=payload, headers=headers)
result = response.json()

print(f"结果：{result}")
```

## 💰 计费说明

> Dynamic pricing by resolution (1K/2K/4K) under the SEE2AI image tier.

**注意**: 所有费用都以词元为单位，系统会自动从租户余额中扣除。

## ⚠️ 常见错误码

| HTTP 状态码 | 错误原因 | 解决方案 |
| --- | --- | --- |
| `400` | Input validation failed before the upstream request. | 请稍后重试 |
| `401` | Provider authentication failed. | 检查 API Key 是否正确，或联系管理员充值 |
| `402` | Insufficient balance. | 请稍后重试 |
| `429` | Provider rate limit exceeded. | 降低请求频率，或联系管理员调整限流配置 |
| `500` | SEE2AI image generation submit, polling, or re-hosting failed. | 稍后重试，如持续失败请联系技术支持 |
| `504` | Polling timed out before the task reached a terminal state. | 请稍后重试 |

## 📞 技术支持

- **文档问题**: 查看 [SEE2AI 官方文档](https://see2ai.com/docs)
- **API 状态**: 访问 [服务状态页面](https://see2ai.com/status)
- **问题反馈**: 联系技术支持团队

---

**API 版本**: see2ai_image_generation_v1
**最后更新**: 2026-03-23