> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Executar um workflow

> Utilize este endpoint para iniciar uma nova execução de workflow. A solicitação retorna imediatamente com status `pending`. Utilize o header Idempotency-Key para garantir retentativas seguras.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml post /v1/workflows/{workflowId}/executions
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/workflows/{workflowId}/executions:
    post:
      tags:
        - Executions API
      summary: Executar um workflow
      description: >-
        Utilize este endpoint para iniciar uma nova execução de workflow. A
        solicitação retorna imediatamente com status `pending`. Utilize o header
        Idempotency-Key para garantir retentativas seguras.
      operationId: executeWorkflow
      parameters:
        - description: Identificador único do workflow.
          in: path
          name: workflowId
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            Chave de idempotência única para garantir retentativas seguras da
            mesma solicitação.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteWorkflowInput'
        description: Corpo da solicitação contendo os dados de entrada da execução.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionCreateOutput'
          description: >-
            Indica que uma solicitação idêntica já foi processada. Retorna a
            execução original.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionCreateOutput'
          description: >-
            Indica que o recurso foi criado com sucesso e a operação foi
            concluída conforme esperado.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava malformada ou continha parâmetros
            inválidos.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indica que o recurso solicitado não foi encontrado.
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que o payload da solicitação excede o tamanho máximo
            permitido.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava bem formada, mas contém erros
            semânticos que impedem o processamento.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica um erro interno inesperado. Se persistir, entre em contato
            com o suporte.
components:
  schemas:
    ExecuteWorkflowInput:
      properties:
        inputData:
          additionalProperties:
            type: object
          description: >-
            Dados de entrada passados ao workflow. Disponíveis para todos os nós
            durante a execução. O tamanho máximo do payload é 1 MB.
          example:
            transactionId: txn-98765
            amount: 1500
            currency: BRL
            customerId: cust-12345
            message: Payment received
          type: object
      required:
        - inputData
      type: object
    ExecutionCreateOutput:
      properties:
        executionId:
          description: Identificador único da execução.
          example: f7e6d5c4-b3a2-1098-7654-321fedcba098
          format: uuid
          type: string
        startedAt:
          description: Marca temporal de quando a execução foi iniciada.
          example: '2026-03-17T14:35:00Z'
          format: date-time
          type: string
        status:
          description: Status inicial da execução (sempre `pending`).
          example: running
          type: string
        workflowId:
          description: ID do workflow sendo executado.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          format: uuid
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro legível por máquina com o prefixo FLK.
          example: FLK-0001
          type: string
        message:
          description: Explicação do erro legível por humanos.
          example: Invalid input provided
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````