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

# Cancel Workflow

> Stop a running workflow. The response reports the run's status once the cancellation was applied, so no follow-up poll is needed. Cancelling a run twice is harmless. A cancelled run keeps whatever it produced and can be continued later by submitting its `execution_id`.



## OpenAPI

````yaml /api-rest/openapi/openapi_workflows.json post /v1/workflow/execute/async/{execution_id}/cancel
openapi: 3.1.0
info:
  description: HTTP API for Bigdata Research Agent and Deep-Research capabilities
  title: Bigdata Research Agent API
  version: 1.0.0
servers:
  - description: Production server
    url: https://agents.bigdata.com
security: []
paths:
  /v1/workflow/execute/async/{execution_id}/cancel:
    post:
      tags:
        - Workflows
      summary: Cancel Workflow
      description: >-
        Stop a running workflow. The response reports the run's status once the
        cancellation was applied, so no follow-up poll is needed. Cancelling a
        run twice is harmless. A cancelled run keeps whatever it produced and
        can be continued later by submitting its `execution_id`.
      operationId: >-
        cancel_workflow_async_v1_workflow_execute_async__execution_id__cancel_post
      parameters:
        - in: path
          name: execution_id
          required: true
          schema:
            title: Execution Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncWorkflowCancelResponse'
          description: Successful Response
        '404':
          description: No such execution, or it is not owned by the caller.
        '409':
          description: >-
            The run has already finished, so there is nothing to act on. Read
            its result from GET /v1/workflow/executions/{execution_id}.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          description: >-
            The run was accepted but is not ready to act on yet. Transient —
            retry the same request after the number of seconds given in
            Retry-After.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
      security:
        - API Key Authentication: []
components:
  schemas:
    AsyncWorkflowCancelResponse:
      description: The run's status after a cancellation request.
      properties:
        execution_id:
          description: Identifier for the cancelled run.
          title: Execution Id
          type: string
        status:
          $ref: '#/components/schemas/ExecutionStatus'
          description: >-
            The run's status once the cancellation was applied. Usually
            "cancelled", but a run that finished while the request was in flight
            reports "completed" or "error" instead.
      required:
        - execution_id
        - status
      title: AsyncWorkflowCancelResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ExecutionStatus:
      description: Lifecycle status of a stored workflow execution.
      enum:
        - pending
        - running
        - completed
        - error
        - cancelled
      title: ExecutionStatus
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    API Key Authentication:
      description: API key for authentication.
      in: header
      name: X-API-Key
      type: apiKey

````