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

# 快速开始

> 三分钟完成首次 API 调用，了解核心概念与调用入口

BizyAir 模型服务把每个 AI 模型（或 AI 应用、工作流）暴露为一个 HTTPS POST 端点。所有任务通过统一的**任务创建接口**发起，根据请求头决定调用模式。

## 核心概念

| 核心概念           | 说明                                                                             |
| -------------- | ------------------------------------------------------------------------------ |
| `web_app_id`   | AI 应用或工作流的唯一数字 ID，从 BizyAir 官网获取                                               |
| `input_values` | 工作流输入参数，键格式为 `节点ID:节点名.字段名`                                                    |
| `requestId`    | 每次任务分配的唯一 ID，用于后续查询/取消/中断                                                      |
| `object_url`   | 结果文件的临时托管地址，含过期时间                                                              |
| `status`       | 任务状态枚举：`Queuing` / `Preparing` / `Running` / `Success` / `Failed` / `Canceled` |
| API Key        | 账号认证凭据，从个人中心生成                                                                 |
| 余额             | 平台预付积分，按实际消耗扣减                                                                 |

## 三分钟快速开始

```bash theme={null}
# 1. 设置 API Key（从个人中心 → API Keys 复制）
export BIZYAIR_API_KEY="your-api-key-here"

# 2. 同步调用 AI 应用，立即获得结果
curl -X POST "https://api.bizyair.ai/w/v1/webapp/task/openapi/create" \
  -H "Authorization: Bearer $BIZYAIR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "web_app_id": 38214,
    "suppress_preview_output": false,
    "input_values": {
      "84:CLIPTextEncode.text": "a futuristic cityscape at sunset, ultra detailed",
      "88:KSampler.seed": 354884000907176,
      "81:EmptySD3LatentImage.width": 1280,
      "81:EmptySD3LatentImage.height": 1280
    }
  }'
```

同步模式下，HTTP 连接会保持打开直到任务完成，响应体直接包含生成结果的 `object_url`。

## 调用入口与端点

所有 API 调用走统一域名 `https://api.bizyair.ai`，按功能分为四组前缀：

`api.bizyair.cn/w/v1 => api.bizyair.ai/v1 `

`api.bizyair.cn/x/v1  => meta.bizyair.ai/v1 `

`api.bizyair.cn/y/v1  => finance.bizyair.ai/v1 `

`api.bizyair.cn/z/v1  => cron.bizyair.ai/v1`