Skip to content
Menu
Rigel
docs
Guides
Reference
Light
Dark
System
Open Rigel
Search the docs
Press
/
to search,
Esc
to clear.
Light
Dark
System
Guides
All guides
17
Start here
How the API fits together
Quickstart
Authentication
Concepts
Households and people
Commands
Queries and lists
Errors and retries
Sync and working offline
The household socket
Files
Jobs
Rigel, the agent
Outside accounts
Email
Formats
IDs and formats
Units
Versioning
Reference
Platform
Account and sign-in
4
About account and sign-in
Start signing in with Google
Finish signing in with Google
Sign out
Who you are and your households
Households
6
About households
Disconnect an outside account
Clear the sample data
What outside accounts are connected
Create a household
Get a household
Add sample data
Sync
2
About sync
Rows changed since a version
Send a device's queued commands
Files
5
About files
Delete a file
A file's details
Upload a new file
Upload a file's missing copy
Download a file's bytes
Notifications
10
About notifications
Unmute an app for me
Mute an app for me
Mark some of my notifications read
Mark all my notifications read
Notify people
The apps I've muted
My notifications
Get the web push public key
Save this browser's push subscription
Remove this browser's push subscription
Integrations
2
About integrations
Start connecting an outside account
Finish connecting a Google account
Agent
14
About agent
Set up a routine for Rigel
Pause a routine
Remove a routine
Resume a paused routine
Change a routine
Set up a trigger for Rigel
Pause a trigger
Remove a trigger
Resume a paused trigger
Change a trigger
Rigel's routines
Rigel's triggers
List your conversations with Rigel
Get a conversation with Rigel
Health
1
About health
Check the API is up
Apps
Family
10
About family
Delete a note
Change who a note is about or which app it's for
Remember something new about a person or the household
Change what a note says
Add someone to the immediate family
Remove someone and all their notes
Move a person to a position on the page
Change a person's name or birth date
Everything the household knows about its people
Who is in the family
Meals
20
About meals
Add a dish to the household's dish list
Replace one dish with another everywhere, then delete it
Make a new icon for a dish
Delete a dish no meal uses
Set what to buy for a dish
Rename a dish, link or unlink its recipe, or mark it as eaten away from home
Move a meal to another date or slot
Plan a meal for some people
Delete a meal
Take one person out of a meal
Change a meal's people, dishes or note
Change when Rigel plans the week, or when a plan week starts
Plan many meals at once without replacing any
One dish, with what to buy for it
Find dishes by name
What people ate (or are planned to eat) between two dates
Meal planning settings and which week is current
What changed in a week's plan, and who changed it
The meal plan for a week
What a week's meals need from the store
Recipes
24
About recipes
Record that a recipe was cooked
Change a cook's note or servings
Add one ingredient
Move one ingredient
Remove one ingredient
Change one ingredient
Make a version of a recipe
Make a recipe
Start importing a recipe from a web page
Make new pictures for a recipe
Delete a recipe
Make a recipe for a different number of servings
Replace a recipe's whole ingredient list
Replace a recipe's whole step list
Change a recipe's title, summary, servings, times, notes or source
Add one step
Move one step
Remove one step
Change one step
A whole recipe
The original of an imported recipe
What has been cooked lately
Find recipes
What to buy to cook a recipe
Shopping
28
About shopping
Set a store's aisles in walking order
Change one aisle's label, sign text or sign photo
Add a product group
Remove a product group
Put a product in a group or take it out
Rename a product group
Put something on the shopping list
Put several things on the shopping list at once
Check an item off the list (got it), or put it back
Take items off the shopping list
Change a list item's product, amount, note or who it's for
Put a product in an aisle at a store
Add a store
Remove a store
Move a store to a position in the store picker
Say a store carries a product group, or stops
Say a store does or doesn't carry one product
Change a store's name, address or whether it's online
Finish a shopping trip
Record a trip from a receipt or an order
Delete a trip recorded by mistake
Correct a saved trip
What we bought before
The shopping list
Where and when an inventory item was bought
Stores and what they carry
One shopping trip
Past shopping trips
Inventory
27
About inventory
Delete a product category
Rename a product category or change its place in the order
Make several inventory changes at once
Add something we have
Use some of an item, or add some
Say an item is still there as recorded
Move an item to another place
Remove an item that is gone
Set how much of an item we have
Give an item its picture
Change an item's brand, size, dates, note, who it's for or the recipe it's from
Say a whole place is up to date
Add a place things are kept
Delete an empty place
Rename, move, reorder or change a place
Add a product, or use the one with that name
Combine two products that are the same thing
Make a new icon for a product
Give a product its icon
Rename a product, recategorize it, or change how it's kept
The product categories in use
What to use soon
What changed an item
What we have, and where
The places things are kept, as a tree
Do we have these products?
Find a product by name, to reuse it
Calendar
26
About calendar
Make a new calendar
Delete a calendar and its events
Make sure the household has its calendars
Rename, recolor or change a calendar
Add an extra date to a repeating event
Add an image or file to an event
One occurrence of a repeating event doesn't happen
Add an event to the calendar
Take an image or file off an event
Stop a repeating event after a date
Move an event to another calendar
Delete an event
Take away an extra date of a repeating event
Undo changes to one occurrence
Say who an event involves
Set an event's reminders
Change an event, or every occurrence of a repeating one
Change one occurrence of a repeating event
Link a calendar to a Google calendar
Stop syncing a calendar with Google
Create or update the event an app's record owns
Remove the event an app's record owns
The household's calendars
One event in full
When people are free together
What's happening in a date range
Email
20
About email
Rename an email address or make it the default
Choose which Gmail mail Rigel reads
Check a custom domain now
Throw a draft away
Send a draft
Write an email draft, or change one
Say how an email should be treated
Record what was done with an email
Rigel's email addresses
The DNS records for a custom domain
Drafts waiting to be sent
One email in full
The inbox
A conversation of emails
Get the household's email address, making it if needed
Add an email address
Remove an email address
Add a custom domain
Remove a custom domain
An email's HTML body
Tasks
30
About tasks
Comment on a task
Change what a comment says
React to a comment with an emoji
Delete a comment
Take back an emoji reaction
Delete a tag
Rename a tag
Add a task
Add several tasks at once
Link a task to a record in another app
Move a task under another task, or reorder it
Delete a task and its subtasks
Replace what a task depends on
Mark a task to do, doing, blocked or done
Replace a task's tags
Remove a task's link to another record
Stop following a task
Change a task's details
Follow a task
Delete a saved view
Save a view of the tasks
Mentions and changes on the tasks someone follows
Projects and how far along they are
How much gets done, and how long things take
Every tag, and how much it's used
What's blocked, and on what
One task in full
What's ready to do, in order
Find tasks by words and filters, done included
The saved views
Documents
24
About documents
Make a document from an uploaded file
Change a document between Markdown and HTML
Make targeted changes to a document
Link a document to a record
Delete a document
Save the text read from a file
Remove a document's link to a record
Rename, file or describe a document
Replace a document's whole text
Write a new document
Save what you extracted from a document
Create a folder
Move a folder
Delete an empty folder
Rename a folder
Import from Google Drive
Dismiss a finished import
Restore an earlier version of a document
Documents linked to a record
Read a document
Find documents by what they say
What is in a folder
A document's history
Browse a connected Google Drive
Chat
24
About chat
Archive a topic
Make a topic
Rename a topic
Bring back an archived topic
Retire a custom emoji
Add a custom emoji
Change how a topic notifies me
Delete my message
Change the text of my message
Send a message in a conversation or thread
Make a pack of emoji and stickers
Remove a pack
Set what's in a pack
Rename or reorder a pack
React to a message
Take back a reaction
Mark a conversation read up to a message
Retire a sticker
Add a sticker
Move messages into another topic
The household's topics
Messages around one message
Messages in a conversation or thread
Find messages
Maintenance
84
About maintenance
Add something to the house's records
Add a photo of an item
Link an item to the right model
Delete an item recorded by mistake
Take a photo off an item
Look an item up again
Mark an item as gone or replaced
Change what's known about an item
Delete a wrong fact
Record a fact about an item, a model or a property
Undo a check-off
Add a named person at a contractor
Delete a contractor's contact
Change a contractor's contact
Add a contractor the household uses
Delete a contractor
Change a contractor
Save what reading a label found
Record a quote or an invoice
Delete a quote or an invoice
Correct a quote or an invoice
Delete a problem recorded by mistake
Record a problem with the house
Mark a problem fixed
Change a problem, or watch it or reopen it
Add a place
Delete a place
Rename or move a place
Record a part or consumable
Say a part fits a model or an item
Delete a part
Say a part doesn't fit a model or an item
Change what's known about a part
Add an item or a problem to a project
Add to a project's work log
Delete a project
Delete a work log entry
Start a project
Take an item or a problem off a project
Change a project
Add another property
Delete a property and everything at it
Rename a property or set its address
Record an ongoing service
End an ongoing service
Delete an ongoing service
Change an ongoing service's terms
Add a recurring maintenance task
Check off a maintenance task
Open Tasks-app tasks for what's coming due
Delete a maintenance task
Plan a day for a maintenance task
Set the parts a maintenance task uses
Skip a maintenance task this time
Turn a maintenance task off
Turn a maintenance task back on
Take a maintenance task off the calendar
Change a maintenance task
Cancel a scheduled visit
Record that a visit happened
Record a visit that already happened
Delete a visit recorded by mistake
Schedule a contractor's visit
Reschedule or change a visit
Record an item's warranty
Delete a warranty
Change a warranty
Where an item's facts came from
Everything about one item
The house's items
Asset categories and the fact keys to use
One contractor's details and history
The household's contractors
One problem with the house
Problems with the house
The state of the house at a glance
One project's whole workspace
Repairs and improvements under way
A property's profile and its places
Find anything in the house records
One maintenance task in full
Maintenance tasks, grouped by when they're due
One contractor visit
Contractor visits, coming or done
Dashboard
5
About dashboard
Make a new picture for a place
Set the picture behind a place's icon
Take a card off the dashboard
Put a card on the dashboard
What's on the dashboard for a day
Reference
Health
Check that the API is up.
Routes
Get
Check the API is up
health.check
Returns ok.