Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
scenarios
/
{scenario_id}
Get Scenario Detail
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/scenarios/{scenario_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "turns": [
    {
      "user_message": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_index": 123,
      "criteria": [
        {
          "question": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "turn_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "criteria_type": "llm_evaluated",
          "few_shot_examples": [
            {
              "response": "<string>",
              "verdict": "PASS",
              "critique": "<string>"
            }
          ],
          "order_index": 0
        }
      ],
      "required": true
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "customer_context": {}
}

Authorizations

Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

org_id
string<uuid>
required
scenario_id
string<uuid>
required

Response

Successful Response

Schema for reading a scenario.

name
string
required
Required string length: 1 - 255
id
string<uuid>
required
organization_id
string<uuid>
required
created_by_user_id
string<uuid> | null
required
turns
ScenarioTurnRead · object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
tags
string[]
customer_context
Customer Context · object

Profile data for template rendering (e.g., customer name, booking info)