replicate

ドキュメント

• リファレンスドキュメント：https://replicate.com/docs/llms.txt
• HTTP API スキーマ：https://api.replicate.com/openapi.json
• MCP サーバー：https://mcp.replicate.com
• ドキュメントページをリクエストする際に、Accept: text/markdown ヘッダーを設定すると、Markdown 形式のレスポンスを取得できます。

ワークフロー

Replicate の API を使ってモデルを実行する一般的なワークフローは次のとおりです。

1. 適切なモデルを選ぶ - API で検索するか、ユーザーに尋ねます
2. モデルのメタデータを取得する - API 経由でモデルの入力スキーマと出力スキーマを取得します
3. 予測を作成する - /v1/predictions に POST します
4. 結果をポーリングする - ステータスが "succeeded" になるまで予測を GET します
5. 出力を返す - 通常は生成されたコンテンツの URL です

モデルの選択

• 検索 API とコレクション API を使って、最適なモデルを探して比較してください。API でモデルをすべて一覧表示しないでください。膨大な結果が返されます。
• コレクションは Replicate のスタッフが厳選しているため、審査済みです。
• 公式モデルは "official" コレクションにあります。
• 公式モデルを使う理由は次のとおりです。
  • 常に実行されています
  • API インターフェースが安定しています
  • 出力の料金が予測しやすいです
  • Replicate のスタッフによって保守されています
• コミュニティモデルを使う必要がある場合は、起動に時間がかかることがある点に注意してください。
• コミュニティモデルを常時稼働するデプロイメントとして作成できますが、モデルの稼働時間に対して料金が発生します。

モデルの実行

モデルの実行には時間がかかります。API 経由でモデルを実行し、出力を取得する方法は 3 つあります。

1. 予測を作成し、レスポンスからその ID を保存して、完了するまでポーリングします。
2. 予測の作成時に Prefer: wait ヘッダーを設定すると、ブロッキング同期レスポンスを取得できます。非常に高速なモデルにのみ推奨します。
3. 予測の作成時に HTTPS の Webhook URL を設定すると、予測の完了時に Replicate がその URL に POST します。

モデルを実行する際は、次のガイドラインに従ってください。

• 公式モデルとコミュニティモデルの両方に対応しているため、"POST /v1/predictions" エンドポイントを使ってください。
• モデルごとに独自の OpenAPI スキーマがあります。有効な入力を設定できていることを確認するため、必ずモデルのスキーマを取得して確認してください。人気のモデルでもスキーマは変更されます。
• 入力パラメーターがスキーマの制約（最小値、最大値、列挙値）に適合していることを検証してください。制約に違反する値を生成しないでください。
• パラメーターの値がわからない場合は、モデルのデフォルトの例を使うか、省略可能なパラメーターを省略してください。
• 理由がない限り、省略可能な入力は設定しないでください。必須の入力だけを使い、モデルのデフォルトに任せてください。
• 可能な限り、ファイル入力には HTTPS URL を使ってください。Base64 エンコードしたファイルを送信することもできますが、避けてください。
• 複数の予測を同時に開始してください。1 つが完了するまで待ってから、次を開始することは避けてください。
• 出力ファイルの URL は 1 時間で期限切れになります。保存しておく必要がある場合は、Cloudflare R2 などのサービスを使ってバックアップしてください。
• Webhook は、予測の出力を受信して保存するための優れた仕組みです。