Change what a note says
family.note.revise
POST/api/v1/households/{household_id}/commands/family.note.revise
- Command
- Rigel runs it
- Applies offline
Rewrites a note because the information changed or was wrong. Its noted_at becomes now.
Parameters#
| Field | Description |
|---|---|
household_idpathstringrequired | The household's ID. |
Idempotency-Keyheaderstringoptional | The command's ID. Reuse it when retrying the same command. |
Request body#
JSON, as application/json.
| Field | Description |
|---|---|
note_idstringrequired | A family note ID, such as fnt_01JC0000000000000000000000. |
textstringrequired | The note, as written, 1–1,000 characters, standing on its own: "Doesn't like carrots". |
Response#
200 The command was applied.
| Field | Description |
|---|---|
resultobjectrequired | What the command returned, such as the IDs it created. |
versionintegerrequired | The household version after the command. |
Errors#
Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.
| Status | Code | When |
|---|---|---|
400 | validation_failed | A field is missing, misspelled or out of range. details.fields lists each problem. |
401 | unauthenticated | The request has no valid session. |
404 | note_not_found | A note that isn't there. |
404 | not_found | The household doesn't exist, or you aren't a member of it. |
409 | idempotency_key_reused | The Idempotency-Key was already used for a different command. |
Examples#
These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.
Revised text is new information, so noted_at moves
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
-d '{
"note_id": "fnt_01JC000000000000000000000C",
"text": "Eats eggs (as of Nov 2026)"
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
note_id: "fnt_01JC000000000000000000000C",
text: "Eats eggs (as of Nov 2026)",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA
{
"note_id": "fnt_01JC000000000000000000000C",
"text": "Eats eggs (as of Nov 2026)"
}Response, 200
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0AD7M7NDA220038RX
{
"result": {},
"version": 1
}A note that isn't there
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
-d '{
"note_id": "fnt_01JC000000000000000000000C",
"text": "x"
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
note_id: "fnt_01JC000000000000000000000C",
text: "x",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/family.note.revise HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA
{
"note_id": "fnt_01JC000000000000000000000C",
"text": "x"
}Response, 404
HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0AHPFXRKXKG46A7D2
{
"error": {
"code": "note_not_found",
"message": "That note isn't there any more. No changes were applied.",
"details": {
"note_id": "fnt_01JC000000000000000000000C"
},
"recovery": "Read the current state, then send a command that fits it.",
"request_id": "req_01K9D9S2R0AHPFXRKXKG46A7D2"
}
}Change what a note says
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.revise' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01M6V9CS7P0XR81SRY1RDSE2YX' \
-d '{
"note_id": "fnt_01M6V9CS7E9NAJKGNWG7KBC8P4",
"text": "Theo isn'\''t into spicy food lately. Mild chili is fine."
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.revise", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01M6V9CS7P0XR81SRY1RDSE2YX",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
note_id: "fnt_01M6V9CS7E9NAJKGNWG7KBC8P4",
text: "Theo isn't into spicy food lately. Mild chili is fine.",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/family.note.revise HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CS7P0XR81SRY1RDSE2YX
{
"note_id": "fnt_01M6V9CS7E9NAJKGNWG7KBC8P4",
"text": "Theo isn't into spicy food lately. Mild chili is fine."
}Response, 200
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CS7P6GKTM61TK7RTHDTG
{
"result": {},
"version": 10
}For Rigel#
Rigel's tool for this command is family_note_revise. Rigel runs this on its own, then says what it did. The agent guide has the rest.