# Preview Agent

> POST /api/v1/workflow/{workflow_id}/agent-preview — request parameters and responses from the Menace Voice API schema.

`POST /api/v1/workflow/{workflow_id}/agent-preview`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| workflow_id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: OnboardingSetup (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| agent_brief | string | yes | minLength: 1; maxLength: 8000 |
| tone | string | yes | minLength: 1; maxLength: 100 |
| language | string | yes | minLength: 1; maxLength: 100 |
| voice_provider | string | yes | minLength: 1; maxLength: 100 |
| voice_name | string | yes | minLength: 1; maxLength: 255 |
| behavior_notes | string or null | no |  |
| workflow_stages | array of string | no | Optional template hints; the planner chooses the stages from the brief. |
| agent_name | string | yes | minLength: 1; maxLength: 255 |
| use_case | string | yes | minLength: 1; maxLength: 2000 |
| call_type | string | yes | enum: ["inbound","outbound"] |

### Response 200

Successful Response

application/json: AgentPreviewResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| workflow_definition | object | yes |  |
| agent_setup | OnboardingSetup (object) | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json post /api/v1/workflow/{workflow_id}/agent-preview
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/workflow/{workflow_id}/agent-preview:
    post:
      tags:
        - main
      summary: Preview Agent
      operationId: preview_agent_api_v1_workflow__workflow_id__agent_preview_post
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: integer
            title: Workflow Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OnboardingSetup"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AgentPreviewResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    AgentPreviewResponse:
      properties:
        workflow_definition:
          additionalProperties: true
          type: object
          title: Workflow Definition
        agent_setup:
          $ref: "#/components/schemas/OnboardingSetup"
      type: object
      required:
        - workflow_definition
        - agent_setup
      title: AgentPreviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OnboardingSetup:
      properties:
        agent_brief:
          type: string
          maxLength: 8000
          minLength: 1
          title: Agent Brief
        tone:
          type: string
          maxLength: 100
          minLength: 1
          title: Tone
        language:
          type: string
          maxLength: 100
          minLength: 1
          title: Language
        voice_provider:
          type: string
          maxLength: 100
          minLength: 1
          title: Voice Provider
        voice_name:
          type: string
          maxLength: 255
          minLength: 1
          title: Voice Name
        behavior_notes:
          anyOf:
            - type: string
              maxLength: 4000
            - type: "null"
          title: Behavior Notes
        workflow_stages:
          items:
            type: string
          type: array
          maxItems: 8
          title: Workflow Stages
          description: Optional template hints; the planner chooses the stages from the
            brief.
        agent_name:
          type: string
          maxLength: 255
          minLength: 1
          title: Agent Name
        use_case:
          type: string
          maxLength: 2000
          minLength: 1
          title: Use Case
        call_type:
          type: string
          enum:
            - inbound
            - outbound
          title: Call Type
      type: object
      required:
        - agent_brief
        - tone
        - language
        - voice_provider
        - voice_name
        - agent_name
        - use_case
        - call_type
      title: OnboardingSetup
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````