Plan a day for a maintenance task
maintenance.task.schedule
POST/api/v1/households/{household_id}/commands/maintenance.task.schedule
- Command
- Rigel runs it
- Applies offline
Plans the day someone will do it and puts an all-day event on the household calendar. Scheduling doesn't check it off or change its due date. Planning again moves the event. Fails with task_off.
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 |
|---|---|
task_idstringrequired | The task to plan. |
scheduled_onstring (date)required | The day it will be done. |
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 | task_not_found | Rejects an unknown task. |
404 | not_found | The household doesn't exist, or you aren't a member of it. |
409 | task_off | Rejects a task that is turned off. |
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.
Plans a day without changing the due date
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2S' \
-d '{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}'const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAA2S",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
task_id: "mtk_01JC0000000000000000000001",
scheduled_on: "2025-11-15",
}),
});
const data = await response.json();POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2S
{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R04HT1E9P4CNZ94VJG
{
"result": {},
"version": 1
}Planning again moves the day
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2T' \
-d '{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-16"
}'const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAA2T",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
task_id: "mtk_01JC0000000000000000000001",
scheduled_on: "2025-11-16",
}),
});
const data = await response.json();POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2T
{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-16"
}HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R051VMZ1YC9XZ22GK5
{
"result": {},
"version": 1
}Rejects a task that is turned off
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2V' \
-d '{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}'const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAA2V",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
task_id: "mtk_01JC0000000000000000000001",
scheduled_on: "2025-11-15",
}),
});
const data = await response.json();POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2V
{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}HTTP/1.1 409 Conflict
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0FP7WJCJSYDGZWDF0
{
"error": {
"code": "task_off",
"message": "That task is turned off. No changes were applied.",
"details": {
"task_id": "mtk_01JC0000000000000000000001"
},
"recovery": "Read the current state, then send a command that fits it.",
"request_id": "req_01K9D9S2R0FP7WJCJSYDGZWDF0"
}
}Rejects an unknown task
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2W' \
-d '{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}'const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAA2W",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
task_id: "mtk_01JC0000000000000000000001",
scheduled_on: "2025-11-15",
}),
});
const data = await response.json();POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.task.schedule HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAA2W
{
"task_id": "mtk_01JC0000000000000000000001",
"scheduled_on": "2025-11-15"
}HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0DYBKG81W9F3GHWCF
{
"error": {
"code": "task_not_found",
"message": "That maintenance task isn't there any more. No changes were applied.",
"details": {
"task_id": "mtk_01JC0000000000000000000001"
},
"recovery": "Read the current state, then send a command that fits it.",
"request_id": "req_01K9D9S2R0DYBKG81W9F3GHWCF"
}
}Plan a day for a task
Puts an all-day event on the household calendar. It doesn't check the task off.
curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/maintenance.task.schedule' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01M6V9CSXMFMD29V3T8081SK8Z' \
-d '{
"task_id": "mtk_01M6V9CSX1RN5MWBHS4SJAK8F3",
"scheduled_on": "2026-11-08"
}'const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/maintenance.task.schedule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01M6V9CSXMFMD29V3T8081SK8Z",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
task_id: "mtk_01M6V9CSX1RN5MWBHS4SJAK8F3",
scheduled_on: "2026-11-08",
}),
});
const data = await response.json();POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/maintenance.task.schedule HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CSXMFMD29V3T8081SK8Z
{
"task_id": "mtk_01M6V9CSX1RN5MWBHS4SJAK8F3",
"scheduled_on": "2026-11-08"
}HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSXM3E2F6SDGKSMAH38P
{
"result": {},
"version": 203
}For Rigel#
Rigel's tool for this command is maintenance_task_schedule. Rigel runs this on its own, then says what it did. The agent guide has the rest.