Skip to content
PassionPassion developers

Get the App's Assistant

GET
/apps/{appId}/assistant
curl --request GET \
  --url https://api.passion.io/v1/apps/example/assistant

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appId
required

The id of the App, as Studio shows it.

string
/^[1-9][0-9]*$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
name
required

The name members see.

string
avatarUrl
required
Any of:
string
ownVoice
required

True when the Assistant speaks with a voice built from the creator’s own recordings in Studio.

boolean
welcomeMessage
required

The first message a member sees.

string
Examplegenerated
{
  "name": "example",
  "avatarUrl": "example",
  "ownVoice": true,
  "welcomeMessage": "example"
}