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

# Execute Workflow

> Execute a published workflow definition, creating a tracked orchestration run.

Executes a published workflow definition by creating a new orchestration run. The workflow's DAG of steps is resolved and executed in dependency order. Each step's inputs and outputs are recorded for full provenance tracking.

Only workflows in `published` status can be executed. Use the [Create Workflow](/api-reference/machine-identity/workflows/create) endpoint to define workflows, then publish them through the workflow lifecycle API before execution.

### Authentication

<ParamField header="X-API-Key" type="string" required>
  API key with `workflows:execute` scope. Alternatively, pass a Bearer JWT token
  in the `Authorization` header.
</ParamField>

<ParamField header="X-Tenant-ID" type="string" required>
  Tenant identifier for multi-tenant isolation.
</ParamField>

### Path Parameters

<ParamField path="id" type="string" required>
  Workflow definition identifier.
</ParamField>

### Request

<ParamField body="agent_id" type="string" required>
  MAIP agent identifier that will execute the workflow.
</ParamField>

<ParamField body="input" type="object">
  Input data passed to the workflow's first steps. Schema depends on the
  workflow definition.
</ParamField>

<ParamField body="parameters" type="object">
  Runtime parameter overrides for the workflow execution. These override default
  step configurations without modifying the workflow definition.
</ParamField>

### Response

<ResponseField name="run_id" type="string">
  Unique run identifier for this execution (`maip-orch:ULID`). Use this to query
  execution status via the [Get
  Orchestration](/api-reference/machine-identity/orchestrations/get) endpoint.
</ResponseField>

<ResponseField name="workflow_id" type="string">
  The executed workflow definition identifier.
</ResponseField>

<ResponseField name="workflow_version" type="string">
  Version of the workflow that was executed.
</ResponseField>

<ResponseField name="agent_id" type="string">
  The agent executing the workflow.
</ResponseField>

<ResponseField name="status" type="string">
  Execution status. Always `running` on creation.
</ResponseField>

<ResponseField name="started_at" type="string">
  ISO 8601 timestamp when execution began.
</ResponseField>


## OpenAPI

````yaml mint-openapi.yaml POST /v1/orchestrate/workflows/{workflowId}/execute
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks is a universal verification infrastructure for documents,
    credentials, and digital assets.

    This specification defines the canonical API for interacting with Truthlocks
    services.


    ## Base URLs

    - **Production**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentication

    - **API Keys**: Use `X-API-Key` header for machine-to-machine operations

    - **Bearer Tokens**: Use `Authorization: Bearer <jwt>` for user-initiated
    operations


    ## Tenant Identity

    In production, tenant identity is derived from the authenticated context
    (API key or JWT).

    The `X-Tenant-ID` header is ignored in production to prevent spoofing.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Production API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox Environment
security:
  - APIKey: []
tags:
  - name: Authentication
    description: API key and token management
  - name: Issuers
    description: Issuer registration and trust management
  - name: Keys
    description: Cryptographic key management for issuers
  - name: Attestations
    description: Attestation lifecycle (mint, revoke, supersede)
  - name: Verification
    description: Attestation verification and proof bundles
  - name: Governance
    description: Issuer governance workflows (admin only)
  - name: Identity
    description: Organization, user, and role management
  - name: Audit
    description: Audit event queries
  - name: Platform
    description: Platform administration (super admin only)
  - name: Platform Review
    description: Staff review workflows for issuer applications
  - name: Tenant Console
    description: Tenant profile and lifecycle endpoints
  - name: Health
    description: Service health and readiness endpoints
  - name: Risk
    description: Risk signal ingestion and fraud detection
  - name: Risk Enforcement
    description: Risk enforcement actions — block, challenge, quarantine, and configuration
  - name: Billing
    description: Billing, subscription, and addon management
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
      trust, witness, compliance, orchestration, and observability
externalDocs:
  description: Transparency read-only API (separate service spec)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/orchestrate/workflows/{workflowId}/execute:
    post:
      tags:
        - Machine Identity
      summary: Execute Workflow
      description: |
        Triggers execution of a workflow. Supports dry-run mode to preview the
        execution plan without performing any actions.
      operationId: maip.workflows.execute
      parameters:
        - name: workflowId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Workflow identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                parameters:
                  type: object
                  additionalProperties: true
                  description: Runtime parameters for this execution
                dry_run:
                  type: boolean
                  default: false
                  description: If true, return the execution plan without running it
      responses:
        '201':
          description: Workflow execution started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipWorkflowExecution'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Workflow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipWorkflowExecution:
      type: object
      properties:
        execution_id:
          type: string
          format: uuid
        workflow_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
        steps:
          type: array
          items:
            type: object
            properties:
              action:
                type: string
              agent_id:
                type: string
                format: uuid
              status:
                type: string
              result:
                type: object
                additionalProperties: true
        created_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Machine-readable error code
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Human-readable error message
        http_status:
          type: integer
          description: HTTP status code
        retry_after_ms:
          type: integer
          description: Milliseconds to wait before retrying (for rate limits)
        details:
          type: object
          description: Additional error context
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for machine-to-machine authentication

````