# 快速入門

> 幾分鐘內開始使用 WayinVideo API。

## 快速入門

跟著以下步驟，幾分鐘內就能開始使用 WayinVideo API。

## 1. 取得你的 API 金鑰

1. 登入 [WayinVideo API Dashboard](https://wayin.ai/wayinvideo/api-dashboard)
2. 點擊 **Create API Key** 生成新的金鑰
3. 複製並妥善保存你的 API 金鑰

> **重要：** API 金鑰屬於機密資訊，請勿在前端程式碼或公開的程式碼庫中洩露。

## 2. 提交剪輯任務

傳送影片網址以提交一個 AI 剪輯任務：

```bash
curl -X POST https://wayinvideo-api.wayin.ai/api/v2/clips \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-wayinvideo-api-version: v2" \
  -d '{
    "video_url": "https://www.youtube.com/watch?v=example",
    "enable_export": false
  }'
```

回應：

```json
{
  "data": {
    "id": "proj_abc123",
    "name": "sample project name",
    "status": "CREATED"
  }
}
```

## 3. 輪詢取得結果

持續輪詢任務狀態，直到出現 `SUCCEEDED`。建議每 **30 秒**輪詢一次。

```bash
curl -X GET https://wayinvideo-api.wayin.ai/api/v2/clips/results/proj_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-wayinvideo-api-version: v2"
```

處理完成後，回應中會包含你的剪輯片段：

```json
{
  "data": {
    "id": "proj_abc123",
    "name": "sample project name",
    "status": "SUCCEEDED",
    "clips": [
      {
        "idx": 0,
        "title": "sample title",
        "begin_ms": "15000",
        "end_ms": "75000",
        "thumbnail": "https://cdn.example.com/thumb/clip_001.jpg",
        "tags": ["insight", "analysis"],
        "desc": "sample description"
      }
    ]
  }
}
```

> **注意：** 提交剪輯任務時，可以設定 `enable_export = true`，讓系統算圖並匯出影片，回應中會包含下載連結。由於算圖與匯出需要額外的處理時間，完成時間會比不開啟匯出時更長。

## 4. 匯出與發布短片

短片生成後，你可以將它們算圖成影片檔，或直接發布到已綁定的社群媒體帳號：

- [短片匯出 API](https://wayin.ai/zh-tw/api-docs/clips-export/) — 使用自訂解析度、字幕、AI 重新構圖、AI Hook 與其他匯出設定來算圖或重新匯出短片。
- [社群媒體發布 API](https://wayin.ai/zh-tw/api-docs/social-media-publishing/) — 綁定社群媒體帳號，並發布 AI 剪輯或時刻搜尋產生的短片。

## 接下來

- [AI 剪輯](https://wayin.ai/zh-tw/api-docs/ai-clipping/) — 從長影片中取得高傳播潛力短片
- [時刻搜尋](https://wayin.ai/zh-tw/api-docs/find-moments/) — 用自然語言查詢影片中的特定時刻
- [影片摘要](https://wayin.ai/zh-tw/api-docs/video-summarization/) — 取得影片的概覽與時間軸重點
- [影片筆記](https://wayin.ai/zh-tw/api-docs/video-notes/) — 生成 Markdown 與純文字格式的結構化 AI 筆記
- [影片轉錄](https://wayin.ai/zh-tw/api-docs/video-transcription/) — 提取字詞級別的逐字稿，並支援說話者分離
- [AI for Stream Videos](https://wayin.ai/solutions/stream) — 探索適用於即時串流影片工作流程的直播理解與剪輯。
