Obtenir les entrées d’un workflow
Lisez les entrées qu’un workflow utilise avant de lancer une exécution.
Les entrées d’un workflow sont rédigées dans Studio et changent lorsque leurs auteurs les modifient. Lisez le contrat plutôt que de le coder en dur.
GET {base_url}/workflows/{workflow_id}/inputsNécessite workflows:read.
Réponse
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "Visuels de l'histoire",
"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": "Document de l'histoire",
"description": "L'histoire terminée à adapter"
},
{
"key": "tone",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["thriller", "romance", "mythology"],
"allow_custom": false,
"default_value": "thriller",
"title": "Tonalité"
}
]
}L'objet workflow
| Champ | Signification |
|---|---|
version_id | la version qu'une exécution exécuterait maintenant. Renvoyez-la dans l'exécution pour verrouiller ce contrat exact |
schema_hash | change lorsque n'importe quelle entrée change. Le seul champ à comparer à votre cache |
credits_estimate | crédits qu'une exécution de ce workflow a coûté en moyenne |
duration_seconds_estimate | combien de temps cela a pris en moyenne, de bout en bout |
Chaque entrée
| Champ | Signification |
|---|---|
clé | le nom à utiliser dans l' inputs objet |
accepte | valeur envoyez la valeur elle-même · url envoyez un lien HTTPS public · option envoyez l'un des options[].id |
type | chaîne, nombre, booléen, image, vidéo, audio ou document |
obligatoire | doit être présent, sauf si default_value est défini |
allow_multiple | lorsque c'est vrai, la valeur peut être un tableau ; lorsque c'est faux, un tableau est refusé |
allowed_values | pour accepts: value: les seules chaînes acceptées, sauf si allow_custom est vrai |
allow_custom | lorsque c'est faux, les valeurs en dehors de allowed_values ou options sont refusées |
minimum, maximum | bornes inclusives, pour type: number |
default_value | ce que l'exécution utilise lorsque l'entrée est omise |
url_content_types | pour accepts: url: les types de contenu que le lien peut servir |
max_bytes | pour accepts: url: la plus grande taille de fichier acceptée pour cette entrée |
options | pour accepts: option: { "id", "label" } entrées. Envoyez le id retour exactement comme fourni ; ce n'est pas une URL |
titre, description | rédigé pour des humains, sûr à afficher dans votre propre interface |
Mettez en cache le contrat par rapport à schema_hash, et relisez-le lorsqu'une exécution est refusée avec invalid_request. Les auteurs d'un workflow peuvent ajouter une entrée obligatoire entre deux de vos exécutions.