API de workflows

Gerencie os registros de workflows, inspecione execuções e acione sua execução. O exemplo de criação salva um rascunho desativado; configure um system_spec válido antes de ativar o workflow.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

Método	Caminho	Operação
`GET`	`/v1/workflow`	Listar workflows
`POST`	`/v1/workflow`	Criar workflow
`GET`	`/v1/workflow/{id}`	Obter workflow
`PUT`	`/v1/workflow/{id}`	Atualizar workflow
`DELETE`	`/v1/workflow/{id}`	Excluir workflow
`GET`	`/v1/workflow/{id}/runs`	Listar execuções do workflow
`POST`	`/v1/workflow/{id}/runs`	Executar workflow
`GET`	`/v1/workflow/{id}/logs`	Obter logs do workflow

Listar workflows

GET /v1/workflow

Retorna uma lista paginada de Workflow

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
`page`	consulta	não	Número da página
`per_page`	consulta	não	Itens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Lista de Workflow

Campos de resposta

Campo	Tipo	Descrição
`data`	array
`data[].created_at`	inteiro	(Timestamp Unix)
`data[].data`	objeto	Estado do editor de workflows e metadados expostos pela API
`data[].deleted_at`	inteiro	(Timestamp Unix)
`data[].enabled`	booleano
`data[].owner_id`	string
`data[].region`	string
`data[].status`	string	Valores permitidos: draft, active, disabled, archived, deleted.
`data[].system_spec`	objeto	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`data[].team_id`	string
`data[].title`	string
`data[].updated_at`	inteiro	(Timestamp Unix)
`data[].workflow_id`	string
`pagination`	objeto
`pagination.page`	inteiro	Número da página atual
`pagination.per_page`	inteiro	Número de itens por página
`pagination.total`	inteiro	Número total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "data": [
    {
      "created_at": 1791072000,
      "data": {},
      "deleted_at": 0,
      "enabled": true,
      "owner_id": "000000000000000000000000001",
      "region": "",
      "status": "draft",
      "system_spec": {},
      "team_id": "000000000000000000000000001",
      "title": "Postman example",
      "updated_at": 1791072000,
      "workflow_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Criar workflow

POST /v1/workflow

Cria um novo objeto Workflow

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`data`	objeto	não	Estado do editor de workflows e metadados expostos pela API
`enabled`	booleano	sim	Padrão: `true`.
`owner_id`	string	não
`region`	string	não	Padrão: `""`.
`status`	string	sim	Valores permitidos: draft, active, disabled, archived, deleted. Padrão: `"draft"`.
`system_spec`	objeto	não	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`team_id`	string	sim
`title`	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workflow" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "title": "Postman example workflow",
  "status": "draft",
  "enabled": false
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

Workflow criado

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`data`	objeto	Estado do editor de workflows e metadados expostos pela API
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`owner_id`	string
`region`	string
`status`	string	Valores permitidos: draft, active, disabled, archived, deleted.
`system_spec`	objeto	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Obter workflow

GET /v1/workflow/{id}

Retorna um objeto Workflow

Defina workflow_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Workflow

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`data`	objeto	Estado do editor de workflows e metadados expostos pela API
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`owner_id`	string
`region`	string
`status`	string	Valores permitidos: draft, active, disabled, archived, deleted.
`system_spec`	objeto	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Atualizar workflow

PUT /v1/workflow/{id}

Atualiza um objeto Workflow existente

Defina workflow_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`data`	objeto	não	Estado do editor de workflows e metadados expostos pela API
`enabled`	booleano	sim	Padrão: `true`.
`owner_id`	string	não
`region`	string	não	Padrão: `""`.
`status`	string	sim	Valores permitidos: draft, active, disabled, archived, deleted. Padrão: `"draft"`.
`system_spec`	objeto	não	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`team_id`	string	sim
`title`	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "title": "Postman example workflow",
  "status": "draft",
  "enabled": false
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Workflow atualizado

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`data`	objeto	Estado do editor de workflows e metadados expostos pela API
`deleted_at`	inteiro	(Timestamp Unix)
`enabled`	booleano
`owner_id`	string
`region`	string
`status`	string	Valores permitidos: draft, active, disabled, archived, deleted.
`system_spec`	objeto	Especificação canônica de workflow do sistema, sincronizada com o backend do sistema
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)
`workflow_id`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Excluir workflow

DELETE /v1/workflow/{id}

Exclui um objeto Workflow

Defina workflow_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

Campo	Tipo	Descrição
`message`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}

Listar execuções do workflow

GET /v1/workflow/{id}/runs

Liste as execuções pertencentes ao workflow selecionado.

Defina workflow_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/runs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Executar workflow

POST /v1/workflow/{id}/runs

Inicie um workflow configurado. Coloque a entrada do workflow em payload. Essa operação pode executar ações externas definidas pelo workflow e exige uma assinatura paga.

Defina workflow_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/runs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "payload": {}
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter logs do workflow

GET /v1/workflow/{id}/logs

Leia os logs do ciclo de vida do workflow.

Defina workflow_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/logs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.