Make a topic

chat.conversation.create

POST/api/v1/households/{household_id}/commands/chat.conversation.create

Command
Rigel runs it
Applies offline

Makes a new topic: a separate named conversation, such as "Summer trip". Everyone in the household can read and write in it.

Parameters#

Make a topic: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Make a topic: request body fields
Field	Description
`title`stringrequired	A topic's title, as written, 1–80 characters: "Summer trip". at most 80 characters

Response#

200 The command was applied.

Make a topic: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`result.conversation_id`stringrequired	The new topic.
`version`integerrequired	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.

Make a topic: errors
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`	`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.

Makes an open topic with the title as written

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/chat.conversation.create' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "title": "  Summer trip!  "
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/chat.conversation.create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    title: "  Summer trip!  ",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/chat.conversation.create HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "title": "  Summer trip!  "
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0Z2RSQM2WRCX98QCM

{
  "result": {
    "conversation_id": "cnv_01JC4N0000MBGE5RJ6Q7V6V6T8"
  },
  "version": 1
}

Start a topic

A topic is a separate named conversation everyone in the household can read and write in.

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/chat.conversation.create' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01M6V9CSNXA888M7R6M4C21T9X' \
  -d '{
  "title": "Summer trip"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/chat.conversation.create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01M6V9CSNXA888M7R6M4C21T9X",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    title: "Summer trip",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/chat.conversation.create HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CSNXA888M7R6M4C21T9X

{
  "title": "Summer trip"
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSNXGMDC41TYRXG3RK8P

{
  "result": {
    "conversation_id": "cnv_01M6V9CSNXY07QQP2MFR78VN9K"
  },
  "version": 117
}

For Rigel#

Rigel's tool for this command is chat_conversation_create. Rigel runs this on its own, then says what it did. The agent guide has the rest.