---
title: "POST /v1/executions"
method: POST
path: "/v1/executions"
---

# POST /v1/executions

`POST /v1/executions`

Create an execution for a workflow

## Request body

- union
  - object
  - CreateExecutionParams
    - `clientSafeMetadata` object
    - `externalRef` string
    - `idempotencyKey` string
    - `requestPayload` object
    - `sourceEntityId` string
    - `sourceEntityType` string, required
    - `sourceSystem` string, required
    - `workflowId` string, required

## Response `200`

OK

- CreateExecutionSuccessResponse
  - `code` integer
  - `data` CreateExecutionData
    - `clientToken` string
    - `execution` ExternalExecution
      - `checkoutSessionId` string
      - `clientSafeMetadata` object
      - `createdAt` string
      - `externalRef` string
      - `finishedAt` string
      - `id` string
      - `idempotencyKey` string
      - `initiatedById` string
      - `initiatedByType` string
      - `orderId` string
      - `organizationId` string
      - `paymentStatus` string
      - `requestPayload` object
      - `responsePayload` object
      - `runId` string
      - `sourceEntityId` string
      - `sourceEntityType` string
      - `sourceSystem` string
      - `startedAt` string
      - `status` 'awaiting_payment' | 'payment_confirmed' | 'workflow_queued' | 'workflow_running' | 'workflow_waiting' | 'workflow_succeeded' | 'workflow_partial' | 'workflow_failed' | 'workflow_cancelled'
      - `statusReason` string
      - `updatedAt` string
      - `workflowId` string
  - `message` string
  - `requestId` string

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/b3os/apis/b3os-workflow-api.md) · [All operations](https://skmtc.dev/b3os/apis/b3os-workflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/b3os/b3os-workflow-api/revisions/a8c7af3c66a1/schema)