リファレンス · 認証
Photta API の認証 1 つのキー、1 つのヘッダー
要約
すべての Photta API 呼び出しで、キーを `Authorization: Bearer photta_live_xxx` として送信してください。キーはダッシュボードで作成され、エンドポイントごとのスコープは持たず、単一のクレジット残高を共有します。
- 認証: Bearerキー
- 制限: 600 リクエスト/分
- 処理方式: 非同期、ポーリング
このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み
API の想定要件
認証の概要
- ヘッダー
- Authorization: Bearer photta_live_xxx
- キーのプレフィックス
- photta_live_
- ベース URL
- https://api.photta.app/api/v1
- キーの作成場所
- https://ai.photta.app
- スコープ
- 1 つのキーですべてのエンドポイントにアクセスし、1 つのクレジット残高を共有
1 回の呼び出しでキーを確認
account エンドポイントは無料であるため、キーが動作することを確認するための安全な手段です。
curl https://api.photta.app/api/v1/account \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/account", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/account",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]キーの取り扱い
疑わしい場合はローテーションする
ドキュメントには明記されています。漏洩が疑われるキーは直ちにローテーションしてください。まず代替キーを生成してデプロイし、その後に古いキーを無効化します。
サーバー側に保持する
ブラウザに渡されたキーは、そのページを開いたすべてのユーザーに渡ることになります。バックエンドから API を呼び出し、結果をクライアントに渡してください。
401 はリクエストではなくキーに原因があることを示す
キーの欠落、無効、または期限切れは `authentication_error` を返します。他の場所を確認する前に、ヘッダーのタイポや不要な空白がないか確認してください。
すべてのキーの背後にある 1 つの残高
キーは機能ごとにスコープ分けされていません。複数の環境向けに複数のキーを用意した場合でも、同じクレジット残高を消費します。残高は GET `/api/v1/account` で確認できます。
認証に関する質問
リクエストの認証方法を教えてください。
すべての呼び出しで、AuthorizationヘッダーにBearerトークンとしてキーを送信します。個別のログインやトークン交換ステップはありません。
キーはどこで作成できますか?
Phottaダッシュボードで作成します。再発行も同じ場所で行われます。これは401エラーが発生した際にドキュメントが案内する場所でもあります。
ブラウザからAPIを呼び出せますか?
ご自身のキーを直接使用して呼び出すことはできません。ブラウザに送信されたものは訪問者に読み取られる可能性があるため、独自のサーバーの背後に呼び出しを配置し、その結果を転送してください。
キーが漏洩した場合はどうすればよいですか?
直ちにローテーションしてください — 新しいキーを生成してデプロイし、その後に古いキーを削除します。すでに消費されたcreditsは回収できないため、まずはローテーションを行い、その後に調査してください。
エンドポイントとリファレンス
機能一覧
バーチャルtry-on API アパレル向け
AIマネキンにアパレルを着せるREST API。非同期処理、生成時間は1.5〜4分、2Kで5クレジット、4Kで6クレジット。cURL、Node.js、Pythonのサンプルコードあり。
読む機能一覧
ジュエリー try-on API ネックレス、リング、ブレスレット、イヤリングに対応
REST 経由でネックレス、指輪、ブレスレット、イヤリングを AI モデルに配置。2K で 5 credits、クローズアップマネキンを内蔵、Photta のドキュメントに基づく反射を考慮したレンダリング。
読む機能一覧
ゴーストマネキン API ゴーストマネキン商品写真向け
AIゴーストマネキンエンドポイント。衣服写真からマネキンを除去し、内部のディテールを保持します。3Dまたは平置き、バッチ処理、2K で 4 credits。
読むリファレンス
5 分以内に最初の Photta 画像を生成。
サインアップ、API キーの生成、最初の cURL 呼び出しの実行、完了までのポーリング、結果の保存。エンドツーエンドで文書化された 5 つのステップ。
読むリファレンス
Photta API の料金体系
Photta APIの各endpointにおける2Kおよび4Kでのcredits消費量、請求と返金の仕組み、無料のendpoint一覧。画像単位の金銭的価格設定はありません。
読むリファレンス
Photta APIのレートリミット
Photta APIのレートリミット、ウィンドウ幅、Retry-Afterヘッダー、ポーリング間隔、プラン別の同時実行上限など、APIドキュメントに記載された仕様です。
読むリファレンス
Photta APIのエラー
ステータスコード別のPhotta APIエラータイプ一覧、エラーボディの構造、およびリトライすべき障害。
読むリファレンス
Photta API リソースエンドポイント
マネキン、ポーズ、背景、フットウェア、ブランドラベルの一覧取得、独自アセットのアップロード、クレジット残高の確認。すべての生成を支えるルックアップAPI群です。
読む
このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み
5分でAPIを試す
Photta APIキーを生成し、上記のcURLスニペットを貼り付ければ、コーヒーが淹れ終わる前に最初のモデル着用画像が手に入ります。
- Bearerキー
- 600 リクエスト/分
- 非同期、ポーリング