Skip to main content
POST
Propose a learning from an edit

Authorizations

X-API-Key
string
header
required

Body

application/json

Propose a learning from a person's own edit of one message the agent wrote.

request_id
string<uuid>
required

The client's key for this proposal: sent again (a double click, a retry), it answers what the first one did and calls no model.

subject
HandEditSubjectSchema · object
required

Where the edited words stand.

Response

The words are back as the agent wrote them: the learning proposed from an earlier edit is dismissed, and proposal is null.

What a thumbs down did.

action
enum<string>
required

added a learning, or updated one about the same thing.

Available options:
added,
updated,
split,
carried,
skipped,
seeded,
session,
deleted
agent_name
string
required

The agent that learned it.

event_id
string<uuid>
required

The thumbs down, for Undo.

learning
AgentLearningReadSchema · object | null
required

The learning as written; null on a replay whose learning was deleted since.

previous_text
string | null
required

What the updated learning said before; null for an added one.

redo
RedoReadSchema · object
required

How the redo a thumbs down asked for went.

subject_key
string
required

What the thumbs down was given on, as list_thumbs_downs takes it, so a screen that gave it elsewhere (the AI Assistant's card) can follow its note.

surface
enum<string>
required

Where it was given; hand_edit for a learning a person's own edit proposed, whose card dismisses it and keeps the edit.

Available options:
table_cells,
agent_preview,
task,
writing_preview,
reply_draft,
sent_message,
hand_edit,
simplified,
carried,
template,
hand
more
LearnedPartReadSchema · object[]

A table agent's other learnings it wrote, one for each other point the reason made, in order; empty when it made one. Always empty on an outbound message, whose changes proposal.changes lists. Undo takes them all back.

proposal
ProposalReadSchema · object | null

The feedback session it opened or refined: the changes it proposes, not saved yet; learning is null then. A further thumbs down on the same message, cells or Preview example refines it (the latest note wins). Null on a replay of a session saved or thrown away since.