本文へ移動
使い方

ドキュメントを検索

検索はブラウザー内で行われ、入力した語句は送信・保存されません。認証情報は入力しないでください。

検索データを読み込み中…

Tab または矢印キーで移動 · Enter で開く · Esc で閉じる
ドキュメントを探す

APIクイックスタート:画像からファイル保存まで

モデル取得、画像準備、見積もり、承認済みの作成、状態確認、実ファイル保存を安全に進めます。

公開ベータAPI v1 · 1.4.0最終確認
このページの目次

前提条件

公開APIは公開ベータです。認証済みのAnimGenアカウント、animations:readとanimations:writeを持つAPIキー、信頼できるサーバーまたはローカル環境が必要です。生成には十分なクレジットが必要です。購読は開発者向け上限を上げますが、アクセス自体の条件ではありません。

アカウント → 開発者で作ったキーを秘密管理または非公開シェルからANIMGEN_API_KEYに設定します。ブラウザーJS、配布ゲーム、リポジトリ、AIの会話に入れないでください。ベースURLはhttps://api.animgen.com/v1、URL互換バージョンはv1、文書化されたスキーマのバージョンは1.4.0です。

1. 対応モデルを取得する

bash
curl --fail-with-body https://api.animgen.com/v1/models \
  -H "Authorization: Bearer $ANIMGEN_API_KEY"

dataから入力モードに対応するidを選び、長さ、解像度、縦横比、能力フラグを調べます。古い記事のモデル名をコピーしないでください。下記の開始フレーム例にはsupports_first_frame: trueとmodes内の対応が必要で、公開済みの既定オプションを使います。

2. 有料生成なしで準備・見積もりする

Pythonワークフロー例を取得して確認します。Python 3.10以降と標準ライブラリだけを使います。

bash
curl --fail-with-body -o animation-workflow.py \
  https://animgen.com/examples/animation-workflow.py

python3 animation-workflow.py prepare \
  --image character.png \
  --model 'PROVIDER:MODEL_FROM_CATALOG' \
  --prompt 'A character runs in place, side view, fixed camera.' \
  --state hero-run.json

パスとモデルIDを置き換えます。準備処理はモデル一覧を確認し、インラインBase64のリクエスト、見積もり、残高を取得して非公開の状態ファイルを保存します。有料作成は呼びません。 ファイルには画像とプロンプトが含まれます。アクセスを制限し、バージョン管理外に置き、不要になれば削除します。APIキーそのものは含みません。

3. 明示的に作成を承認する

見積もり額を確認し、許容する額をAPPROVED_CREDITSに設定します。

bash
python3 animation-workflow.py run \
  --state hero-run.json \
  --approve-credits "$APPROVED_CREDITS" \
  --output ./hero-output

この例は初回作成前に再見積もりし、ローカル承認額を超えれば拒否します。冪等性キーを保存し、同じリクエストを論理的に一度送信して、状態確認と成果物保存を行います。

4. 安全に再開し、結果を確認する

タイムアウトしたら同じ状態ファイルで再実行します。タスクID保存済みなら新規作成せず状態確認を再開します。作成応答が不明な場合も、保守的な再試行期間内で元のキーと内容を使います。状態ファイルを消して最初から「再試行」すると二重課金になり得ます。例は未解決の作成を24時間後に自動再試行しません。タスク一覧かサポートで確認します。

終状態が失敗や中止でも利用可能な成果物を先に保存し、不完全なら終了コードを非ゼロにします。部分的な書き出しを完全成功とはみなさず、保存名にはリモートの名前でなく素材IDを使います。

このリクエストの内容

例は通常の全長アニメーション、PNGフレームZIP、24フレーム、512×512を要求します。APIの既定値でも万能の推奨設定でもありません。再利用アップロードや公開URLは認証と画像入力、ライフサイクルは状態確認とダウンロード、失敗時はエラーと再試行を参照してください。正確な契約はOpenAPI JSONにあります。

Python例はローカルのモックで検証され、実際の有料生成は行っていません。自身の連携は小さな承認済みタスクで確認してください。他言語と検証範囲は実行可能な例、パラメータはAPI参考にあります。

この記事は役に立ちましたか?

検索語句、コード、自由記述は収集しません。この設定はドキュメントの操作イベントのみを制御します。 プライバシーポリシー

お困りですか?サポートへ