Build It

Hello, family

Your first read. Pull the family roster, look up a kid by name, list their tasks.

Your first read. Pull the family roster, look up a kid by name, list their tasks. Read-only, safe. This is the smallest useful first call after connecting.

Pull the family overview

family_query_overview returns the family name, parent names, and an array of kids. Each kid has a childId, name, birthDate, grade, and current gemBalance. This is the starting point for every workflow.

Code
family_query_overview
# Returns:
{
"familyName": "The Schimmels",
"parents": [{"name": "Leti"}, {"name": "Han"}],
"kids": [
{
"childId": "019c5228-...",
"name": "Jay",
"birthDate": "2018-03-15",
"grade": "2nd",
"gemBalance": 42
},
{
"childId": "019c5229-...",
"name": "Shane",
"birthDate": "2020-09-01",
"grade": "K",
"gemBalance": 17
}
]
}

Look up a kid

Resolve by name from the overview response. Never hardcode UUIDs. The childId is the key for every subsequent call: task_list, gems_query_balance, task_create, etc.

List their tasks

Code
task_list({childId: "019c5228-..."})
# Returns an array of tasks with name, schedule, completion status, gems

Check gem balance

Code
gems_query_balance({childId: "019c5228-..."})
# Returns: { "balance": 42 }
infoAll three calls above are read-only. They cannot mutate family state. Safe to run in any order, any number of times.

Further reading

Was this page helpful?
Author a canvas chevron_right