Assistants

Use the assistants query to get the information of the AI assistants set via console.

Arguments

Argument	Type	Description
filters	filter
filters.id	ID	Id of the assistant.

Available fields

Argument	Type	Description
id	ID	Id of the assistant.
name	String!	Name of the assistant.
onboarding	Boolean!	Set to True to send a message as soon as the user is onboarded, otherwise False.
onboardingPrompt	String	Sets the onboarding message.
mainGoal	String!	Sets the assistance main goal/intent.
mode	AssistantMode!	AUTO: AI replies user automatically. MANUAL: AI generates the message but is only sent once approved by a Coach/Admin.
program	ID	Links to program using program ID.
voice	String	Sets voice persona of the assistant. (ex: "Professional","Happy","Friendly")
journey	JourneyAssistantType	See more.

Example

Query

query {
  assistants{
    id
    name
    onboarding
    onboardingPrompt
    mainGoal
    mode
    program
    voice
    journey{
      dayJourney{
        order
        skipped
        id
        interactions{
          goal
          interaction
          id
        }
      }
      welcomeMessage
      sendWelcomeMessage
      id
    }
  }
}

Response

{
  "data": {
    "assistants": [
      {
        "id": "QXNzaXN0YW501jMyNDk0YWZjLTQ0NzQtNDkzYS1hMWYxLTZiTZmNjdhZmZhNQ==",
        "name": "Welcome Sequence",
        "onboarding": false,
        "onboardingPrompt": "",
        "mainGoal": "Help clients navigate the 1st 30 days of healthy lifestyle",
        "mode": "MANUAL",
        "program": null,
        "voice": "friendly professional",
        "journey": {
          "dayJourney": [
            {
              "order": 1,
              "skipped": false,
              "id": "RGF5Sm91cm5leTpiYjJmNTk2Ni00MGY1LTQxZDcOGY5ZS03N2I0YmFkYTRiMDM=",
              "interactions": [
                {
                  "goal": "welcome new members to the app and the start of their wellness journey",
                  "interaction": "Welcome! We're excited for you to take a look around!",
                  "id": "SW50ZXJhY3Rpb246ZmZiMzgyZjItNTNhMS00YWY4LWE2YTgtM2NjZWVkOTQ5ZWI5"
                }
              ]
            },
            {
              "order": 2,
              "skipped": false,
              "id": "RGF5Sm91cm5leTowNjRlNmVmOC1lOTkxLTQ0NTgtOTI4NS0zNGQ3YmVlYjI4jA=",
              "interactions": [
                {
                  "goal": "hydration",
                  "interaction": "Remind the user about drinking water",
                  "id": "SW0ZXJhY3Rpb246YmI4NGEwYmYtYmQ3ZS00ZDRmLTlmN2MtYjE0M2Q0M2NlZDM2"
                }
              ]
            },
            {
              "order": 3,
              "skipped": false,
              "id": "RGF5Sm91cm5leTphYzFhYm2Zi1mOWFlLTQzN2QtYTU3My0yMGYyODQ0ZDZmTE=",
              "interactions": [
                {
                  "goal": "sleep",
                  "interaction": "Remind the user about the importance of getting enough sleep",
                  "id": "SW50ZXJhY3Rpb246YmFkMDkwYWEtZjNkYS00NzVkLTk2Y2QtNmJmNzcwM2YzYjhh"
                }
              ]
            },
            {
              "order": 4,
              "skipped": false,
              "id": "RGF5Sm91cm5leowMjk1YmY2Mi1iOWYxLTQwMjAtYTIzMy0xNTZhZTA5ZjNjNzA=",
              "interactions": [
                {
                  "goal": "movement",
                  "interaction": "Remind the user about the importance of a regular movement routine",
                  "id": "SW50ZXJhY3Rpb246ZDMzNDQ5MDUtNmMwMi00N2RjLTk1N2ItMzdhZGE5NmNkOWM1"
                }
              ]
            },
          "welcomeMessage": "Welcome to your wellness journey!",
          "sendWelcomeMessage": true,
          "id": "Sm91cmleTowNTM1NDgwNC0xZWVlLTQzN2YtYjczNS01N2IwZGE2MzA0ZDQ="
        }
      }
    ]
  }
}