API reference
260 commands, 79 queries and 27 routes, filed by area.
A command changes something in the household. A query reads something. A route does what neither does: signing in, uploading a file, syncing a device. Each page has the request and response fields, the errors it can return and real examples.
Account and sign-in
Sign in with Google, sign out, and read who you are and which households you belong to.
- GetStart signing in with Google
auth.google.start - GetFinish signing in with Google
auth.google.callback - PostSign out
auth.sign_out - GetWho you are and your households
me
Households
Create a household, read its settings, add or clear sample data, and see or disconnect the outside accounts connected to it.
- PostDisconnect an outside account
household.integration.disconnect - PostClear the sample data
household.sample.clear - GetWhat outside accounts are connected
household.integration.list - PostCreate a household
households.create - GetGet a household
households.get - PostAdd sample data
sample_data.post
Sync
Send the commands a device queued while it was offline, and pull the rows that changed.
- GetRows changed since a version
sync.pull - PostSend a device's queued commands
sync.push
Files
Upload photos, videos and documents, read them back, and remove them.
- PostDelete a file
files.file.remove - GetA file's details
files.file.get - PostUpload a new file
files.upload - PutUpload a file's missing copy
files.add_copy - GetDownload a file's bytes
files.content
Notifications
Tell people something happened, read and mark notifications, mute an app, and save this browser's push subscription.
- PostUnmute an app for me
notifications.mute.clear - PostMute an app for me
notifications.mute.set - PostMark some of my notifications read
notifications.notification.read - PostMark all my notifications read
notifications.notification.read_all - PostNotify people
notifications.notification.send - GetThe apps I've muted
notifications.mute.list - GetMy notifications
notifications.notification.list - GetGet the web push public key
push.config - PutSave this browser's push subscription
me.push_subscription.put - DeleteRemove this browser's push subscription
me.push_subscription.delete
Integrations
Start connecting a Google account for Calendar, Gmail or Drive, and the address Google sends the browser back to.
- GetStart connecting an outside account
integrations.connect - GetFinish connecting a Google account
integrations.google.callback
Agent
Read your conversations with Rigel, and set up the routines and triggers Rigel runs on its own.
- PostSet up a routine for Rigel
agent.routine.create - PostPause a routine
agent.routine.pause - PostRemove a routine
agent.routine.remove - PostResume a paused routine
agent.routine.resume - PostChange a routine
agent.routine.update - PostSet up a trigger for Rigel
agent.trigger.create - PostPause a trigger
agent.trigger.pause - PostRemove a trigger
agent.trigger.remove - PostResume a paused trigger
agent.trigger.resume - PostChange a trigger
agent.trigger.update - GetRigel's routines
agent.routine.list - GetRigel's triggers
agent.trigger.list - GetList your conversations with Rigel
agent.conversation_list - GetGet a conversation with Rigel
agent.conversation_get
Health
Check that the API is up.
- GetCheck the API is up
health.check
Family
The people in the household, and what Rigel knows about them.
- PostDelete a note
family.note.forget - PostChange who a note is about or which app it's for
family.note.move - PostRemember something new about a person or the household
family.note.record - PostChange what a note says
family.note.revise - PostAdd someone to the immediate family
family.person.add - PostRemove someone and all their notes
family.person.remove - PostMove a person to a position on the page
family.person.reorder - PostChange a person's name or birth date
family.person.update - GetEverything the household knows about its people
family.knowledge.get - GetWho is in the family
family.person.list
Meals
The week's plan, the dishes you eat, who's eating what, and what to buy for it.
- PostAdd a dish to the household's dish list
meals.dish.create - PostReplace one dish with another everywhere, then delete it
meals.dish.merge - PostMake a new icon for a dish
meals.dish.regenerate_icon - PostDelete a dish no meal uses
meals.dish.remove - PostSet what to buy for a dish
meals.dish.set_ingredients - PostRename a dish, link or unlink its recipe, or mark it as eaten away from home
meals.dish.update - PostMove a meal to another date or slot
meals.meal.move - PostPlan a meal for some people
meals.meal.plan - PostDelete a meal
meals.meal.remove - PostTake one person out of a meal
meals.meal.remove_person - PostChange a meal's people, dishes or note
meals.meal.update - PostChange when Rigel plans the week, or when a plan week starts
meals.setting.update - PostPlan many meals at once without replacing any
meals.week.fill - GetOne dish, with what to buy for it
meals.dish.get - GetFind dishes by name
meals.dish.search - GetWhat people ate (or are planned to eat) between two dates
meals.eaten.list - GetMeal planning settings and which week is current
meals.setting.get - GetWhat changed in a week's plan, and who changed it
meals.week.changes - GetThe meal plan for a week
meals.week.get - GetWhat a week's meals need from the store
meals.week.groceries
Recipes
The recipes you cook: importing one from a link, its ingredients and steps, scaling it, and what you cooked.
- PostRecord that a recipe was cooked
recipes.cook.log - PostChange a cook's note or servings
recipes.cook.update - PostAdd one ingredient
recipes.ingredient.add - PostMove one ingredient
recipes.ingredient.move - PostRemove one ingredient
recipes.ingredient.remove - PostChange one ingredient
recipes.ingredient.update - PostMake a version of a recipe
recipes.recipe.copy - PostMake a recipe
recipes.recipe.create - PostStart importing a recipe from a web page
recipes.recipe.import_url - PostMake new pictures for a recipe
recipes.recipe.regenerate_images - PostDelete a recipe
recipes.recipe.remove - PostMake a recipe for a different number of servings
recipes.recipe.scale - PostReplace a recipe's whole ingredient list
recipes.recipe.set_ingredients - PostReplace a recipe's whole step list
recipes.recipe.set_steps - PostChange a recipe's title, summary, servings, times, notes or source
recipes.recipe.update - PostAdd one step
recipes.step.add - PostMove one step
recipes.step.move - PostRemove one step
recipes.step.remove - PostChange one step
recipes.step.update - GetA whole recipe
recipes.recipe.get - GetThe original of an imported recipe
recipes.recipe.get_source - GetWhat has been cooked lately
recipes.recipe.list_recent - GetFind recipes
recipes.recipe.search - GetWhat to buy to cook a recipe
recipes.recipe.shopping_preview
Shopping
The shared list, your stores and their aisles, finished trips with receipts and prices, and what you bought before.
- PostSet a store's aisles in walking order
shopping.aisle.set - PostChange one aisle's label, sign text or sign photo
shopping.aisle.update - PostAdd a product group
shopping.group.create - PostRemove a product group
shopping.group.remove - PostPut a product in a group or take it out
shopping.group.set_member - PostRename a product group
shopping.group.update - PostPut something on the shopping list
shopping.item.add - PostPut several things on the shopping list at once
shopping.item.add_many - PostCheck an item off the list (got it), or put it back
shopping.item.check - PostTake items off the shopping list
shopping.item.remove - PostChange a list item's product, amount, note or who it's for
shopping.item.update - PostPut a product in an aisle at a store
shopping.product.place - PostAdd a store
shopping.store.create - PostRemove a store
shopping.store.remove - PostMove a store to a position in the store picker
shopping.store.reorder - PostSay a store carries a product group, or stops
shopping.store.set_carries_group - PostSay a store does or doesn't carry one product
shopping.store.set_carries_product - PostChange a store's name, address or whether it's online
shopping.store.update - PostFinish a shopping trip
shopping.trip.finish - PostRecord a trip from a receipt or an order
shopping.trip.record - PostDelete a trip recorded by mistake
shopping.trip.remove - PostCorrect a saved trip
shopping.trip.update - GetWhat we bought before
shopping.history.lookup - GetThe shopping list
shopping.list.get - GetWhere and when an inventory item was bought
shopping.purchase.for_item - GetStores and what they carry
shopping.store.list - GetOne shopping trip
shopping.trip.get - GetPast shopping trips
shopping.trip.list
Inventory
What's in the house and where it's kept, the products and categories behind it, and what to use soon.
- PostDelete a product category
inventory.category.remove - PostRename a product category or change its place in the order
inventory.category.update - PostMake several inventory changes at once
inventory.change.apply - PostAdd something we have
inventory.item.add - PostUse some of an item, or add some
inventory.item.adjust - PostSay an item is still there as recorded
inventory.item.confirm - PostMove an item to another place
inventory.item.move - PostRemove an item that is gone
inventory.item.remove - PostSet how much of an item we have
inventory.item.set_amount - PostGive an item its picture
inventory.item.set_photo - PostChange an item's brand, size, dates, note, who it's for or the recipe it's from
inventory.item.update - PostSay a whole place is up to date
inventory.location.confirm - PostAdd a place things are kept
inventory.location.create - PostDelete an empty place
inventory.location.remove - PostRename, move, reorder or change a place
inventory.location.update - PostAdd a product, or use the one with that name
inventory.product.create - PostCombine two products that are the same thing
inventory.product.merge - PostMake a new icon for a product
inventory.product.redo_icon - PostGive a product its icon
inventory.product.set_icon - PostRename a product, recategorize it, or change how it's kept
inventory.product.update - GetThe product categories in use
inventory.category.list - GetWhat to use soon
inventory.item.expiring - GetWhat changed an item
inventory.item.history - GetWhat we have, and where
inventory.item.list - GetThe places things are kept, as a tree
inventory.location.list - GetDo we have these products?
inventory.product.have - GetFind a product by name, to reuse it
inventory.product.search
Calendar
Everyone's calendars, events and reminders, when people are free, and optional two-way Google Calendar sync.
- PostMake a new calendar
calendar.calendar.create - PostDelete a calendar and its events
calendar.calendar.remove - PostMake sure the household has its calendars
calendar.calendar.set_up - PostRename, recolor or change a calendar
calendar.calendar.update - PostAdd an extra date to a repeating event
calendar.event.add_date - PostAdd an image or file to an event
calendar.event.attach - PostOne occurrence of a repeating event doesn't happen
calendar.event.cancel_occurrence - PostAdd an event to the calendar
calendar.event.create - PostTake an image or file off an event
calendar.event.detach - PostStop a repeating event after a date
calendar.event.end_recurrence - PostMove an event to another calendar
calendar.event.move - PostDelete an event
calendar.event.remove - PostTake away an extra date of a repeating event
calendar.event.remove_date - PostUndo changes to one occurrence
calendar.event.reset_occurrence - PostSay who an event involves
calendar.event.set_people - PostSet an event's reminders
calendar.event.set_reminders - PostChange an event, or every occurrence of a repeating one
calendar.event.update - PostChange one occurrence of a repeating event
calendar.event.update_occurrence - PostLink a calendar to a Google calendar
calendar.google.link - PostStop syncing a calendar with Google
calendar.google.unlink - PostCreate or update the event an app's record owns
calendar.source_event.put - PostRemove the event an app's record owns
calendar.source_event.remove - GetThe household's calendars
calendar.calendar.list - GetOne event in full
calendar.event.get - GetWhen people are free together
calendar.free_time.find - GetWhat's happening in a date range
calendar.occurrence.list
Rigel's inbox: its addresses and custom domains, the messages that arrive, what Rigel did with them, drafts, and a connected Gmail.
- PostRename an email address or make it the default
email.address.update - PostChoose which Gmail mail Rigel reads
email.connection.set_filter - PostCheck a custom domain now
email.domain.check - PostThrow a draft away
email.draft.discard - PostSend a draft
email.draft.send - PostWrite an email draft, or change one
email.draft.write - PostSay how an email should be treated
email.message.mark - PostRecord what was done with an email
email.message.record_handling - GetRigel's email addresses
email.address.list - GetThe DNS records for a custom domain
email.domain.records - GetDrafts waiting to be sent
email.draft.list - GetOne email in full
email.message.get - GetThe inbox
email.message.list - GetA conversation of emails
email.thread.get - PostGet the household's email address, making it if needed
email.setup - PostAdd an email address
email.addresses_create - DeleteRemove an email address
email.addresses_delete - PostAdd a custom domain
email.domains_create - DeleteRemove a custom domain
email.domains_delete - GetAn email's HTML body
email.messages_html
Tasks
To-dos and projects: who's doing them, their tags, comments and dependencies, saved views, and what is blocked.
- PostComment on a task
tasks.comment.add - PostChange what a comment says
tasks.comment.edit - PostReact to a comment with an emoji
tasks.comment.react - PostDelete a comment
tasks.comment.remove - PostTake back an emoji reaction
tasks.comment.unreact - PostDelete a tag
tasks.tag.remove - PostRename a tag
tasks.tag.rename - PostAdd a task
tasks.task.create - PostAdd several tasks at once
tasks.task.create_many - PostLink a task to a record in another app
tasks.task.link - PostMove a task under another task, or reorder it
tasks.task.move - PostDelete a task and its subtasks
tasks.task.remove - PostReplace what a task depends on
tasks.task.set_dependencies - PostMark a task to do, doing, blocked or done
tasks.task.set_state - PostReplace a task's tags
tasks.task.set_tags - PostRemove a task's link to another record
tasks.task.unlink - PostStop following a task
tasks.task.unwatch - PostChange a task's details
tasks.task.update - PostFollow a task
tasks.task.watch - PostDelete a saved view
tasks.view.remove - PostSave a view of the tasks
tasks.view.save - GetMentions and changes on the tasks someone follows
tasks.activity.for_person - GetProjects and how far along they are
tasks.project.list - GetHow much gets done, and how long things take
tasks.stats.get - GetEvery tag, and how much it's used
tasks.tag.list - GetWhat's blocked, and on what
tasks.task.blocked - GetOne task in full
tasks.task.get - GetWhat's ready to do, in order
tasks.task.queue - GetFind tasks by words and filters, done included
tasks.task.search - GetThe saved views
tasks.view.list
Documents
Documents and folders: write or upload them, edit Markdown together, keep versions, link them to records, and import from Google Drive.
- PostMake a document from an uploaded file
documents.document.add_file - PostChange a document between Markdown and HTML
documents.document.convert - PostMake targeted changes to a document
documents.document.edit - PostLink a document to a record
documents.document.link - PostDelete a document
documents.document.remove - PostSave the text read from a file
documents.document.save_text - PostRemove a document's link to a record
documents.document.unlink - PostRename, file or describe a document
documents.document.update - PostReplace a document's whole text
documents.document.write - PostWrite a new document
documents.document.write_new - PostSave what you extracted from a document
documents.extract.save - PostCreate a folder
documents.folder.create - PostMove a folder
documents.folder.move - PostDelete an empty folder
documents.folder.remove - PostRename a folder
documents.folder.rename - PostImport from Google Drive
documents.google.import - PostDismiss a finished import
documents.import.dismiss - PostRestore an earlier version of a document
documents.version.restore - GetDocuments linked to a record
documents.document.for_record - GetRead a document
documents.document.read - GetFind documents by what they say
documents.document.search - GetWhat is in a folder
documents.folder.list - GetA document's history
documents.version.list - GetBrowse a connected Google Drive
documents.google_files
Chat
The family chat: topics and threads, messages, reactions, custom emoji and stickers, search, and who has read what.
- PostArchive a topic
chat.conversation.archive - PostMake a topic
chat.conversation.create - PostRename a topic
chat.conversation.rename - PostBring back an archived topic
chat.conversation.unarchive - PostRetire a custom emoji
chat.custom_emoji.archive - PostAdd a custom emoji
chat.custom_emoji.create - PostChange how a topic notifies me
chat.follow.set - PostDelete my message
chat.message.delete - PostChange the text of my message
chat.message.edit - PostSend a message in a conversation or thread
chat.message.send - PostMake a pack of emoji and stickers
chat.pack.create - PostRemove a pack
chat.pack.remove - PostSet what's in a pack
chat.pack.set_items - PostRename or reorder a pack
chat.pack.update - PostReact to a message
chat.reaction.add - PostTake back a reaction
chat.reaction.remove - PostMark a conversation read up to a message
chat.read.mark - PostRetire a sticker
chat.sticker.archive - PostAdd a sticker
chat.sticker.create - PostMove messages into another topic
chat.thread.move - GetThe household's topics
chat.conversation.list - GetMessages around one message
chat.message.context - GetMessages in a conversation or thread
chat.message.list - GetFind messages
chat.message.search
Maintenance
The house and what's in it: equipment and parts, warranties, recurring tasks, issues and projects, contractors, visits and invoices.
- PostAdd something to the house's records
maintenance.asset.add - PostAdd a photo of an item
maintenance.asset.add_photo - PostLink an item to the right model
maintenance.asset.correct_model - PostDelete an item recorded by mistake
maintenance.asset.remove - PostTake a photo off an item
maintenance.asset.remove_photo - PostLook an item up again
maintenance.asset.research - PostMark an item as gone or replaced
maintenance.asset.retire - PostChange what's known about an item
maintenance.asset.update - PostDelete a wrong fact
maintenance.attribute.forget - PostRecord a fact about an item, a model or a property
maintenance.attribute.record - PostUndo a check-off
maintenance.completion.remove - PostAdd a named person at a contractor
maintenance.contact.add - PostDelete a contractor's contact
maintenance.contact.remove - PostChange a contractor's contact
maintenance.contact.update - PostAdd a contractor the household uses
maintenance.contractor.add - PostDelete a contractor
maintenance.contractor.remove - PostChange a contractor
maintenance.contractor.update - PostSave what reading a label found
maintenance.identification.record - PostRecord a quote or an invoice
maintenance.invoice.record - PostDelete a quote or an invoice
maintenance.invoice.remove - PostCorrect a quote or an invoice
maintenance.invoice.update - PostDelete a problem recorded by mistake
maintenance.issue.remove - PostRecord a problem with the house
maintenance.issue.report - PostMark a problem fixed
maintenance.issue.resolve - PostChange a problem, or watch it or reopen it
maintenance.issue.update - PostAdd a place
maintenance.location.add - PostDelete a place
maintenance.location.remove - PostRename or move a place
maintenance.location.update - PostRecord a part or consumable
maintenance.part.add - PostSay a part fits a model or an item
maintenance.part.fit - PostDelete a part
maintenance.part.remove - PostSay a part doesn't fit a model or an item
maintenance.part.unfit - PostChange what's known about a part
maintenance.part.update - PostAdd an item or a problem to a project
maintenance.project.link - PostAdd to a project's work log
maintenance.project.log - PostDelete a project
maintenance.project.remove - PostDelete a work log entry
maintenance.project.remove_entry - PostStart a project
maintenance.project.start - PostTake an item or a problem off a project
maintenance.project.unlink - PostChange a project
maintenance.project.update - PostAdd another property
maintenance.property.add - PostDelete a property and everything at it
maintenance.property.remove - PostRename a property or set its address
maintenance.property.update - PostRecord an ongoing service
maintenance.service.add - PostEnd an ongoing service
maintenance.service.end - PostDelete an ongoing service
maintenance.service.remove - PostChange an ongoing service's terms
maintenance.service.update - PostAdd a recurring maintenance task
maintenance.task.add - PostCheck off a maintenance task
maintenance.task.complete - PostOpen Tasks-app tasks for what's coming due
maintenance.task.open_due - PostDelete a maintenance task
maintenance.task.remove - PostPlan a day for a maintenance task
maintenance.task.schedule - PostSet the parts a maintenance task uses
maintenance.task.set_parts - PostSkip a maintenance task this time
maintenance.task.skip - PostTurn a maintenance task off
maintenance.task.turn_off - PostTurn a maintenance task back on
maintenance.task.turn_on - PostTake a maintenance task off the calendar
maintenance.task.unschedule - PostChange a maintenance task
maintenance.task.update - PostCancel a scheduled visit
maintenance.visit.cancel - PostRecord that a visit happened
maintenance.visit.complete - PostRecord a visit that already happened
maintenance.visit.record - PostDelete a visit recorded by mistake
maintenance.visit.remove - PostSchedule a contractor's visit
maintenance.visit.schedule - PostReschedule or change a visit
maintenance.visit.update - PostRecord an item's warranty
maintenance.warranty.add - PostDelete a warranty
maintenance.warranty.remove - PostChange a warranty
maintenance.warranty.update - GetWhere an item's facts came from
maintenance.asset.facts - GetEverything about one item
maintenance.asset.get - GetThe house's items
maintenance.asset.list - GetAsset categories and the fact keys to use
maintenance.category.list - GetOne contractor's details and history
maintenance.contractor.get - GetThe household's contractors
maintenance.contractor.list - GetOne problem with the house
maintenance.issue.get - GetProblems with the house
maintenance.issue.list - GetThe state of the house at a glance
maintenance.overview.get - GetOne project's whole workspace
maintenance.project.get - GetRepairs and improvements under way
maintenance.project.list - GetA property's profile and its places
maintenance.property.get - GetFind anything in the house records
maintenance.record.search - GetOne maintenance task in full
maintenance.task.get - GetMaintenance tasks, grouped by when they're due
maintenance.task.list - GetOne contractor visit
maintenance.visit.get - GetContractor visits, coming or done
maintenance.visit.list
Dashboard
Today at a glance, Rigel's cards on the home screen, and the pictures behind each app's icon.
- PostMake a new picture for a place
dashboard.app_picture.redo - PostSet the picture behind a place's icon
dashboard.app_picture.set - PostTake a card off the dashboard
dashboard.card.dismiss - PostPut a card on the dashboard
dashboard.card.post - GetWhat's on the dashboard for a day
dashboard.day.get