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

Example

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

Last updated