Die Eingaben eines Workflows abrufen
Lesen Sie die Eingaben, die ein Workflow benötigt, bevor Sie eine Ausführung starten.
Die Eingaben eines Workflows werden in Studio erstellt und ändern sich, wenn ihre Autoren sie ändern. Lies den Vertrag, statt ihn hart zu codieren.
GET {base_url}/workflows/{workflow_id}/inputsErfordert workflows:read.
Antwort
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "Story-Visualisierungen",
"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-Dokument",
"description": "Die fertige Geschichte, die angepasst werden soll"
},
{
"key": "tone",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["thriller", "romanze", "mythologie"],
"allow_custom": false,
"default_value": "thriller",
"title": "Ton"
}
]
}Das Workflow-Objekt
| Feld | Bedeutung |
|---|---|
version_id | die Version, die ein Lauf jetzt ausführen würde. Gib sie beim Lauf zurück, um genau diesen Vertrag festzuschreiben |
schema_hash | ändert sich, wenn sich irgendeine Eingabe ändert. Das einzige Feld, das du mit deinem Cache vergleichen solltest |
credits_estimate | Credits, die ein Lauf dieses Workflows im Durchschnitt gekostet hat |
duration_seconds_estimate | wie lange es durchschnittlich von Anfang bis Ende dauert |
Jede Eingabe
| Feld | Bedeutung |
|---|---|
Schlüssel | der Name zur Verwendung im Lauf Eingaben Objekt |
akzeptiert | Wert sende den Wert selbst · url sende einen öffentlichen HTTPS-Link · Option sende eines von options[].id |
Typ | Zeichenkette, Zahl, boolesch, Bild, Video, Audio oder Dokument |
erforderlich | muss vorhanden sein, außer wenn default_value gesetzt ist |
allow_multiple | wenn wahr, darf der Wert ein Array sein; wenn falsch, wird ein Array abgelehnt |
allowed_values | für akzeptiert: Wert: die einzigen akzeptierten Zeichenketten, sofern nicht allow_custom wahr ist |
allow_custom | wenn falsch, Werte außerhalb allowed_values oder Optionen werden abgelehnt |
Minimum, Maximum | inklusive Grenzen, für Typ: Zahl |
default_value | was der Lauf verwendet, wenn die Eingabe weggelassen wird |
url_content_types | für akzeptiert: URL: die Inhaltstypen, die der Link bereitstellen darf |
max_bytes | für akzeptiert: URL: die größte Datei, die für diese Eingabe akzeptiert wird |
Optionen | für akzeptiert: Option: { "id", "label" } Einträge. Sende die ID genau so zurück, wie angegeben; es ist keine URL |
Titel, Beschreibung | für Menschen geschrieben, sicher in deiner eigenen UI anzuzeigen |
Speichere den Vertrag im Cache gegen schema_hash, und lies ihn erneut ein, wenn ein Lauf abgelehnt wird mit invalid_request. Die Autoren eines Workflows können zwischen zwei deiner Läufe eine erforderliche Eingabe hinzufügen.