Status do workflow

Endpoint: Obter Status do Workflow

Parâmetro	Tipo	Descrição
`workflowId`	string (path)	Identificador único do workflow que você deseja consultar.
`jobId`	string (path)	Identificador único do job que você deseja consultar.

Autenticação

Todos os endpoints do Sinky Studio exigem um header de API Key:

x‑api-key: sua-api-key-aqui

O valor deve ser obtido no painel administrativo da sua conta.

Resposta

A API devolve um objeto JSON contendo dois objetos principais:

Campo	Tipo	Descrição
`workflowresponse`	object	Dados do status atual do workflow.
`metadata`	object	Objeto livre para controle interno do usuário.

Estrutura detalhada

`workflowresponse`

Campo	Tipo	Descrição
`jobId`	string	Identificador do job no sistema.
`status`	string	Estado atual (`queued`, `running`, `completed`, `failed`, etc.).
`message`	string	Mensagem descritiva sobre o estado.
`data`	object	Informações adicionais sobre o job.

`workflowresponse.data`

Campo	Tipo	Descrição
`workflowId`	string	ID interno do workflow.
`timestamp`	string (ISO‑8601)	Quando o job foi criado/registrado.
`queueName`	string	Nome da fila em que o job está.
`estimatedProcessingTime`	string	Tempo estimado de execução (ex.: “5 minutes”).
`priority`	string	Nível de prioridade do job (`low`, `normal`, `high`).
`assignedWorker`	string	Identificador do worker responsável pelo job.

`metadata`

O objeto metadata é totalmente livre para o usuário e conterá os mesmos dados que ele enviou no momento do start do workflow. Esses valores são retornados em todas as requisições relacionadas ao workflow, permitindo ao cliente fazer controle interno, auditoria ou rastreamento de forma personalizada.

Exemplos de metadata

Os campos abaixo são apenas exemplos se você enviasse o source e o requestId no start do workflow.

Campo	Tipo	Descrição
`source`	string	Identifica a origem da requisição (ex.: “external‑application”).
`requestId`	string	ID único que o usuário pode usar para rastrear a chamada.
outras chaves	–	Qualquer outro dado enviado no payload de início será retornado aqui em todas as respostas do workflow.

Exemplos de Status

Status	Mensagem de Exemplo	O que significa?
`queued`	“Workflow adicionado à fila com sucesso”	Job aguardando execução.
`running`	“Workflow está sendo executado”	Job em execução.
`completed`	“Workflow executado com sucesso.”	Job concluído sem erros.
`failed`	“Erro ao processar o workflow: ...”	Erro ocorreu durante a execução.

Observações

Se o workflowId não existir, a API retorna um erro 404 com mensagem clara (não mostrado aqui).
Todos os campos de resposta são opcionais; alguns podem estar ausentes dependendo do estado atual do job.