開発者向け
画像・動画生成の AI ワークフロー API
HTTP API でワークフローを検索し、入力スキーマの確認、費用の見積もり、非同期実行の送信ができます。実行 ID で結果を取得し、画像や動画のワークフローをアプリケーションに組み込めます。
内容確認日
RelayMe を Claude または ChatGPT に接続
プラットフォームを選び、RelayMe にログインして接続を許可します。接続後はチャットで新しい素材を企画したり、保存済みのワークフローを使ったりできます。
接続したら、アイデアを形にする
新しいチャットで RelayMe を選びます。Claude は「+」→「コネクタ」、ChatGPT は @ を入力して RelayMe を選びます。企画にクレジットはかかりません。クリエイティブスタジオで内容を確認してから生成できます。
保存済みのワークフローを試す
追加の項目が見つからない場合や追加設定が表示された場合
以前ワークフローへのアクセスだけを許可した場合は、RelayMe を追加し直して企画へのアクセスを許可してください。
Claude の無料プランではカスタムコネクタを1つ追加できます。画面が開かない場合は Claude にログインして再度試すか、「カスタマイズ → コネクタ」から同じ URL を入力してください。チームでは管理者による追加が必要な場合があります。クライアントの登録方法を聞かれたら「自動登録」を選びます。 Claude のヘルプ
ChatGPT のウェブ版をご利用ください。「カスタム MCP サーバーを追加」が表示されない場合は、ワークスペースでカスタムプラグインの作成が許可されているか確認してください。 ChatGPT のヘルプ
API 仕様を確認する
以下の仕様確認用エンドポイントは公開されています。ワークフローの実行やコンテンツの生成には、アカウントの権限と Bearer 認証が必要です。
実行の流れ
- 01ワークフローを検索し、入力スキーマを確認する
- 02入力値を渡し、費用の見積もりを確認する
- 03同じ処理で再利用できる冪等キーを使い、実行リクエストを送信する
- 04指定の間隔で状態を確認し、最終ステータスと出力を取得する
1. 利用可能なワークフローを探す
GET /api/ai-tools/v1/workflowsログインして開発者ページで API キーを作成し、サーバー側で管理してください。例にあるキー、ワークフロー ID、入力ノード ID は、ご自身の値に置き換えてください。
export RELAYME_BASE_URL="https://api.relayme.ai"
export RELAYME_API_KEY="<お使いのAPIキー>"
curl "$RELAYME_BASE_URL/api/ai-tools/v1/workflows" \
-H "Authorization: Bearer $RELAYME_API_KEY" const workflowsResponse = await fetch("https://api.relayme.ai/api/ai-tools/v1/workflows", {
headers: { Authorization: `Bearer ${process.env.RELAYME_API_KEY}` },
});
const { data: workflows } = await workflowsResponse.json(); import os, requests
res = requests.get(
"https://api.relayme.ai/api/ai-tools/v1/workflows",
headers={"Authorization": f"Bearer {os.environ['RELAYME_API_KEY']}"},
)
workflows = res.json() 2. 入力と出力のスキーマを確認する
GET /workflows/{id}/schemainputSchema に従って inputs を指定します。最初に unsupportedNodes を確認してください。ブラウザ専用のツールノードはサーバーで実行できないことがあります。outputs の各キーは outputSchema に対応します。
# 123 をアカウントのワークフロー ID に置き換えてください。
export WORKFLOW_ID="123"
curl "$RELAYME_BASE_URL/api/ai-tools/v1/workflows/$WORKFLOW_ID/schema" \
-H "Authorization: Bearer $RELAYME_API_KEY" const workflowId = "123";
const schemaResponse = await fetch(`https://api.relayme.ai/api/ai-tools/v1/workflows/${workflowId}/schema`, {
headers: { Authorization: `Bearer ${process.env.RELAYME_API_KEY}` },
});
const schema = await schemaResponse.json(); workflow_id = "123"
schema = requests.get(
f"https://api.relayme.ai/api/ai-tools/v1/workflows/{workflow_id}/schema",
headers={"Authorization": f"Bearer {os.environ['RELAYME_API_KEY']}"},
).json() 3. 実行費用を見積もる
POST /workflows/{id}/estimateestimatedCost、通貨、ノードごとの見積もり、assumptions を確認します。exact: false は見積もりに不確定な要素があることを示します。設定と想定費用を確認してから実行リクエストを送信してください。
# text-1 をワークフロースキーマの入力ノード ID に置き換えてください。
curl -X POST "$RELAYME_BASE_URL/api/ai-tools/v1/workflows/$WORKFLOW_ID/estimate" \
-H "Authorization: Bearer $RELAYME_API_KEY" \
-H "Content-Type: application/json" \
-d '{"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}}' const estimateResponse = await fetch(`https://api.relayme.ai/api/ai-tools/v1/workflows/${workflowId}/estimate`, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.RELAYME_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}}),
});
const estimate = await estimateResponse.json(); estimate = requests.post(
f"https://api.relayme.ai/api/ai-tools/v1/workflows/{workflow_id}/estimate",
headers={"Authorization": f"Bearer {os.environ['RELAYME_API_KEY']}"},
json={"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}},
).json() 4. 実行リクエストを送信し、runId を保存する
POST /workflows/{id}/runs新規の実行リクエストが受理されると、HTTP 202、Location、Retry-After、data.runId が返ります。同じ冪等キーで再送信した場合は HTTP 200 が返ることがあります。その場合も data.runId を取得してください。冪等キーは1回の業務操作にひも付け、同じ操作のネットワーク再試行では再利用し、新しい操作には新しいキーを使います。
# 実行ごとに一意のキーを作成し、同じ実行の再試行で使い回します。
export RUN_KEY="product:YOUR-PRODUCT-ID:hero-image:v1"
curl -i -X POST "$RELAYME_BASE_URL/api/ai-tools/v1/workflows/$WORKFLOW_ID/runs" \
-H "Authorization: Bearer $RELAYME_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $RUN_KEY" \
-d '{"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}}' const runResponse = await fetch(`https://api.relayme.ai/api/ai-tools/v1/workflows/${workflowId}/runs`, {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.RELAYME_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "product:YOUR-PRODUCT-ID:hero-image:v1",
},
body: JSON.stringify({"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}}),
});
const { data: { runId } } = await runResponse.json(); run_resp = requests.post(
f"https://api.relayme.ai/api/ai-tools/v1/workflows/{workflow_id}/runs",
headers={
"Authorization": f"Bearer {os.environ['RELAYME_API_KEY']}",
"Idempotency-Key": "product:YOUR-PRODUCT-ID:hero-image:v1",
},
json={"inputs":{"text-1":"白い背景に商品を配置した、すっきりした商品写真"}},
).json()
run_id = run_resp["data"]["runId"] 5. 状態を確認し、結果を取得する
GET /workflow-runs/{runId}Retry-After または retryAfterSeconds の指定に従って待機します。QUEUED、RUNNING、CANCEL_REQUESTED は処理中の状態です。COMPLETED では outputs を読み取り、FAILED ではノードのエラーを確認し、CANCELLED ではポーリングを終了します。実行の作成時に署名付き Webhook を設定することもできます。
export RUN_ID="<HTTP 202 応答の runId>"
curl "$RELAYME_BASE_URL/api/ai-tools/v1/workflow-runs/$RUN_ID" \
-H "Authorization: Bearer $RELAYME_API_KEY" const statusResponse = await fetch(`https://api.relayme.ai/api/ai-tools/v1/workflow-runs/${runId}`, {
headers: { Authorization: `Bearer ${process.env.RELAYME_API_KEY}` },
});
const status = await statusResponse.json(); status = requests.get(
f"https://api.relayme.ai/api/ai-tools/v1/workflow-runs/{run_id}",
headers={"Authorization": f"Bearer {os.environ['RELAYME_API_KEY']}"},
).json() HTTP API と Agent Skills で接続する
- ログインし、開発者ページで API キーを作成してください。キーの作成は無料です。生成やワークフローの実行ではクレジットを消費するため、残高が不足しているとリクエストは拒否されます。
- Agent Skills 一式をダウンロードして解凍します。5つのフォルダーに1つずつ Skill があり、それぞれに SKILL.md が入っています。お使いのエージェントの説明に従い、Skill の読み込み先に配置してください。
- エージェントの実行環境に RELAYME_API_KEY を設定します。キーはシークレット管理サービスかサーバー側に保管し、プロンプトには含めないでください。
- まずは画像を1枚、直接生成してみましょう。たとえば、次のように指示します。
relayme-creative と Nano Banana を使って、白い陶器のマグカップの商品画像を1枚生成してください。背景はライトグレー、解像度は 1K、縦横比は 1:1。タスクが完了するまで状態を確認し、画像のリンクを返してください。モデルの単価に応じたクレジットを消費します。
curl -LO https://api.relayme.ai/api/ai-tools/v1/skills.zip
unzip skills.zip -d relayme-skills
ls relayme-skills
# relayme-agent relayme-chat relayme-creative relayme-tasks relayme-workflows
# 各フォルダーに SKILL.md が入っています。
export RELAYME_API_KEY="<お使いのAPIキー>" クレジットを消費する呼び出し
ツール名は function-tools.jsonの定義に従います。
| ツール | 用途 | クレジット消費 |
|---|---|---|
relayme_generate_image | 画像を直接生成 | 消費あり 画像モデルの1枚あたりの料金 |
relayme_generate_video | 動画を直接生成 | 消費あり 動画モデルの1秒あたりの料金 |
relayme_chat | テキストチャット | 消費あり 選択したテキストモデルの料金 |
relayme_run_workflow | 保存済みワークフローの実行 | 消費あり 実行内の各生成ノードの料金 |
relayme_estimate_workflow | ワークフローの費用見積もり | 消費なし |
relayme_list_modelsrelayme_list_workflowsrelayme_get_workflowrelayme_get_workflow_schema | モデルとワークフローの検索、入力スキーマの取得 | 消費なし |
relayme_get_taskrelayme_list_tasksrelayme_get_workflow_runrelayme_list_workflow_runs | タスクと実行状況の確認 | 消費なし |
relayme_validate_workflowrelayme_create_workflowrelayme_update_workflowrelayme_delete_workflow | ワークフローの検証・作成・更新・削除 | 消費なし |
relayme_cancel_workflow_run | 実行のキャンセル | キャンセル自体は無料 提供元に送信済みの処理は完了し、課金される場合があります。 |
API の制約
- 画像の切り抜きや動画の先頭・末尾フレーム取得など、ブラウザで動作するツールノードはサーバー上で実行できません。該当ノードは unsupportedNodes に一覧表示されます。それらに依存するワークフローは API で完了できません。
- 上流ノードの生成結果に依存する場合は、仮の値で見積もることがあります(exact: false)。実際の請求額は実行記録で確認できます。
- 新しいアカウントに保存済みのワークフローはありません。ワークスペースで保存するか、API で作成すると一覧に表示されます。
- 画像や動画を直接生成するリクエストの冪等性は保証されません。タイムアウト後は、再送信する前にタスク一覧をご確認ください。
よくある質問
API で何ができますか?
ワークフローの検索、スキーマの取得、費用の見積もり、実行とキャンセル、チャット、画像・動画の直接生成が可能です。最新の仕様は公開 OpenAPI と各 Skill でご確認ください。
再試行すると別のワークフロー実行が作成されますか?
同じワークフロー実行リクエストには元の Idempotency-Key を再利用すると、重複実行を防げます。画像や動画の直接生成では同じ冪等性が保証されないため、タイムアウト後は再送信する前にタスク履歴をご確認ください。
見積もりがそのまま請求額になりますか?
上流ノードの生成結果に依存する場合は仮の値で見積もり、exact: false と assumptions を返すことがあります。最終的な費用は実際のモデル使用量と送信済みのリクエストで決まります。
キャンセル後に料金が発生することはありますか?
キャンセルすると後続ノードの実行は停止します。モデル提供元に送信済みのタスクは完了し、課金される場合があります。inFlightTaskMayComplete と実行の最終ステータスをご確認ください。
連携を始める
まずワークスペースで小さなワークフローを検証し、API でアプリケーションに接続しましょう。