/docs/[flow])があります。これはそのオートメーションを呼び出すための1ページのリファレンスで、FlowSpecから直接生成されるため、エンドポイントが実際に受け付ける内容とずれることはありません。
ページに含まれる内容
- エンドポイント - このオートメーション用の正確な
POST /v1/run/:flowURL。 - コピーしてすぐ使える
curlコマンド - オートメーションの実際の入力スロット名があらかじめ埋め込まれているため、貼り付けたあとに自分の値とAPIキーだけを差し替えれば使えます。 - リクエストスキーマ - オーサリングエージェントが取得した入力スロットごとに1つのフィールド(例:
orderId: string)。Playgroundで見た型付きフォームと一致します。 - レスポンススキーマ -
extract手順の出力キーごとに1つのフィールド。記録中にエージェントが名付けたとおりです(例:status,eta)。
レスポンスボディの
status フィールドは、呼び出しの結果(succeeded / failed)を表します。製品内の別の場所に表示されるオートメーション自体の状態(公開済み, 失敗中, 実行中)と混同しないでください。後者は1回の呼び出しではなく、オートメーションそのものを説明します。このページが古くならない理由
このページのスキーマは、手作業で保守されるコピーではありません。オートメーションのコンパイル済みFlowSpec、つまり記録中にエージェントが取得した入力スロットと、extract 手順の as キーから直接導出されます。Buildに戻って別の手順で再公開すると、次にオートメーションが公開されたときにDocsページは自動的に更新されます。人が手作業で同期し続ける必要があるものは、ここにはありません。
次のステップ
PlaygroundとAPIキー
オートメーションをライブで試し、ここで使用するキーを管理します。
サイトが変更された場合は再記録する
このエンドポイントへの呼び出しが失敗し始めた場合の対処方法。