Create a call scenario for an agent

POST

/agents/{id}/scenarios

Creates a scenario-specific Markdown guide. The lookup key is generated server-side from the title and is not user-editable.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/agents//scenarios' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "Pricing and quotes",
    "whenToUse": "Caller asks for price, cost, estimate, quote, or service level.",
    "scenario": "stringstri",
    "isEnabled": false
}'

Response Example

{
    "id": "string",
    "userId": "string",
    "agentId": "string",
    "key": "string",
    "title": "string",
    "whenToUse": "string",
    "scenario": "string",
    "isEnabled": true,
    "priority": 0,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-07-23 18:02:16

List call scenarios for an agent

Reorder call scenarios for an agent