client.welcome

get()

client.welcome.get(study_id) -> WelcomeOut

Get the welcome message. configured is false if none has been set. Returns WelcomeOut.

set()

client.welcome.set(study_id, *, message: str, consent: bool | None = None) -> WelcomeOut

Create or replace the welcome and consent message.

str | UUID

required

The study.

str

required

Shown before the interview starts.

Require participants to agree explicitly before the interview begins.

Returns WelcomeOut.

generate()

client.welcome.generate(study_id) -> WelcomeDraftOut

Draft the welcome and consent message with AI. Nothing is saved. The draft draws on the study’s name, description, research question, target population, benefits, risks, support contact, question count, survey type and language, and on your profile. Anything missing becomes a placeholder such as [Insert researcher name] and is listed in placeholders. Usually takes 10–30 seconds.

draft = client.welcome.generate(study.id)
message = draft.message
for placeholder in draft.placeholders:
    message = message.replace(placeholder, lookup(placeholder))
client.welcome.set(study.id, message=message, consent=True)

Returns WelcomeDraftOut.

list_translations()

client.welcome.list_translations(study_id) -> WelcomeTranslationListOut

Returns WelcomeTranslationListOut.

upsert_translation()

client.welcome.upsert_translation(
    study_id, *, target_language: str, translation_text: str, source_language: str | None = None
) -> WelcomeTranslationOut

Add or replace the translation for target_language. Set the welcome message first.

str

required

Language name or ISO code, such as "Spanish" or "es".

str

required

The translated welcome message.

str

default:"English"

Source language name or ISO code.

Returns WelcomeTranslationOut.

delete_translation()

client.welcome.delete_translation(study_id, translation_id) -> SuccessResponse

Returns SuccessResponse.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

get()

set()

generate()

list_translations()

upsert_translation()

delete_translation()

​get()

​set()

​generate()

​list_translations()

​upsert_translation()

​delete_translation()

get()

set()

generate()

list_translations()

upsert_translation()

delete_translation()