ワークフローの入力を取得する
実行を始める前に、ワークフローが受け取る入力を確認します。
ワークフローの入力は Studio で作成され、作成者が変更すると変わります。ハードコーディングせず、契約を読み取ってください。
GET {base_url}/workflows/{workflow_id}/inputsworkflows:read が必要です。
レスポンス
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "Story visuals",
"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": "Story document",
"description": "The finished story to adapt"
},
{
"key": "tone",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["thriller", "romance", "mythology"],
"allow_custom": false,
"default_value": "thriller",
"title": "Tone"
}
]
}ワークフローオブジェクト
| フィールド | 意味 |
|---|---|
version_id | run が今実行するバージョン。この正確な契約を固定するため、run に戻して渡してください |
schema_hash | いずれかの入力が変更されると変わります。キャッシュと比較するための唯一のフィールドです |
credits_estimate | このワークフローの run に平均してかかってきたクレジット |
duration_seconds_estimate | 最初から最後まで、平均してどれくらい時間がかかっているか |
各入力
| フィールド | 意味 |
|---|---|
key | run の inputs オブジェクトで使う名前 |
accepts | value 値そのものを送信 · url 公開 HTTPS リンクを送信 · option options[].id のいずれかを送信 |
type | string, number, boolean, image, video, audio または document |
required | default_value が設定されていない限り、指定が必要です |
allow_multiple | true の場合、値は配列でもかまいません。false の場合、配列は拒否されます |
allowed_values | accepts: value の場合：allow_custom が true でない限り、受け付ける文字列はこれだけです |
allow_custom | false の場合、allowed_values または options 以外の値は拒否されます |
minimum, maximum | type: number の場合の範囲（両端を含む） |
default_value | 入力が省略されたときに run が使用するもの |
url_content_types | accepts: url の場合：リンクが返してよいコンテンツタイプ |
max_bytes | accepts: url の場合：この入力で受け付ける最大ファイルサイズ |
options | accepts: option の場合：{ "id", "label" } のエントリ。id は指定どおりそのまま返してください。URL ではありません |
title, description | 人向けに書かれており、自分の UI で表示しても安全です |
契約を schema_hash と照合してキャッシュし、run が invalid_request で拒否されたときに再読み込みしてください。ワークフローの作成者は、あなたの 2 回の run の間に必須入力を追加できます。