Skip to main content
GET
/
api
/
roleplay
/
{id}
Get Roleplay By ID
curl --request GET \
  --url https://app.replay.sale/api/roleplay/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "instructions": "<string>",
  "passingScore": 50,
  "isLive": true,
  "conversationType": {
    "title": "<string>",
    "roleplayType": "<string>"
  },
  "customerPersona": {
    "name": "<string>",
    "imageUrl": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "customerBackground": {
    "title": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "customAttributes": {
    "scorecard_id": "sc_789",
    "fs_category": "customer_service",
    "difficulty": "intermediate"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Path Parameters

​
id
string<uuid>
required

The UUID of the premade roleplay to retrieve

Response

Successfully retrieved roleplay

​
id
string<uuid>
required

Unique identifier for the premade roleplay

​
title
string
required

Title of the roleplay

​
instructions
string | null
required

Instructions for the user

​
passingScore
integer
required

Minimum score required to pass

Required range: 0 <= x <= 100
​
isLive
boolean
required

Whether the roleplay is live and accessible to users (true) or in draft mode (false)

​
conversationType
object
required
​
customerPersona
object
required
​
customerBackground
object
required
​
customAttributes
object

Custom key-value pairs for external integrations (LMS systems, analytics, etc.)

Example:
{
  "scorecard_id": "sc_789",
  "fs_category": "customer_service",
  "difficulty": "intermediate"
}