Obter as entradas de um workflow
Leia as entradas que um fluxo de trabalho usa antes de iniciar uma execução.
As entradas de um workflow são definidas no Studio e mudam quando seus autores as alteram. Leia o contrato em vez de codificá-lo diretamente.
GET {base_url}/workflows/{workflow_id}/inputsRequer workflows:read.
Resposta
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "Visuais da história",
"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": "Documento da história",
"description": "A história finalizada a ser adaptada"
},
{
"key": "tom",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["thriller", "romance", "mitologia"],
"allow_custom": false,
"default_value": "thriller",
"title": "Tom"
}
]
}O objeto workflow
| Campo | Significado |
|---|---|
version_id | a versão que uma execução executaria agora. Envie-a de volta na execução para fixar este contrato exato |
schema_hash | muda quando qualquer entrada muda. O único campo para comparar com seu cache |
credits_estimate | créditos que uma execução deste workflow tem custado em média |
duration_seconds_estimate | quanto tempo tem levado em média, do início ao fim |
Cada entrada
| Campo | Significado |
|---|---|
chave | o nome a usar no inputs objeto |
aceita | valor envie o próprio valor · url envie um link HTTPS público · opção envie um de options[].id |
tipo | string, número, booleano, imagem, vídeo, áudio ou documento |
obrigatório | deve estar presente, a menos que valor_padrão esteja definido |
allow_multiple | quando verdadeiro, o valor pode ser um array; quando falso, um array é recusado |
valores_permitidos | para aceita: valor: as únicas strings aceitas, a menos que permitir_personalizado seja verdadeiro |
permitir_personalizado | quando falso, valores fora de valores_permitidos ou opções são recusados |
mínimo, máximo | limites inclusivos, para tipo: número |
valor_padrão | o que a execução usa quando a entrada é omitida |
url_content_types | para aceita: url: os tipos de conteúdo que o link pode servir |
max_bytes | para aceita: url: o maior arquivo aceito para esta entrada |
opções | para aceita: opção: { "id", "label" } entradas. Envie o id de volta exatamente como fornecido; não é uma URL |
título, descrição | escrito para pessoas, seguro para mostrar na sua própria interface |
Armazene em cache o contrato em relação a schema_hash, e leia-o novamente quando uma execução for recusada com invalid_request. Os autores de um workflow podem adicionar uma entrada obrigatória entre duas de suas execuções.