Skip to content
Treaty

dev.superpipeline.elicitation (embedded card)

An agent’s question as it rides inside the prose message under the dev.superpipeline.elicitation content key. Options may be empty and are at most four (a client draws four buttons); the prose lists every option. Answered by an ordinary reply naming an option’s number, id or label, never by reference. Readers ignore properties they do not know. x-uniqueBy lists paths whose values must not repeat (JSON Schema cannot say so): a[].b is field b of each item of list a.

How it rides

Section titled “How it rides”

A card inside the prose message’s content, under the content key dev.superpipeline.elicitation.

Who sends it, who reads it

Section titled “Who sends it, who reads it”

The carrier is whichever service carries the board’s chat: AgentPod’s hub, or SuperExchange for a board that has moved to it.

Fields

Section titled “Fields”
Field Type Required Description Constraints
schema_version integer yes at least 1
board_id string yes
card_id string yes
elicitation_id string yes at least 1 character
run_id string yes
stage_key string yes
card_title string yes
asked_by string yes
prompt string yes
options array of object yes at most 4 items
options[].id string yes at least 1 character
options[].label string yes
deep_link string no

x-uniqueBy: the values at these paths must not repeat, the one rule JSON Schema cannot state. a[].b is field b of each item of list a.

  • options[].id

Example

Section titled “Example”

From fixtures/matrix-events/examples.json, case “built: a question with two options”:

{
  "schema_version": 1,
  "board_id": "brd_7c1f",
  "card_id": "crd_51d0",
  "elicitation_id": "elc_7f3c",
  "run_id": "run_12",
  "stage_key": "build",
  "card_title": "Upgrade the build image",
  "asked_by": "agt_31d0",
  "prompt": "The tests need network access. May I run them?",
  "options": [
    {
      "id": "run_them",
      "label": "Run the tests"
    },
    {
      "id": "skip",
      "label": "Skip them"
    }
  ],
  "deep_link": "https://superpipeline.dev/b/brd_7c1f/c/crd_6b40"
}

Refused

Section titled “Refused”

Each of these must fail. The corpus says why:

  • five options: a client draws four buttons (refused by schema)
  • no elicitation_id: the question cannot be answered (refused by schema)
  • two options sharing an id (refused by unique)

Source

Section titled “Source”