Administration6

Agent Copilot Configuration2

Agent Copilot Configurations3

AI Agents9

Alexa5

Analytics8

Analytics 3.04

Audit Events2

Connections9

Contact Profiles12

Conversations2

Conversations v2.01

Conversations v2.11

Dashboard3

Endpoints11

Example Sentences7

Extensions6

Files2

Flows13

Functions9

Handover Providers5

Handover Services2

Identity Providers2

Intent Trainer6

Intents11

Knowledge Chunks5

Knowledge Connectors7

Knowledge Sources7

Knowledge Stores5

Large Language Models8

Lexicons27

Live Agent5

Locales5

Logs3

Logs v2.13

Management UI19

NLU Connectors6

Nodes12

Options Resolver1

Packages7

Personas5

Playbooks17

Projects15

Search1

Sessions2

Simulation Runs2

Simulations14

Slot Fillers6

Snapshots9

Tasks3

Tokens3

Transcript Scenario Generation3

Users35

Users 2.12

Voice Gateway4

Voice Preview2

Webfinger1

Yes/No Intents10

Simulations

Create scenario

Create a scenario with the provided configuration.

post/simulations

Request

Base URL
https://api-trial.cognigy.ai/testing
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/simulations/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

projectIdstring required

Project identifier

Request body

projectReferencestring required

Project reference (required in body)

namestring required

Name of the scenario

personastring required

Persona description

personaNamestring required

Name of the persona

missionstring required

Mission description

maxTurnsinteger

Maximum number of turns

timeoutinteger

Timeout in seconds

aiAgentReferenceIdstring

Reference ID of the AI Agent

flowReferenceIdstring

Reference ID of the Flow

jobNodeIdstring

Job Node ID for precise tool context tracking

Response

Scenario created successfully

idstring required

Unique identifier for the scenario

referenceIdstring required

Reference ID for the scenario

namestring required

Name of the scenario

personastring required

Persona description

personaNamestring required

Name of the persona

missionstring required

Mission description

maxTurnsinteger

Maximum number of turns

timeoutinteger

Timeout in seconds

aiAgentReferenceIdstring

Reference ID of the AI Agent

aiAgentIdstring

Database ID of the AI Agent

flowReferenceIdstring

Reference ID of the Flow

flowIdstring

Database ID of the Flow

jobNodeIdstring

Job Node ID

organisationReferencestring required

Organization reference

projectReferencestring required

Project reference

createdAtinteger required

Creation timestamp

createdBystring required

User who created the scenario

updatedAtinteger

Last update timestamp

updatedBystring

User who last updated the scenario

lastChangedinteger required

Last change timestamp

lastChangedBystring required

User who made the last change

Changes

No recorded changes to this operation across all 1 revision of this API.