Search the docs

Write and search Notes from an agent

Use a Profile key to record short lessons and retrieve them as untrusted context.

Use a Notes-capable Profile

A Profile key needs the notes capability. It can read and write notes only for its own Profile; it cannot name another Profile to cross that boundary. New Profiles include Notes. Use the same Bearer key format as other Takibi API calls.

Notes are temporary working memory. They do not grant new document access and should not replace Sources. Give a note a project tag when the lesson belongs to one client or project, so unrelated work does not get mixed together.

Append a structured note

Send POST /v1/notes with a template. problem is required. The other fields capture what was tried, what worked, what failed, what to do next, and any source IDs used:

{
  "projectTag": "support",
  "runId": "run-42",
  "template": {
    "problem": "Refund replies missed the policy exception",
    "tried": "Searched the policy folder",
    "worked": "Found the exception in the current policy",
    "failed": "The old canned reply omitted it",
    "next_time": "Check the policy date before replying",
    "source_ids_used": ["document-id"]
  }
}

A repeated request with the same run ID and note body returns the stored note. The API blocks obvious secrets instead of storing them and can redact shorter sensitive values. Keep credentials and private data out of notes in the first place.

Review, correct, and export with the CLI

The Takibi CLI covers Notes review. Use takibi notes list for the review queue, or takibi notes list --all --project support for held notes and current versions. With owner approval, run takibi notes keep <note-uuid> <version> to endorse or takibi notes remove <note-uuid> <version> to discard. A 409 means the version changed: list again before retrying.

Use takibi notes append --problem "…" --worked "…" --source <document-id> --run-id <run-id> for a debrief. The same run ID and body avoid duplicate appends on retry. Source IDs are citations; adding them does not resolve a dispute. Use takibi notes export --note <note-uuid> to include a selected note; repeat --note for several. Export stamps included notes and creates a draft for review, so ask before exporting unless it was already requested.

There is no in-place edit route. To correct a note, append one with the corrected facts and source IDs, then have the owner remove the old note. Keep does not extend the 30-day expiry.