Dapatkan input suatu alur kerja
Baca input yang digunakan sebuah alur kerja sebelum Anda memulai run.
Input sebuah alur kerja ditulis di Studio dan berubah saat penulisnya mengubahnya. Baca kontraknya, alih-alih menuliskannya secara permanen di kode.
GET {base_url}/workflows/{workflow_id}/inputsMemerlukan workflows:read.
Respons
{
"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"
}
]
}Objek alur kerja
| Bidang | Arti |
|---|---|
version_id | versi yang akan dijalankan sekarang. Kembalikan ke run untuk mengunci kontrak persis ini |
schema_hash | berubah ketika input apa pun berubah. Satu bidang untuk dibandingkan dengan cache Anda |
credits_estimate | kredit yang rata-rata telah dihabiskan oleh sebuah run dari alur kerja ini |
duration_seconds_estimate | berapa lama waktu yang rata-rata dibutuhkan, dari awal hingga akhir |
Setiap input
| Bidang | Arti |
|---|---|
key | nama yang digunakan di objek inputs milik run |
accepts | value kirim nilainya sendiri · url kirim link HTTPS publik · option kirim salah satu dari options[].id |
type | string, number, boolean, image, video, audio atau document |
required | harus ada, kecuali default_value diatur |
allow_multiple | ketika true, nilainya dapat berupa array; ketika false, array ditolak |
allowed_values | untuk accepts: value: satu-satunya string yang diterima, kecuali allow_custom bernilai true |
allow_custom | ketika false, nilai di luar allowed_values atau options ditolak |
minimum, maximum | batas inklusif, untuk type: number |
default_value | apa yang digunakan run saat input dihilangkan |
url_content_types | untuk accepts: url: jenis konten yang dapat dilayani link |
max_bytes | untuk accepts: url: ukuran file terbesar yang diterima untuk input ini |
options | untuk accepts: option: entri { "id", "label" }. Kirim id kembali persis seperti diberikan; itu bukan URL |
title, description | ditulis untuk manusia, aman untuk ditampilkan di UI Anda sendiri |
Simpan kontrak dalam cache terhadap schema_hash, dan baca ulang saat sebuah run ditolak dengan invalid_request. Penulis alur kerja dapat menambahkan input wajib di antara dua run Anda.