APIドキュメント

AufhebenAI API の導入を数ステップで開始できます。

このページでは各エンドポイントのリクエストとレスポンス仕様をまとめています。クライアントやバックエンド実装時の参照としてご利用ください。

エンドポイント一覧

詳細なリクエスト・レスポンス形式

GET/health

必須ヘッダー: なし

入力形式: リクエストボディなし

出力形式: JSON オブジェクト例: { "ok": true }

POST/v1/image/process

必須ヘッダー: Content-Type: application/json, X-API-Key: YOUR_API_KEY

入力形式: JSON オブジェクト。`image_base64` と `mime_type` を含みます。

{
  "image_base64": "BASE64_ENCODED_IMAGE",
  "mime_type": "image/jpeg"
}

出力形式: 処理済み画像の Base64 を含む JSON オブジェクト。例:

{
  "image_base64": "BASE64_ENCODED_PROCESSED_IMAGE"
}

POST/v1/video/jobs

必須ヘッダー: X-API-Key: YOUR_API_KEY

入力形式: multipart/form-data。file という名前のファイルフィールドに、生の動画バイト列を送信します。

フォームフィールド名: file
フォームフィールド値: バイナリ動画データ

出力形式: 作成されたジョブを表す JSON オブジェクト。ジョブ ID と現在のステータスを含みます。

{
  "job_id": "VIDEO_JOB_ID",
  "status": "processing"
}

GET/v1/video/jobs

必須ヘッダー: X-API-Key: YOUR_API_KEY

入力形式: リクエストボディなし

出力形式: 認証済みユーザーの動画ジョブを含む JSON 配列または JSON オブジェクト。各要素にはステータス、結果 URL、有効期限、エラー情報などが含まれます。

[
  {
    "job_id": "VIDEO_JOB_ID",
    "status": "finished",
    "upload_url": "https://...",
    "upload_url_expires_at": "2026-04-14T12:34:56Z",
    "error_message": null
  }
]