Notes

Update Note

Changed on

Update a note (partial). Supports optimistic concurrency via If-Match.

patch/notes/{note_id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /notes/{note_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

note_idstring required

ID of the note.

Example:note_6968b398edb465624291e405

Headers

if-matchstring nullable

Expected note revision (the ETag value); the request fails with 412 if the note has changed.

Example:"3"

Request body

bodystring nullable

New text of the note, up to 4000 characters; may be omitted but not null.

confidence'observed' | 'suspected' | 'verified'

Author-supplied confidence in a note (matches the spec NoteConfidence enum).

related_execution_idstring nullable

ID of an execution the note relates to; null clears it.

source'agent' | 'human' | 'platform'

Origin tag for a note (matches the spec NoteSource enum).

type'auth_quirk' | 'usage_hint' | 'execution_feedback' | 'correction'

Category of a note (matches the spec NoteType enum).

Example request

{
  "body": "Stripe returns 401 unless the secret key is sent as a Bearer token; Basic auth with an empty password also works.",
  "confidence": "verified",
  "related_execution_id": "exec_6968b3982706c619fe73f0cf",
  "source": "agent",
  "type": "auth_quirk"
}

Response

Successful Response

unknown required

Changes