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

# Test a workflow

> A test run: review steps ask people as usual, but action steps only log what they would send. Test runs do not trigger webhook subscriptions. Needs `workflow:run`.



## OpenAPI

````yaml POST /api/workflows/{id}/test
openapi: 3.1.0
info:
  title: HITL API
  version: 1.0.0
  description: >-
    Run the workflows you build in HITL, follow each run until a person has
    answered, and manage who reviews them.
servers:
  - url: https://api.hitl.sh/v1
security:
  - bearerAuth: []
tags:
  - name: Workflows
  - name: Runs
  - name: Reviewers
  - name: Webhooks
  - name: Account
  - name: Uploads
paths:
  /api/workflows/{id}/test:
    post:
      tags:
        - Workflows
      summary: Test a workflow
      description: >-
        A test run: review steps ask people as usual, but action steps only log
        what they would send. Test runs do not trigger webhook subscriptions.
        Needs `workflow:run`.
      operationId: workflows-test
      parameters:
        - name: id
          in: path
          required: true
          description: The workflow id
          schema:
            type: string
            example: 6af2ce4e8207961501f59472
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: object
                  additionalProperties: true
            example:
              input:
                amount: 49
                customer:
                  name: Ada Lovelace
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
              example:
                error: false
                msg: Test run started
                data:
                  execution_id: 6af2db0ec6a9f1dc71efd5f1
                  workflow_id: 6af2ce4e8207961501f59472
        '401':
          $ref: '#/components/responses/E401'
        '404':
          $ref: '#/components/responses/E404'
components:
  responses:
    E401:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: true
            msg: Invalid API key
    E404:
      description: Not found, or not yours
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: true
            msg: Workflow not found
  schemas:
    Error:
      type: object
      required:
        - error
        - msg
      properties:
        error:
          type: boolean
          example: true
        msg:
          type: string
          description: What went wrong, in plain words
        code:
          type: string
          description: >-
            A machine-readable reason, when there is one (for example
            `confirmation_required`)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `hitl_live_…`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.