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

# Edit a scenario

> Updates the properties of a specific scenario, such as its name, description, associated graph, or the simulator agent's prompt.



## OpenAPI

````yaml /openapi.json put /simulate/scenarios/{scenario_id}/edit/
openapi: 3.0.0
info:
  title: FutureAGI Unified API
  version: 1.0.0
  description: >-
    Complete API documentation for FutureAGI platform - Simulate module
    (scenario management, agent definitions, test executions, call analytics)
    and Model Hub Evaluations API (evaluation templates, playgrounds, metrics,
    and execution tracking)
  contact:
    email: support@futureagi.com
servers:
  - url: https://api.futureagi.com
    description: Production API
security: []
tags:
  - name: Health
    description: Health check operations for monitoring server status
  - name: Authentication
    description: User authentication and token management
  - name: Scenarios
    description: Test scenario management and execution
  - name: Agent Definitions
    description: Agent definition CRUD operations
  - name: Agent Versions
    description: Agent version control and management
  - name: Simulator Agents
    description: Simulator agent operations
  - name: Run Tests
    description: Test execution management
  - name: Test Executions
    description: Test execution tracking and analytics
  - name: Call Executions
    description: Individual call execution details
  - name: Call Transcripts
    description: Transcript management and retrieval
  - name: Personas
    description: Persona management for testing
  - name: Analytics
    description: Analytics and reporting
  - name: Export Simulate
    description: Data export operations
  - name: Datasets
    description: >-
      Operations related to datasets, including creation, modification, and data
      management.
  - name: Eval Groups
    description: Evaluation group management
  - name: Eval Templates
    description: Base evaluation template operations
  - name: Custom Eval Templates
    description: Custom evaluation template CRUD operations
  - name: Eval Playground
    description: Test and run evaluations in playground environment
  - name: Eval Logs & Metrics
    description: Evaluation logs, metrics, and execution tracking
  - name: Eval Configuration
    description: Evaluation configuration and templates retrieval
  - name: API Keys
    description: API key management
  - name: Prompt Workbench
    description: Prompt template version labeling and lookup by name, version, or label
paths:
  /simulate/scenarios/{scenario_id}/edit/:
    put:
      tags:
        - Scenarios
      summary: Edit a scenario
      description: >-
        Updates the properties of a specific scenario, such as its name,
        description, associated graph, or the simulator agent's prompt.
      operationId: editScenario
      parameters:
        - name: scenario_id
          in: path
          required: true
          description: The UUID of the scenario to edit.
          schema:
            type: string
            format: uuid
      requestBody:
        description: >-
          A JSON object containing the fields to update. All fields are
          optional.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new name for the scenario.
                  maxLength: 255
                description:
                  type: string
                  description: The new description for the scenario.
                  nullable: true
                graph:
                  type: object
                  description: >-
                    The updated graph structure for the scenario. If the
                    scenario does not have a graph, a new one will be created.
                  nullable: true
                prompt:
                  type: string
                  description: >-
                    The new prompt for the simulator agent associated with the
                    scenario. Supports templating variables like {{persona}} and
                    {{situation}}.
                  nullable: true
            examples:
              update-prompt:
                summary: Update the simulator agent's prompt
                value:
                  prompt: >
                    You are a customer with the following characteristics:
                    {{persona}}. Currently, {{situation}}. You will receive a
                    call from an agent named test-agent. Please respond
                    naturally to the agent's questions and provide any necessary
                    information to assist with your appointment schedulings.
              update-name-and-description:
                summary: Update the name and description
                value:
                  name: Updated Scenario Name
                  description: This scenario has been updated with a new description.
      responses:
        '200':
          description: Scenario updated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Scenario updated successfully
                  scenario:
                    $ref: '#/components/schemas/Scenario'
        '400':
          description: >-
            Bad Request. The provided data is invalid, for example, an empty
            name.
        '401':
          description: >-
            Unauthorized. Authentication credentials were not provided or are
            invalid.
        '404':
          description: Not Found. The scenario with the specified ID could not be found.
        '500':
          description: >-
            Internal Server Error. An unexpected error occurred while updating
            the scenario.
      security:
        - ApiKeyAuth: []
          SecretKeyAuth: []
components:
  schemas:
    Scenario:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        source:
          type: string
        scenario_type:
          type: string
          enum:
            - DATASET
            - SCRIPT
            - GRAPH
        organization:
          type: string
          format: uuid
        dataset:
          type: string
          format: uuid
          nullable: true
        dataset_rows:
          type: integer
        status:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access API Key
    SecretKeyAuth:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access Secret Key

````