---
title: "Create a simulation scenario"
method: POST
path: "/v1/{organization}/simulation/scenario/"
tags: ["Simulation"]
---

# Create a simulation scenario

`POST /v1/{organization}/simulation/scenario/`

Create a simulation scenario.

#### Permissions
This endpoint requires the following permissions:
* `Simulation:CreateSimulationScenario` for the simulation scenario.
* `Simulation:ModifySimulationScenario` for the simulation scenario.

## Path parameters

- `organization` string, required

## Headers

- `x-mongo-cluster-name` string, nullable — The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
- `Sec-WebSocket-Protocol` string[]

## Request body

- SrcAppEndpointsSimulationCreateSimulationScenarioRequest
  - `name` string, required
  - `tags` object, required — The tags of the simulation scenario. Both the key and the value can only contain alphanumeric characters, underscores, or spaces.
  - `initial_version` SrcAppEndpointsSimulationCreateSimulationScenarioRequestInitialVersion, required
    - `objective` string, required
    - `instructions` string, required
    - `initial_message_type` 'user-message' | 'external-event' | 'skip', required
    - `conversation_starts_at` string, date-time, nullable, required — The time at which the conversation starts. This must be a timestamp in UTC. If not specified, the current server time is used.

## Response `201`

Succeeded.

- SrcAppEndpointsSimulationCreateSimulationScenarioResponse
  - `simulation_scenario_id` string, required — The ID of the created simulation scenario.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — The specified organization was not found.
- `409` — A simulation scenario with this name already exists.
- `422` — Invalid request path parameter or request body failed validation.
- `429` — The user has exceeded the rate limit of 500 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

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