> ## Documentation Index > Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt > Use this file to discover all available pages before exploring further. # Propose a learning from an edit > Propose a learning from a person's own edit of one message the agent wrote: a Tasks card's words, a follow-up or Builder message not sent yet, one contact's own words for a step in the Builder, or a reply draft. The edit is already kept (each place saves its own words); this reads the words before and after on the server and proposes what the agent should do differently, with the notes of any proposal waiting on the message, which it replaces. Nothing is written again. It is saved only by the page's yes (Approve, Looks good or sending the reply, or `POST /agent-learnings/thumbs-downs/{event_id}/commit/`), sharpened by a further note (`POST /agent-learnings/thumbs-downs/` with the same `hand_edit` subject), and dropped by Discard feedback (`POST /agent-learnings/thumbs-downs/{event_id}/revert/`), which keeps the edit. Words back as the agent wrote them, or changed only in spacing, call no model: a learning proposed from an earlier edit is dismissed and answered with 200, otherwise it is refused. Sent again with the same `request_id`, it answers what the first one did. Only a signed-in person can, never an API key. ## OpenAPI ````yaml /openapi.json post /agent-learnings/hand-edits/ openapi: 3.1.0 info: contact: email: support@getoneprofile.ai name: Oneprofile Support description: >- REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started. termsOfService: https://www.getoneprofile.ai/terms title: API Reference | Oneprofile version: '0.0' servers: - url: https://api.getoneprofile.ai security: [] tags: - description: >- The docked AI Assistant: its general chat about the workspace and the product, streamed as Server-Sent Events, and the one list of a person's threads across every assistant, with pin, rename, delete and the search-to-table link. name: assistant - description: >- The messages a person keeps to send the assistant again: the ones the workspace saved and the ones that ship with the product, with save, rename, edit and delete. name: assistant-prompt - description: >- Granted workspace actions: what the AI Assistant proposed or applied in a conversation, the approve and dismiss decisions on each card, the workspace's spend threshold and default grants, and the eight verbs. name: workspace-actions - description: >- The Getting started checklist: a workspace's progress through the six steps from its first people search to its first launched sequence. name: onboarding - description: Senders, connected mailboxes, tags, and the Google connect flow. name: senders - description: The workspace do-not-contact list, enforced before every send. name: suppression - description: >- The workspace's recontact rule: how long before anyone hears from us again. name: contact_cooldown - description: 'Sequence authoring: the graph, the table-backed audience, previews.' name: sequences - description: >- The outbound agent behind a sequence: the voice it writes in, its per-message prompts, what it wrote and what people told it. name: outbound-agents - description: >- The LinkedIn channel: connecting an account to a sender, its safety limits and history, and the protocol the browser extension speaks. name: linkedin - description: >- The approval queue: everything waiting on a person across every sender and channel, and the workspace's manual or automatic modes per channel. name: outreach - description: 'The unified outreach inbox: threads, replies, labels, events.' name: inbox - description: 'The AI reply layer: workspace settings, drafts, and approval.' name: inbox-ai - description: Notification rules, per-user preferences, and the Slack connection. name: notifications - description: Endpoints for seeing all available integration types. name: integration-types - description: Endpoints for listing, checking and deleting integrations. name: integrations - description: >- Create, preview and update an integration of any type: the body's integration_type picks the config and credentials it takes. name: integration-specific - description: Endpoints for the generic OAuth install/claim app-listings engine. name: app-listings - description: Endpoints for creating and managing API keys. name: apikey - description: >- AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any other MCP client a person signed in to Oneprofile's MCP server with. name: ai_apps - description: Endpoints for managing billing and subscription information. name: billing - description: >- Accounts: every company the workspace's tables name, with the people at it, its key facts, its tables, its org chart and what went to its people; the tables that feed it (Sources) and the merges a person made. name: accounts - description: Endpoints for creating and managing tables. name: tables - description: Endpoints for table columns, formula previews, and on-demand column runs. name: table-columns - description: Endpoints for table rows and manual cell edits. name: table-rows - description: Endpoints for observing and cancelling table recompute runs. name: table-runs - description: >- Endpoints for org-shared per-column display preferences: hidden, pinned, width, and colour tint. name: table-ui-prefs - description: >- Endpoints for the org-shared names given to the column tint palette: what this organisation calls each colour. Org-level, not per-table. name: table-column-color-labels - description: >- Endpoints for the enrichment action catalog, model list, presets, draft generation, and saved agents. name: table-enrichments - description: >- Endpoints for an agent's Preview: example rows run one at a time, and a Looks good on each. Needs work lives under agent-learnings. name: agent-training - description: >- An agent's learnings, the one-line rules it follows on every output, and the thumbs down that teaches them: give one with what was wrong, list the ones on a subject, Undo one, and price the redo it would run. name: agent-learnings - description: >- The durable audit trail of a table's enrichment actions: configured, edited, run, cancelled, and settled cost. name: table-enrichment-audit-logs - description: Endpoints for saving and applying column templates. name: table-templates - description: Server-sent change feed for a table's grid. name: table-events - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.' name: table-views - description: >- Endpoints for PER-USER table preferences: favourites and recently opened. Unlike the rest of the table surface these are personal, so two members of one organisation legitimately see different answers. name: table-user-prefs - description: >- Endpoints for building a table from an uploaded CSV: upload and preview the inferred columns, commit the reviewed mapping, then poll the row load. name: table-imports - description: Endpoint for downloading a table's rows as CSV. name: table-export - description: >- Endpoints for the integration a table imports from: attach and preview it, promote imported fields into columns, and run the import on demand. name: table-sources - description: >- Endpoints for a table's recurring import cadence: set it, pause it, and read the next fire times. name: table-schedules - description: >- Endpoints for pushing a table's rows out to a connected integration: list writable destinations, derive their write capabilities, and map export columns. name: table-writeback - description: >- Endpoints backing a lookup column's setup: the connections whose records a column could read, and the identity fields one record type can be looked up by. name: table-integration-lookup - description: >- Endpoints for sourcing leads from the lead database: count and preview matches, land them in a table, and keep saved searches. Alongside people and company searches, leads can be sourced from buying signals (what a company or person just did), with a catalogue endpoint behind the picker that builds them. name: find-leads - description: >- Endpoints for discovering a domain's subdomains from public certificate logs and landing the results in a table. name: find-subdomains - description: Endpoints for the credit balance meter and usage reporting. name: credits - description: >- Endpoints for the workspace referral program: the shareable link, the friends who joined through it, and claiming a code after signup. name: referral - description: >- Endpoints for the affiliate program's own dashboard: enrolling and claiming a code, the summary, stats and activity feed, the commission ledger, and identity verification and payouts. name: affiliate - description: >- Endpoints for recording where a new workspace came from: the marketing page or campaign its signup link carried, sent once after signup. name: attribution - description: >- Endpoints for the design partner program's customer surface: whether this workspace is a design partner, the badges its feedback has earned, and sending and reading that feedback. name: design-partner - description: >- Endpoints for the org-level AI business context (company description, ideal customer profile, buyer personas, interest signals and social proof), plus domain-based generation and the reference documents whose summaries ride alongside those fields. name: ai-context - description: >- Endpoints for the signed-in user's Google Drive connection: starting and finishing the OAuth grant, checking or dropping it, and minting the short-lived token the Google Picker needs. name: google-drive paths: /agent-learnings/hand-edits/: post: tags: - agent-learnings summary: Propose a learning from an edit description: >- Propose a learning from a person's own edit of one message the agent wrote: a Tasks card's words, a follow-up or Builder message not sent yet, one contact's own words for a step in the Builder, or a reply draft. The edit is already kept (each place saves its own words); this reads the words before and after on the server and proposes what the agent should do differently, with the notes of any proposal waiting on the message, which it replaces. Nothing is written again. It is saved only by the page's yes (Approve, Looks good or sending the reply, or `POST /agent-learnings/thumbs-downs/{event_id}/commit/`), sharpened by a further note (`POST /agent-learnings/thumbs-downs/` with the same `hand_edit` subject), and dropped by Discard feedback (`POST /agent-learnings/thumbs-downs/{event_id}/revert/`), which keeps the edit. Words back as the agent wrote them, or changed only in spacing, call no model: a learning proposed from an earlier edit is dismissed and answered with 200, otherwise it is refused. Sent again with the same `request_id`, it answers what the first one did. Only a signed-in person can, never an API key. operationId: propose_learning_from_edit requestBody: content: application/json: schema: $ref: '#/components/schemas/HandEditCreateSchema' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThumbsDownReadSchema' description: >- The words are back as the agent wrote them: the learning proposed from an earlier edit is dismissed, and `proposal` is null. '201': content: application/json: schema: $ref: '#/components/schemas/ThumbsDownReadSchema' description: Successful Response '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' description: The words you edited no longer exist. '409': description: >- Nothing to learn: the words match the agent's or a learning you dismissed, the learner found nothing, the words can't teach here (a decided task, a sent message), they were edited again meanwhile, the workspace learned from 200 edits today, the message was edited 10 times with its learning still waiting, or its feedback session holds 20 notes already; the sentence says which. '422': content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' description: Invalid request made to the API. '500': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Internal server error. '502': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Bad gateway error. '503': description: >- The agent could not read the edit right now (its model, or today's count of learning from edits, is out of reach). The edit is kept, and so is any learning waiting on it; try again shortly. security: - APIKeyHeader: [] - HTTPBearer: [] components: schemas: HandEditCreateSchema: description: >- Propose a learning from a person's own edit of one message the agent wrote. properties: request_id: description: >- 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. format: uuid title: Request Id type: string subject: $ref: '#/components/schemas/HandEditSubjectSchema' description: Where the edited words stand. required: - subject - request_id title: HandEditCreateSchema type: object ThumbsDownReadSchema: description: What a thumbs down did. properties: action: $ref: '#/components/schemas/LearningAction' description: '`added` a learning, or `updated` one about the same thing.' agent_name: description: The agent that learned it. title: Agent Name type: string event_id: description: The thumbs down, for Undo. format: uuid title: Event Id type: string learning: anyOf: - $ref: '#/components/schemas/AgentLearningReadSchema' - type: 'null' description: >- The learning as written; null on a replay whose learning was deleted since. more: description: >- 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. items: $ref: '#/components/schemas/LearnedPartReadSchema' title: More type: array previous_text: anyOf: - type: string - type: 'null' description: What the updated learning said before; null for an added one. title: Previous Text proposal: anyOf: - $ref: '#/components/schemas/ProposalReadSchema' - type: 'null' description: >- 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. redo: $ref: '#/components/schemas/RedoReadSchema' subject_key: description: >- 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. title: Subject Key type: string surface: $ref: '#/components/schemas/LearningSource' description: >- Where it was given; `hand_edit` for a learning a person's own edit proposed, whose card dismisses it and keeps the edit. required: - event_id - action - learning - previous_text - agent_name - redo - subject_key - surface title: ThumbsDownReadSchema type: object UnauthorizedResponse: properties: detail: description: The detail of why the request is unauthorized. title: Detail type: string required: - detail title: UnauthorizedResponse type: object ForbiddenResponse: properties: detail: description: The detail of why the request is forbidden. title: Detail type: string required: - detail title: ForbiddenResponse type: object NotFoundResponse: properties: detail: description: The detail of why the resource was not found. title: Detail type: string required: - detail title: NotFoundResponse type: object UnprocessableEntityResponse: properties: detail: description: >- The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message. title: Detail type: string issues: description: >- The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message. items: $ref: '#/components/schemas/UnprocessableEntityIssue' title: Issues type: array required: - detail - issues title: UnprocessableEntityResponse type: object ServerErrorResponse: properties: detail: description: The detail of why the server returned an error. title: Detail type: string required: - detail title: ServerErrorResponse type: object HandEditSubjectSchema: description: >- A person's own edit of one message the agent wrote, by where the words stand. properties: kind: const: hand_edit title: Kind type: string target: discriminator: mapping: message: '#/components/schemas/MessageTargetSchema' override: '#/components/schemas/OverrideTargetSchema' reply_draft: '#/components/schemas/ReplyDraftTargetSchema' task: '#/components/schemas/TaskTargetSchema' propertyName: target_kind oneOf: - $ref: '#/components/schemas/TaskTargetSchema' - $ref: '#/components/schemas/MessageTargetSchema' - $ref: '#/components/schemas/OverrideTargetSchema' - $ref: '#/components/schemas/ReplyDraftTargetSchema' title: Target required: - kind - target title: HandEditSubjectSchema type: object LearningAction: description: What one event did to an agent's learnings. enum: - added - updated - split - carried - skipped - seeded - session - deleted title: LearningAction type: string AgentLearningReadSchema: description: 'One learning: a one-line rule the agent follows on every output.' properties: all_sequences: default: false description: Whether every sequence's writer follows it, rather than one agent. title: All Sequences type: boolean batch_id: anyOf: - format: uuid type: string - type: 'null' description: >- The release that wrote it, for a learning split from a long prompt (`simplified`) or carried over from old feedback (`carried`): undoing that event (POST /agent-learnings/thumbs-downs/{event_id}/revert/ with this id) is Put back the original prompt. Null for a learning a thumbs down taught. title: Batch Id created_at: format: date-time title: Created At type: string created_by_user_id: anyOf: - type: string - type: 'null' description: Who taught it, or null for a release. title: Created By User Id id: format: uuid title: Id type: string last_event_id: anyOf: - format: uuid type: string - type: 'null' description: >- The latest thumbs down that wrote it, for Undo (POST /agent-learnings/thumbs-downs/{event_id}/revert/); null when none did or the learning was only read. title: Last Event Id note: anyOf: - type: string - type: 'null' description: >- What the person said in the thumbs down that last wrote it (`last_event_id`), every note of a refined one joined, one per line; null when no thumbs down did, and once its feedback session closed: a saved, discarded or undone session keeps none of the person's notes. title: Note note_surface: anyOf: - $ref: '#/components/schemas/LearningSource' - type: 'null' description: >- Where the thumbs down that last wrote it (`last_event_id`) was given, which `note` and `source_text` come from; it can differ from `source` once a later thumbs down on another surface changed it. Null when no thumbs down did. noted_at: anyOf: - format: date-time type: string - type: 'null' description: When that thumbs down was given; null when no thumbs down wrote it. title: Noted At notes: description: >- The same notes one by one, oldest first, each whole: the thumbs down's own, then each further note in its session. Empty when no thumbs down wrote it, and once its feedback session closed. items: type: string title: Notes type: array repeats: default: 0 description: >- How often a later Needs work asked for it again, as it stood, once saved; 0 when none did. title: Repeats type: integer source: $ref: '#/components/schemas/LearningSource' description: >- Where it was taught: the surface whose thumbs down added it, `simplified` when a long prompt was split into a goal and learnings, `carried` when old feedback was carried over. source_text: anyOf: - type: string - type: 'null' description: >- The message that thumbs down was given on, as it read then; null when none was kept (a table agent's, or a learning a release wrote). title: Source Text step_key: anyOf: - type: string - type: 'null' description: >- The one step of the sequence it holds for, by the step's agent prompt slot; null when it holds for every message the agent writes. title: Step Key step_label: anyOf: - type: string - type: 'null' description: >- That step as the sequence names it now, e.g. "Step 2 · Follow up"; null when it holds for every message, or the step is gone. title: Step Label text: description: The rule, one line. title: Text type: string updated_at: format: date-time title: Updated At type: string required: - id - text - source - created_at - updated_at - created_by_user_id - last_event_id - batch_id title: AgentLearningReadSchema type: object LearnedPartReadSchema: description: >- One more learning a thumbs down wrote, for another point its reason made. properties: action: $ref: '#/components/schemas/LearningAction' description: '`added` a learning, or `updated` one about the same thing.' learning_id: anyOf: - format: uuid type: string - type: 'null' description: The learning; null once it was deleted. title: Learning Id previous_text: anyOf: - type: string - type: 'null' description: What the updated learning said before; null for an added one. title: Previous Text text: anyOf: - type: string - type: 'null' description: The learning as the thumbs down wrote it. title: Text required: - action - learning_id - text - previous_text title: LearnedPartReadSchema type: object ProposalReadSchema: description: >- What a feedback session will learn, before a person saves it. Saved by Save (POST .../save/), by approving the rewritten task or reply, or by Looks good on the rewritten Preview contact, the cells or the Preview example; thrown away by Undo, a rejection or a discard. A table agent's changes are its own, at `sequence` scope. `changes` lists every change; the fields beside it describe the first add or rewrite. properties: auto_rewrites: description: >- How many messages written ahead (Tasks cards, messages waiting to send on their own, and waiting reply drafts) were written again once it was saved. title: Auto Rewrites type: integer changes: description: Every change it makes to the learnings, in the learner's order. items: $ref: '#/components/schemas/ProposedChangeReadSchema' title: Changes type: array learn_detail: anyOf: - type: string - type: 'null' description: Why it failed, said on the card; null when ok. title: Learn Detail learn_state: $ref: '#/components/schemas/LearnState' description: >- `ok`, or `failed` when the learner could not work out what to learn from the last note: nothing new is learned until Retry, and the changes before it stand. moved_from_text: anyOf: - type: string - type: 'null' description: >- Once saved for every sequence: this sequence's learning it took the place of, which Undo puts back. title: Moved From Text points: description: >- What the notes ask for, as its learner read them; each change names its own. Empty once the session closed: they go with its notes. items: $ref: '#/components/schemas/ProposalPointReadSchema' title: Points type: array replaces_scope: anyOf: - $ref: '#/components/schemas/ProposedScope' - type: 'null' description: >- Whose learning the first change rewrites: this sequence's, or every sequence's. A rewrite of every sequence's learning kept at `sequence` scope saves a new learning for this sequence instead (Replaces in this sequence). replaces_text: anyOf: - type: string - type: 'null' description: >- The saved learning the first change rewrites, as it read when proposed (Replaces: ...); null when it adds one. title: Replaces Text rev: description: 'The revision of `changes`: it moves on every refine or edit of them.' title: Rev type: integer saved_learning_id: anyOf: - format: uuid type: string - type: 'null' description: >- The learning the first change saved, once saved; null while it waits or once thrown away. title: Saved Learning Id scope: $ref: '#/components/schemas/ProposedScope' description: >- The first change's scope. `sequence`: this sequence only (the default). `account`: every sequence's writer, its emails, LinkedIn messages and replies. text: description: The first change's learning as it would be saved, one line. title: Text type: string required: - changes - rev - text - scope - replaces_text - replaces_scope - saved_learning_id - moved_from_text - auto_rewrites - points - learn_state - learn_detail title: ProposalReadSchema type: object RedoReadSchema: description: How the redo a thumbs down asked for went. properties: detail: anyOf: - type: string - type: 'null' description: Why it was refused, as the screen shows it. title: Detail state: $ref: '#/components/schemas/RedoState' description: >- `none` where nothing is redone (a sent message), `started` while it runs, `written` once the new output is there, `refused` when it could not run. required: - state - detail title: RedoReadSchema type: object LearningSource: description: >- Where a learning came from: the surface a thumbs down was given on, or a release pass. Also the ``surface`` of the event that wrote it. enum: - table_cells - agent_preview - task - writing_preview - reply_draft - sent_message - hand_edit - simplified - carried - template - hand title: LearningSource type: string UnprocessableEntityIssue: properties: input: anyOf: - type: string - type: integer - type: number - type: boolean - items: {} type: array - additionalProperties: true type: object description: The user's input that caused the error. title: Input loc: description: >- The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present. items: type: string title: Loc type: array msg: description: The message of the error. The error message to show to the user. title: Msg type: string type: description: >- The type of the error. Useful for frontend code to handle different types of errors. title: Type type: string required: - loc - msg - type - input title: UnprocessableEntityIssue type: object MessageTargetSchema: description: >- One message the agent wrote that has not gone out: a follow-up, or a Builder message. properties: message_id: format: uuid title: Message Id type: string target_kind: const: message title: Target Kind type: string required: - target_kind - message_id title: MessageTargetSchema type: object OverrideTargetSchema: description: >- One contact's own words for one step, saved over the agent's sample in the Builder. properties: record_id: format: uuid title: Record Id type: string sequence_id: format: uuid title: Sequence Id type: string step_id: format: uuid title: Step Id type: string target_kind: const: override title: Target Kind type: string required: - target_kind - sequence_id - step_id - record_id title: OverrideTargetSchema type: object ReplyDraftTargetSchema: description: A reply draft on the Inbox ribbon, its words edited in the composer. properties: draft_id: format: uuid title: Draft Id type: string target_kind: const: reply_draft title: Target Kind type: string required: - target_kind - draft_id title: ReplyDraftTargetSchema type: object TaskTargetSchema: description: A Tasks card's words, and the agent's message they were written from. properties: outbound_message_id: format: uuid title: Outbound Message Id type: string target_kind: const: task title: Target Kind type: string task_id: format: uuid title: Task Id type: string required: - target_kind - task_id - outbound_message_id title: TaskTargetSchema type: object ProposedChangeReadSchema: description: >- One change a feedback session makes: a learning, an instruction, the link or a fact. properties: find: anyOf: - type: string - type: 'null' description: An instruction edit's words it replaces. title: Find history: description: How it read before later notes rewrote it, oldest first. items: $ref: '#/components/schemas/ChangeVersionReadSchema' title: History type: array id: description: 'Stable within its session: `c1`, `c2`...' title: Id type: string kind: $ref: '#/components/schemas/ChangeKind' description: >- `add` a learning, `update` (rewrite) one, `delete` one, or `keep` one that already says what a point asks (nothing is written); `instruction`: edit a step's or the reply's instruction (`find` becomes `replace_with`); `link`: the sequence's call-to-action link becomes `text`; `fact`: keep `question` and its answer `text` in the business Q&A. note: description: >- The note of the session (`thread[].number`) that last made or rewrote it; 0 for one made before notes were threaded. title: Note type: integer 'off': description: >- A person left it out: the page's yes saves every change still on, never this one. title: 'Off' type: boolean outcome: anyOf: - $ref: '#/components/schemas/ChangeOutcome' - type: 'null' description: >- Null while it waits. Once saved: `applied`, `skipped_full` (its list was full) or `skipped_changed` (what it changes was edited meanwhile); an instruction, link or fact is `pending` until written, a moment after the save. Once undone: `undo_pending`, then `undone`, or `left` when it was changed since. points: description: The numbers of the points it learns (`points`). items: type: integer title: Points type: array question: anyOf: - type: string - type: 'null' description: A fact's question. title: Question replace_with: anyOf: - type: string - type: 'null' description: What an instruction edit puts in their place; empty removes them. title: Replace With replaces_scope: anyOf: - $ref: '#/components/schemas/ProposedScope' - type: 'null' description: 'Whose learning it rewrites: this sequence''s, or every sequence''s.' replaces_text: anyOf: - type: string - type: 'null' description: >- The saved learning it rewrites or deletes, as it read when proposed; null for an add. title: Replaces Text saved_learning_id: anyOf: - format: uuid type: string - type: 'null' description: >- The learning it saved, once applied; null for a delete or while it waits. title: Saved Learning Id scope: $ref: '#/components/schemas/ProposedScope' description: >- `sequence`: this sequence only. `account`: every sequence's writer. For a delete, whose learning goes. step_label: anyOf: - type: string - type: 'null' description: >- An instruction edit's step, e.g. "Step 2 · Follow up", or "Replies"; for an add or an update, the one step the learning holds for, null for every message. title: Step Label text: anyOf: - type: string - type: 'null' description: >- The learning as it would read; a link change's new link; a fact's answer. Null for a delete, a keep or an instruction edit. title: Text words: description: >- How many words its learning has (a learning aims at 5 to 10); 0 for a change with no learning. title: Words type: integer required: - id - kind - text - step_label - find - replace_with - question - scope - replaces_text - replaces_scope - outcome - saved_learning_id - points - note - 'off' - history - words title: ProposedChangeReadSchema type: object LearnState: description: Whether a session's learner turned its notes into changes (F3, F5). enum: - ok - failed title: LearnState type: string ProposalPointReadSchema: description: One thing a feedback session's notes ask for, as its learner read them. properties: covered: description: Whether a change learns it. title: Covered type: boolean goes_to: $ref: '#/components/schemas/PointGoesTo' description: >- Where it belongs: `rule` (a learning), `this_message` (only this message: the rewrite follows it, nothing is kept), `instruction` (a step's or the reply's instruction), `link` (the sequence's call-to-action link), `fact` (the business Q&A), `sender` (a sender's own setting, changed on Senders) or `research` (the sequence's research settings). `sender` and `research` are never written. note: description: The note it is in, from 1, oldest first (see `notes`). title: Note type: integer number: description: 'From 1, across every note: what a change''s `points` name.' title: Number type: integer quote: description: >- The note's own words for it; empty when the learner's quote was not found. title: Quote type: string reason: anyOf: - type: string - type: 'null' description: Why it is not learned (it names this contact, say); null when it is. title: Reason said: description: The point in a few words. title: Said type: string required: - number - note - quote - said - covered - reason - goes_to title: ProposalPointReadSchema type: object ProposedScope: description: Which writers a proposed learning reaches once saved. enum: - sequence - account title: ProposedScope type: string RedoState: description: How the redo a thumbs down asked for went. enum: - none - started - written - refused title: RedoState type: string ChangeVersionReadSchema: description: How a session's change read before a later note rewrote it. properties: find: anyOf: - type: string - type: 'null' description: An instruction edit's words it replaced. title: Find note: description: The note that made this version. title: Note type: integer replace_with: anyOf: - type: string - type: 'null' description: What the instruction edit put in their place. title: Replace With text: anyOf: - type: string - type: 'null' description: The learning, link or fact's answer as it read. title: Text required: - note - text - find - replace_with title: ChangeVersionReadSchema type: object ChangeKind: description: What one change of a feedback session does to the learnings (F2). enum: - add - update - delete - keep - instruction - link - fact title: ChangeKind type: string ChangeOutcome: description: What saving a session did with one of its changes (F2). enum: - applied - skipped_full - skipped_changed - pending - undo_pending - undone - left - left_out title: ChangeOutcome type: string PointGoesTo: description: Where one point of a session's notes belongs (F7). enum: - rule - this_message - instruction - link - fact - sender - research - pending title: PointGoesTo type: string securitySchemes: APIKeyHeader: in: header name: X-API-Key type: apiKey HTTPBearer: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.