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

# 快速入门

> 发起你的第一个 Vidgo API 请求，了解图像、视频、音频、音乐、3D 与 LLM 模型的请求流程。

# 使用 Vidgo API 构建

通过**一个 API Key** 调用图像、视频、音频、音乐、3D 和 LLM 模型。生成类模型共用同一套异步的提交与查询流程；LLM 模型使用兼容 OpenAI、Claude 和 Gemini 的接口。

> [card] [获取 API Key](https://vidgo.ai/apis/dashboard/api-key)
>
> 在 Vidgo 仪表盘中创建和管理 API Key。

> [card] [发起第一个请求](https://docs.vidgo.ai/zh/api-manual/quickstart.md)
>
> 使用 cURL、Python 或 JavaScript 提交任务并轮询结果。

> [card] [查看价格](https://vidgo.ai/apis/api-pricing)
>
> 查看当前模型价格。

> [card] [处理错误](https://docs.vidgo.ai/zh/api-manual/error-codes.md)
>
> 响应格式与 HTTP 状态码。

> [card] [用 AI 编程助手接入](https://vidgo.ai/zh/apis/agent-setup)
>
> 将 Claude Code、Codex、Cursor 或 OpenCode 接入 Vidgo 文档 MCP 服务（`https://docs.vidgo.ai/mcp`），并复制一段适用于任意编程助手的接入提示词。

## 1. 可用模型

每个模型分类都有一个概览页，列出全部模型及其 model ID：

> [card] [图像](https://docs.vidgo.ai/zh/api-manual/image-series/overview.md)
>
> 文生图与图像编辑。

> [card] [视频](https://docs.vidgo.ai/zh/api-manual/video-series/overview.md)
>
> 文本、图像与参考素材生成视频。

> [card] [音频](https://docs.vidgo.ai/zh/api-manual/music-series/audio-overview.md)
>
> 文本转语音（TTS）。

> [card] [LLM](https://docs.vidgo.ai/zh/api-manual/chat-series/overview.md)
>
> GPT、Claude、Gemini、Grok 和 Kimi。

> [card] [3D](https://docs.vidgo.ai/zh/api-manual/3d-series/overview.md)
>
> 文本与图像生成 3D 模型。

> [card] [音乐](https://docs.vidgo.ai/zh/api-manual/music-series/overview.md)
>
> Suno 音乐接口与音乐模型。

## 2. 认证

在 [API Key 页面](https://vidgo.ai/apis/dashboard/api-key)创建 API Key。每个请求都必须包含：

```http theme={"dark"}
Authorization: Bearer VIDGO_API_KEY
Content-Type: application/json
```

[Claude Messages](https://docs.vidgo.ai/zh/api-manual/chat-series/claude-messages.md) 也接受 `x-api-key`，[Gemini Native Format](https://docs.vidgo.ai/zh/api-manual/chat-series/gemini-native-format.md) 也接受 `x-goog-api-key`。

> [!WARNING]
>
> **切勿在前端代码中暴露 API Key**（浏览器、移动应用、公开仓库）。请只在服务端保存。

## 3. 提交生成任务

生成任务是异步的。向 `POST /api/generate/submit` 提交任务，并保存返回的 `task_id`。

```bash theme={"dark"}
curl https://api.vidgo.ai/api/generate/submit \
  -H "Authorization: Bearer $VIDGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-image",
    "input": {
      "prompt": "A paper-cut illustration of a city at sunrise",
      "size": "1:1"
    }
  }'
```

> [!NOTE]
>
> 提交成功只表示任务已被接受，并不表示生成已经完成。

## 4. 获取结果

```bash theme={"dark"}
curl "https://api.vidgo.ai/api/generate/status/TASK_ID" \
  -H "Authorization: Bearer $VIDGO_API_KEY"
```

**1. 提交**

发送生成请求，并保存返回的 `task_id`。

**2. 等待结果**

轮询[获取任务状态](https://docs.vidgo.ai/zh/api-manual/task-management/status.md)，或传入 `callback_url`，在任务变为 `finished` 或 `failed` 时接收 [Webhook](https://docs.vidgo.ai/zh/api-manual/task-management/webhooks.md)。

**3. 保存输出**

下载 `files` 中的文件，并保存到你自己的存储中。

Suno 音乐接口使用[查询音乐详情](https://docs.vidgo.ai/zh/api-manual/music-series/query-music-detail.md)和[音乐 Webhook](https://docs.vidgo.ai/zh/api-manual/music-series/music-webhook.md)，而不是统一的任务状态接口。

## 5. 数据保留

> [!WARNING]
>
> 生成的文件有效期为 **24 小时**。请及时下载并保存结果。

## 6. 上线前检查

> [!TIP]
>
> API Key 只保存在服务端，不要暴露在浏览器或移动端代码中。

> [!TIP]
>
> 提交前按所选模型页面校验输入参数。

> [!TIP]
>
> 明确处理 `400`、`401`、`429` 和临时性的 `5xx` 响应，参见[错误码](https://docs.vidgo.ai/zh/api-manual/error-codes.md)。

> [!TIP]
>
> 每次重试提交都可能产生新的计费任务；重新提交前先确认原请求是否已创建任务。

> [!TIP]
>
> 通过[查询用户余额](https://docs.vidgo.ai/zh/api-manual/account-management/user-balance.md)查看剩余积分。

## 7. 支持

> [card] [邮件](mailto:support@vidgo.ai)
>
> `support@vidgo.ai`

> [card] [常见问题](https://docs.vidgo.ai/zh/faqs.md)
>
> 计费、模型与常见问题。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.