v2

latestOpenAPI 3.1.02026-07-2664759910.6 KB

external

external-v2

Find Related Notes

Find notes semantically related to the current persisted content of a note. The source note is embedded at request time, so newly created or recently updated notes can be used before asynchronous indexing catches up. Candidate related notes still come from the note search index.

get/v2/notes/{note_id}/related-notes

Path parameters

note_idstring uuid required

UUID of the source note. The caller must be able to access this note.

Query parameters

limitinteger

Maximum number of related notes to return. Default is 10; valid range is 1 to 20.

Response

request_idstring required

Identifier for this API request. Useful for tracing and support.

totalinteger required

Number of related notes returned.

Example response

{
  "request_id": "api-request-018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
  "results": [
    {
      "collection_ids": [
        "59508b41-8770-4855-aa37-302b1e09aee7"
      ],
      "collections": [
        {
          "created_at": "2025-03-18T11:00:00Z",
          "description": "Planning documents and project notes.",
          "id": "59508b41-8770-4855-aa37-302b1e09aee7",
          "is_shared": false,
          "note_count": 8,
          "title": "Work Projects",
          "updated_at": "2025-04-22T16:12:34Z"
        }
      ],
      "created_at": "2025-03-18T11:00:00Z",
      "id": "018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
      "preview": "# Project Phoenix Planning\n\nLaunch goals and milestones.",
      "score": 0.91,
      "snippet": "Launch goals and milestones.",
      "title": "Project Phoenix Planning",
      "updated_at": "2025-04-22T16:12:34Z"
    }
  ],
  "total": 1
}