Open API - メディア解析ドキュメント

01 · クイックスタート

解析リクエストを送信

リクエストヘッダーに API キーを追加し、JSON 本文に公開 URL を1件送信します。

curl -X POST https://api.videotool.cc/openapi/parse \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://..."}'

02 · 認証

API キーで認証

各リクエストで X-API-Key を送信します。キーはコンソールで確認・更新できます。

X-API-KeyYOUR_API_KEY

API キーはサーバー側に保存し、アプリや公開リポジトリに含めないでください。

03 · エンドポイント

利用可能なエンドポイント

POST/openapi/parse単一 URL

公開メディア URL を1件解析

公開投稿または動画 URL を送信します。利用可能なリソース取得後に1クレジットを消費します。

url string · required 公開投稿または動画 URL

04 · レスポンス

成功レスポンス

成功時は AjaxResult 内の ParseResult として動画・画像・音声・テキストを返します。

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "resultCode": 0,
    "hasResource": true,
    "resourceType": 200,
    "descList": ["..."],
    "imgList": [],
    "videoList": [],
    "audioList": []
  }
}

05 · エラー

業務エラーコード

code	意味	課金
`400`	URL がないか無効です	課金なし
`401`	API キーがない、無効、または停止中です	課金なし
`403`	クレジット不足です	課金なし
`422`	利用可能なリソースがありません	課金なし
`500`	解析サービスエラー	課金なし

06 · 課金

成功結果のみ課金

1利用可能なリソース返却時の消費クレジット

0失敗・例外・空結果時の消費クレジット

現在の範囲

Open API は1件の URL を処理する POST /openapi/parse のみです。バッチ、機能照会、冪等キャッシュ、レート制限は提供しません。

1つのエンドポイントでメディア解析を導入