Obtén las entradas de un flujo de trabajo
Lee las entradas que toma un flujo de trabajo antes de iniciar una ejecución.
Las entradas de un flujo de trabajo se crean en Studio y cambian cuando sus autores las cambian. Lee el contrato en lugar de codificarlo de forma rígida.
GET {base_url}/workflows/{workflow_id}/inputsRequiere workflows:read.
Respuesta
{
"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"
}
]
}El objeto del flujo de trabajo
| Campo | Significado |
|---|---|
version_id | la versión que una ejecución ejecutaría ahora. Devuélvela en la ejecución para fijar exactamente este contrato |
schema_hash | cambia cuando cambia cualquiera de las entradas. El único campo que comparar contra tu caché |
credits_estimate | los créditos que una ejecución de este flujo de trabajo ha estado costando en promedio |
duration_seconds_estimate | cuánto tiempo ha estado tardando en promedio, de extremo a extremo |
Cada entrada
| Campo | Significado |
|---|---|
key | el nombre que se debe usar en el objeto inputs de la ejecución |
accepts | value envía el valor mismo · url envía un enlace HTTPS público · option envía uno de options[].id |
type | string, number, boolean, image, video, audio o document |
required | debe estar presente, a menos que default_value esté establecido |
allow_multiple | cuando es true, el valor puede ser un array; cuando es false, se rechaza un array |
allowed_values | para accepts: value: las únicas cadenas aceptadas, a menos que allow_custom sea verdadero |
allow_custom | cuando es false, los valores fuera de allowed_values o options se rechazan |
minimum, maximum | límites inclusivos, para type: number |
default_value | lo que usa la ejecución cuando se omite la entrada |
url_content_types | para accepts: url: los tipos de contenido que el enlace puede servir |
max_bytes | para accepts: url: el archivo más grande aceptado para esta entrada |
options | para accepts: option: { "id", "label" } entradas. Envía el id de vuelta exactamente como se proporciona; no es una URL |
title, description | escrito para personas, seguro para mostrar en tu propia interfaz |
Almacena en caché el contrato con schema_hash, y vuelve a leerlo cuando se rechaza una ejecución con invalid_request. Los autores de un flujo de trabajo pueden añadir una entrada obligatoria entre dos de tus ejecuciones.