開発者向けドキュメント
ネオファッション.ai API
商品写真、動画、キャンペーン画像をプログラムで生成します。プラットフォームが使用しているのと同じAPIを、初日から統合に利用できます。
ベース URL
すべてのendpointは /api/v1 配下でバージョン管理され、HTTPSで提供されます。Webアプリも同じendpointを使用します。UI専用のprivate routeはありません。
https://app.neofashion.ai/api/v1 認証
すべてのリクエストはBearer tokenで認証されます。2種類のtokenに対応しており、いずれも同じworkspace contextに解決されます。
API キー
サーバー間連携向けです。workspace settingsでキーを作成します。各キーはお客様のworkspaceに限定されます。Enterpriseプランで利用できます。
Authorization: Bearer ne_live_xxxxxxxxxxxx セッション JWT
Webアプリへのログイン時に発行されます。プラットフォームUIで使用され、短期間かつユーザー単位の呼び出しに適しています。
Authorization: Bearer eyJhbGci... すべてのリクエストには、監査・請求目的で source field(ui または api)および任意の api_key_id が含まれます。
エンドポイント
主要な生成・読み取りendpointです。動画や一括生成などの長時間タスクは非同期で実行されます。生成をpollするか、アプリでstatus updatesをご確認ください。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| POST | /api/v1/generate/image | 単一の製品写真を生成する |
| POST | /api/v1/generate/video | 短いファッションビデオを生成する |
| POST | /api/v1/generate/bulk | 非同期バッチ生成ジョブ |
| POST | /api/v1/sketch-to-photo | スケッチ → キャンペーン品質の写真 |
| GET | /api/v1/generations | リスト世代 (ページ分割) |
| GET | /api/v1/generations/:id | 生成詳細+ステータス |
| GET | /api/v1/credits/balance | 現在のクレジット残高 |
| GET | /api/v1/personas | ワークスペースのペルソナ |
| GET | /api/v1/models | ブランドDNA / ペルソナ API |
レスポンス形式
すべてのendpointは同じenvelopeを返します。data、meta(使用済みcredits、残りcredits、request id)、errorです。dataまたはerrorのいずれか一方のみが設定されます。
成功
{
"data": {
"id": "gen_01hwz...",
"status": "completed",
"output_url": "https://...",
"credits_used": 50
},
"meta": {
"credits_used": 50,
"credits_remaining": 7950,
"request_id": "req_01hwz..."
},
"error": null
} エラー
{
"data": null,
"meta": { "request_id": "req_01hwz..." },
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Credit balance too low for this operation.",
"details": { "required": 50, "available": 20 }
}
} レート制限
制限はworkspace単位で適用されます。上限を超えると、APIは 429 RATE_LIMITED と retry-after headerを返します。
| プラン | レート制限 |
|---|---|
| Enterprise | カスタム — 契約ごとに合意され、SLA が適用されます |
エラーコード
エラーは error fieldで返され、安定した code、人が読めるmessage、structured detailsを含みます。
| コード | HTTP | 意味 |
|---|---|---|
INSUFFICIENT_CREDITS | 402 | リクエストされた操作に対してworkspaceの残高が不足しています。チャージまたはアップグレードして続行してください。 |
UNAUTHORIZED | 401 | Tokenがない、期限切れ、または無効です。 |
FORBIDDEN | 403 | Tokenは有効ですが、プランまたはroleがこの操作を許可していません。 |
NOT_FOUND | 404 | リソースが存在しないか、別のworkspaceに属しています。 |
RATE_LIMITED | 429 | リクエストが多すぎます。指定の間隔後に再試行してください。 |
PROVIDER_ERROR | 502 | 上流のAI providerで失敗しました。クレジットは返金され、リクエストを再試行できます。 |