> ## Documentation Index > Fetch the complete documentation index at: https://docs.freyavoice.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update simulation > Updates an existing simulation. ## OpenAPI ````yaml https://staging-app.freyavoice.ai/api/openapi.json put /simulations/{simulationId} openapi: 3.1.0 info: title: Freyavoice API version: 2.0.0 description: >- Production API for managing calls and campaigns. **Authentication**: All endpoints require a bearer token issued by Freyavoice. **Response Format**: All responses are wrapped in a standard envelope: ```json { "success": true, "data": { "message": "Success", "result": { /* endpoint-specific data */ } } } ``` Error responses follow the same format with `success: false`: ```json { "success": false, "data": { "message": "Error description", "result": null } } ``` contact: name: Freyavoice Support email: support@freyavoice.com servers: - url: https://app.freyavoice.ai/api/v2 description: Production security: [] tags: - name: Agents description: Manage AI agents - name: Analytics description: Call analytics and metrics - name: API Keys description: API key management - name: Audio description: Audio transcription and speech synthesis - name: Calls description: Call management and history - name: Call Recordings description: Call recording management - name: Call Tags description: Call tagging and categorization - name: Campaigns description: Campaign management - name: Chat description: Stateful text chat with agents and workflows - name: Custom description: Custom convenience endpoints - name: Export description: Data export - name: Insights description: Structured data field definitions - name: Agent Insights description: Agent-to-field assignments - name: Integrations description: Third-party integrations - name: Personas description: Simulation personas for agent testing - name: Phone Numbers description: Phone number management - name: Phone Aliases description: Workspace phone book (phone-number to label mappings) - name: Suppression List description: Workspace do-not-call (DNC) list; numbers blocked from outbound dialing - name: Feedbacks description: Feedback tracking - name: Feedback Assignees description: Feedback assignment - name: Feedback Comments description: Feedback comments - name: Feedback References description: Feedback cross-references to other entities - name: Feedback Status Config description: Feedback status configuration - name: Reviews description: Call reviews - name: Review Assignees description: Review assignment - name: Simulations description: Agent simulation testing - name: Simulation Iterations description: Simulation iteration history - name: Unit Tests description: Behavioural unit tests for agents and workflows - name: Branches description: Branches (proposed changes) of an agent or workflow version line - name: Webhooks description: Webhook configuration - name: Versions description: Version history and rollback for agents and workflows - name: Workflows description: Workflow management - name: Workspaces description: Workspace management - name: Workspace Credits description: Workspace credit balance - name: Workspace Invitations description: Workspace invitations - name: Workspace Logs description: Workspace activity logs - name: Workspace Members description: Workspace member management - name: Workspace Roles description: Custom roles and permissions per workspace - name: Permissions description: Permission catalog (used by role + API-key UIs) paths: /simulations/{simulationId}: put: tags: - Simulations summary: Update simulation description: Updates an existing simulation. operationId: updateSimulation parameters: - schema: type: string format: uuid required: true name: simulationId in: path requestBody: content: application/json: schema: type: object properties: name: type: string minLength: 1 description: type: - string - 'null' tags: type: array items: type: string minLength: 1 maxLength: 100 maxItems: 50 status: type: string enum: - draft - running - paused - completed agentId: type: string format: uuid selectedPersonaIds: type: array items: type: string format: uuid assertions: type: array items: type: string format: uuid maxConcurrentCalls: type: integer minimum: 1 maximum: 1000 maxCallDurationSeconds: type: integer minimum: 60 maximum: 3600 maxRetries: type: integer minimum: 0 maximum: 10 runsPerPersona: type: integer minimum: 1 maximum: 50 metrics: type: object properties: totalRuns: type: integer minimum: 0 default: 0 passedRuns: type: integer minimum: 0 default: 0 failedRuns: type: integer minimum: 0 default: 0 averageLatencyMs: type: - number - 'null' minimum: 0 default: null averageDurationSeconds: type: - number - 'null' minimum: 0 default: null agentSpeakingPercent: type: - number - 'null' minimum: 0 maximum: 1 default: null additionalProperties: {} responses: '200': description: Simulation updated content: application/json: schema: type: object properties: success: type: boolean enum: - true data: type: object properties: message: type: string result: type: object properties: simulation: type: object properties: id: type: string workspaceId: type: string format: uuid agentId: type: - string - 'null' format: uuid name: type: string description: type: - string - 'null' tags: type: array items: type: string default: [] status: type: string enum: - draft - running - paused - completed settings: type: object properties: maxConcurrentCalls: type: integer minimum: 1 maximum: 1000 default: 1 maxCallDurationSeconds: type: integer minimum: 60 maximum: 3600 default: 60 maxRetries: type: integer minimum: 0 maximum: 10 default: 3 runsPerPersona: type: integer minimum: 1 maximum: 50 default: 1 metrics: type: - object - 'null' properties: totalRuns: type: integer minimum: 0 default: 0 passedRuns: type: integer minimum: 0 default: 0 failedRuns: type: integer minimum: 0 default: 0 averageLatencyMs: type: - number - 'null' minimum: 0 default: null averageDurationSeconds: type: - number - 'null' minimum: 0 default: null agentSpeakingPercent: type: - number - 'null' minimum: 0 maximum: 1 default: null additionalProperties: {} latestPassRate: type: - number - 'null' minimum: 0 maximum: 1 createdBy: type: - string - 'null' updatedBy: type: - string - 'null' createdAt: type: string updatedAt: type: string required: - id - workspaceId - agentId - name - status - settings - createdAt - updatedAt personas: type: array items: type: object properties: id: type: string workspaceId: type: string format: uuid name: type: string prompt: type: - string - 'null' successCriteria: type: - string - 'null' systemPrompt: type: - string - 'null' evaluationPrompt: type: - string - 'null' tags: type: array items: type: string agentIds: type: array items: type: string format: uuid simulationVariables: type: object additionalProperties: type: object additionalProperties: type: string default: {} description: >- Most-recently-used simulation variable values, keyed by simulated agentId versionNumber: type: integer exclusiveMinimum: 0 createdAt: type: string updatedAt: type: string createdBy: type: - string - 'null' updatedBy: type: - string - 'null' required: - id - workspaceId - name - prompt - successCriteria - systemPrompt - evaluationPrompt - tags - agentIds - createdAt - updatedAt - createdBy - updatedBy assertions: type: array items: type: object properties: id: type: string workspaceId: type: string name: type: string prompt: type: string contextConfig: type: - object - 'null' properties: includeRoutingEvents: type: boolean includeExtractionEvents: type: boolean includeToolCalls: type: boolean includeOtherEvents: type: boolean createdAt: type: string updatedAt: type: string required: - id - workspaceId - name - prompt - createdAt - updatedAt metrics: type: - object - 'null' properties: totalRuns: type: integer minimum: 0 default: 0 passedRuns: type: integer minimum: 0 default: 0 failedRuns: type: integer minimum: 0 default: 0 averageLatencyMs: type: - number - 'null' minimum: 0 default: null averageDurationSeconds: type: - number - 'null' minimum: 0 default: null agentSpeakingPercent: type: - number - 'null' minimum: 0 maximum: 1 default: null additionalProperties: {} publishedVersionId: type: - string - 'null' format: uuid required: - simulation - personas - assertions required: - message - result required: - success - data '400': description: Validation error content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: object properties: message: type: string result: {} required: - message required: - success - data '401': description: Missing or invalid token content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: object properties: message: type: string result: {} required: - message required: - success - data '403': description: Workspace ID mismatch or insufficient permissions content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: object properties: message: type: string result: {} required: - message required: - success - data '404': description: Simulation not found '500': description: Server error content: application/json: schema: type: object properties: success: type: boolean enum: - false data: type: object properties: message: type: string result: {} required: - message required: - success - data security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer ````