---
title: "Enqueue a conversation simulation job"
method: POST
path: "/api/v1/simulate"
tags: ["conversation"]
---

# Enqueue a conversation simulation job

`POST /api/v1/simulate`

## Request body

- SimulateConversationCreateRequestDTO
  - `additional_material` union[], nullable
    - union
      - object
        - `relationTo` 'client-documents', required
        - `value` union, required
          - string
          - object
            - `createdAt` string, required
            - `description` string, nullable
            - `filename` string, nullable
            - `filesize` number, nullable
            - `height` number, nullable
            - `id` string, required
            - `mimeType` string, nullable
            - `saga` object, required
              - …
            - `signedUrl` string, nullable
            - `title` string, required
            - `updatedAt` string, required
            - `url` string, nullable
            - `width` number, nullable
      - object
        - `relationTo` 'external-links', required
        - `value` union, required
          - string
          - object
            - `createdAt` string, required
            - `description` string, nullable
            - `id` string, required
            - `saga` object, required
              - …
            - `title` string, required
            - `updatedAt` string, required
            - `url` string, required
  - `createdAt` string, required
  - `difficulty` 'easy' | 'medium' | 'hard', required
  - `hide_examples` boolean, nullable
  - `hide_scorecard` boolean, nullable
  - `id` string, required
  - `keywords` string[]
  - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required
  - `persona` object, required
    - `ai_instruction` string, required
    - `avatar_file` object, required
      - `age` integer, required
      - `alt` string, nullable
      - `createdAt` string, required
      - `filename` string, required
      - `filesize` number, required
      - `gender` 'male' | 'female', required
      - `height` number, required
      - `id` string, required
      - `mimeType` string, required
      - `reusable` boolean, required
      - `sizes` object
        - `card` object
          - `url` string, nullable
        - `thumbnail` object
          - `url` string, nullable
      - `updatedAt` string, required
      - `url` string, required
      - `width` number, required
    - `createdAt` string, required
    - `description` string, required
    - `gender` 'male' | 'female', required
    - `id` string, required
    - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required
    - `name` string, required
    - `role` string, required
    - `saga` object, required
      - `createdAt` string, required — Creation timestamp
      - `description` string, required — Description of the saga
      - `id` string, required — Unique identifier for the saga
      - `name` string, required — Name of the saga
      - `type` 'under_construction' | 'generic' | 'client_specific' — Type of the saga
      - `updatedAt` string, required — Last update timestamp
    - `tag` string, required
    - `updatedAt` string, required
    - `voice` object, required
      - `id` string, required
      - `voice_id` string, required
    - `workplace_description` string, nullable
    - `workplace_name` string, nullable
  - `saga` object, required
    - `createdAt` string, required — Creation timestamp
    - `description` string, required — Description of the saga
    - `id` string, required — Unique identifier for the saga
    - `name` string, required — Name of the saga
    - `type` 'under_construction' | 'generic' | 'client_specific' — Type of the saga
    - `updatedAt` string, required — Last update timestamp
  - `scenario` object, required
    - `conversation_items` object[], required
      - `conversation_step_instructions` string, nullable
      - `conversation_step_title` string, required
      - `id` string, required
    - `createdAt` string, required
    - `description` string, required
    - `description_for_ai` string, required
    - `duration` number, required
    - `firstMessage` string, nullable
    - `firstMessageMode` 'assistant-speaks-first' | 'assistant-waits-for-user' | 'assistant-speaks-first-with-model-generated-message', required
    - `goal` string, required
    - `id` string, required
    - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required
    - `saga` object, required
      - `createdAt` string, required — Creation timestamp
      - `description` string, required — Description of the saga
      - `id` string, required — Unique identifier for the saga
      - `name` string, required — Name of the saga
      - `type` 'under_construction' | 'generic' | 'client_specific' — Type of the saga
      - `updatedAt` string, required — Last update timestamp
    - `tag` string, required
    - `updatedAt` string, required
  - `scorecard` object, required
    - `createdAt` string, required
    - `id` string, required
    - `items` object[], required
      - `description` string, required
      - `desired_behaviours` object[], nullable
        - `behaviour` string, required
        - `examples` string, nullable
        - `id` string, required
      - `desired_outcome` string, nullable
      - `id` string, required
      - `item_title` string, required
    - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required
    - `saga` object, required
      - `createdAt` string, required — Creation timestamp
      - `description` string, required — Description of the saga
      - `id` string, required — Unique identifier for the saga
      - `name` string, required — Name of the saga
      - `type` 'under_construction' | 'generic' | 'client_specific' — Type of the saga
      - `updatedAt` string, required — Last update timestamp
    - `tag` string, required
    - `title` string, required
    - `updatedAt` string, required
  - `title` string, required
  - `toolIds` string[], nullable
  - `trackId` string
  - `trackTitle` string
  - `updatedAt` string, required

## Response `201`

- SimulateConversationCreateResponseDTO
  - `message` string, required — Confirmation message indicating the simulation has been accepted and started

---

[API](https://skmtc.net/wejam/apis/jam.md) · [All operations](https://skmtc.net/wejam/apis/jam/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wejam/jam/revisions/bd5a5f406bca/schema)