API 參考
建立影片任務
呼叫 NeonAPI 所需的端點、請求參數與回應結構。
POST /v1/videos
身分驗證
將 NeonAPI 金鑰放入 Authorization: Bearer YOUR_API_KEY 請求標頭,在可信應用環境中保管金鑰。
可用性與相容性
呼叫前核對模型的協定、權限、報價與支援參數。不支援的參數可能被拒絕。範例中的金鑰與模型均為佔位符。
請求參數
multipart/form-data
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
model | string | 否 | — | 模型廣場發布的準確 ID。 |
prompt | string | 否 | — | 指令或生成提示詞。 |
seconds | string | 否 | — | — |
input_reference | string | 否 | binary | — |
完整欄位定義、巢狀物件和引用結構可在下載的規格中查看。
請求範例
export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/videos \
-H "Authorization: Bearer $NEON_API_KEY" \
-F "model=YOUR_MODEL_ID" \
-F "prompt=A slow journey through a constellation"回應說明
實際欄位因模型與協定而異。下方結構描述文件中的成功回應;串流請求使用對應協定的事件。
| 狀態碼 | 意義 |
|---|---|
| 200 | 請求成功 |
| 400 | 請求參數錯誤 |
回應結構
| 欄位 | 類型 | 必填 | 限制 | 意義 |
|---|---|---|---|---|
id | string | 是 | — | 該結果或任務的識別碼。 |
object | string | 是 | — | — |
model | string | 是 | — | 模型廣場發布的準確 ID。 |
status | string | 是 | — | 目前非同步任務狀態。 |
progress | integer | 是 | — | — |
created_at | integer | 是 | — | — |
seconds | string | 是 | — | — |
completed_at | integer | 否 | — | — |
expires_at | integer | 否 | — | — |
size | string | 否 | — | — |
error | OpenAIVideoError | 否 | — | — |
metadata | object | 否 | — | — |
另見常見錯誤與串流回應和非同步任務。