ワークフローの入力を取得する
実行を始める前に、ワークフローが受け取る入力を確認します。
ワークフローの入力は Studio で作成され、作成者が変更すると変わります。ハードコーディングせず、契約を読み取ってください。
GET {base_url}/workflows/{workflow_id}/inputs必要 workflows:read.
レスポンス
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "ストーリービジュアル",
"version_id": "0192f3c4-1a02-7bb3-9f40-2c6e8d1a5b77",
"schema_hash": "9fdf032d5b1c4e88",
"credits_estimate": 1840,
"duration_seconds_estimate": 420
},
"inputs": [
{
"key": "story_document",
"accepts": "url",
"type": "document",
"required": true,
"allow_multiple": false,
"url_content_types": ["application/pdf", "text/plain", "text/markdown"],
"max_bytes": 104857600,
"title": "ストーリードキュメント",
"description": "適応する完成したストーリー"
},
{
"key": "tone",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["スリラー", "ロマンス", "神話"],
"allow_custom": false,
"default_value": "スリラー",
"title": "トーン"
}
]
}ワークフローオブジェクト
| フィールド | 意味 |
|---|---|
version_id | run が今実行するバージョン。この正確な契約を固定するため、run に戻して渡してください |
schema_hash | いずれかの入力が変更されると変わります。キャッシュと比較するための唯一のフィールドです |
credits_estimate | このワークフローの run に平均してかかってきたクレジット |
duration_seconds_estimate | 最初から最後まで、平均してどれくらい時間がかかっているか |
各入力
| フィールド | 意味 |
|---|---|
キー | run の 入力 オブジェクト |
受け入れます | 値 値そのものを送信 · URL 公開 HTTPS リンクを送信 · オプション 次のいずれかを送信 options[].id |
型 | 文字列, 数値, ブール値, 画像, 動画, 音声 または ドキュメント |
必須 | でない限り、存在していなければなりません デフォルト値 が設定されている場合 |
allow_multiple | true の場合、値は配列でもかまいません。false の場合、配列は拒否されます |
許可された値 | for accepts: value：許可される文字列はこれだけです。ただし、 allow_custom が true の場合を除く |
allow_custom | false の場合、 許可された値 または オプション 外の値は拒否されます |
最小値, 最大値 | の包含境界、 type: number |
デフォルト値 | 入力が省略されたときに run が使用するもの |
url_content_types | for accepts: url：リンクが提供できるコンテンツタイプ |
max_bytes | for accepts: url：この入力で受け付ける最大ファイルサイズ |
オプション | for accepts: option: { "id", "label" } エントリ。次を送信してください id そのまま返してください。URL ではありません |
タイトル, 説明 | 人向けに書かれており、自分の UI で表示しても安全です |
契約を schema_hashと照合してキャッシュし、run が invalid_requestで拒否されたときに再読み込みしてください。ワークフローの作成者は、あなたの 2 回の run の間に必須入力を追加できます。