Logo

APIの基本

Fit-it-on開発者APIの核となる概念。

APIの基本

Fit-it-on開発者APIは、当社のAI生成モデルへのプログラムによるアクセスを提供します。標準的なRESTアーキテクチャスタイルに従い、予測可能なリソース指向のURLを使用し、JSONエンコードされたリクエストボディを受け入れます。


非同期実行

すべての画像生成は非同期で処理されます。高解像度のAIレンダリング(2kまたは2048x2048サンプル)には時間がかかり、同期接続では必然的にタイムアウトしてしまいます。

  1. ジョブの送信: 入力データを含むPOST /v1/runリクエストを送信します。
  2. IDの受信: APIはすぐにprediction_idとともに200 OKを返します。
  3. ステータスのポーリング: 定期的にGET /v1/status/{predictionId}を呼び出します。
  4. 完了: ステータスがsucceededに移行すると、生成された画像へのURLがoutput配列で利用可能になります。

Webhookのサポート あるいは、最初のPOSTリクエストでwebhook_urlパラメーターを提供することもできます。ジョブの処理が完了すると(成功または失敗にかかわらず)、最終的なステータスペイロードを含むPOSTリクエストを直接お客様のWebhookに送信するため、手動でポーリングする必要がなくなります。


ベースURL

すべてのリクエストは、HTTPS経由で当社の本番環境に対して行われる必要があります。

https://fititon.app/api

コンテンツタイプ

すべてのPOSTおよびPATCHリクエストには、ペイロード形式を指定するために以下のヘッダーを含める必要があります。

Content-Type: application/json

APIはまた、すべてのレスポンスを厳密にJSON形式で返します。


Webhook

JSONペイロードのルートにwebhook_urlを提供すると、非同期ジョブが完了次第(成功またはエラーのいずれか)、そのURLにHTTP POSTリクエストを送信します。

Webhookペイロードの例:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "output": [
    "https://storage.fititon.com/results/result-123.jpg",
    "https://storage.fititon.com/results/result-124.jpg"
  ],
  "error": null,
  "created_at": "2026-07-03T10:00:00.000Z",
  "updated_at": "2026-07-03T10:00:15.000Z"
}

リクエスト制限と処理

悪用を防ぐため、APIはアクティブな開発者プランのティアに基づいてレート制限を適用します。

制限を超過すると、429 Too Many Requestsエラーを受け取ります。アプリケーションは、指数バックオフを実装することでこれを適切に処理する必要があります。

クレジット残高はレート制限とは独立しています。開発者ダッシュボード、またはアカウントエンドポイントを介してプログラムで、APIの全体的な使用状況と残りのクレジット残高を監視できます。

生成が内部的に失敗した場合(例:無効な画像が渡された、またはモデルがタイムアウトしたなど)、GET /v1/statusエンドポイントはfailedステータスを返し、errorプロパティには詳細なメッセージが含まれます。失敗したジョブに対してクレジットは差し引かれません