Skip to main content
POST
/
v1
/
notes
/
update
Update a note
curl --request POST \
  --url https://api.linda.cedarai.com/v1/notes/update \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "content": "<string>",
  "note_id": "<string>",
  "references": [
    {
      "display_text": "<string>",
      "entity_id": "<string>",
      "entity_type": "<string>",
      "is_stale": true,
      "url": "<string>"
    }
  ],
  "update_references": true,
  "uploads": [
    {
      "file_name": "<string>",
      "media_type": "<string>",
      "size_bytes": "<string>"
    }
  ]
}
'
{
  "note": {
    "attachments": [
      {
        "attachment_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "file_name": "<string>",
        "media_type": "<string>",
        "note_id": "<string>",
        "size_bytes": "<string>",
        "url": "<string>"
      }
    ],
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by_name": "<string>",
    "created_by_uuid": "<string>",
    "entity_id": "<string>",
    "entity_type": "<string>",
    "note_id": "<string>",
    "references": [
      {
        "display_text": "<string>",
        "entity_id": "<string>",
        "entity_type": "<string>",
        "is_stale": true,
        "url": "<string>"
      }
    ],
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-arms-api-key
string
header
required
​
x-arms-assume-user
string
header
required

Headers

​
Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json
​
content
string

New markdown body. Replaces the prior content. May contain inline reference tokens like <<ref:equipment:54321:BNSF 54321>>. Whenever you change <<ref:...>> tokens in content, also send the new references array and set update_references=true so the sidecar rows stay in sync with the inline tokens.

​
note_id
string

ID of the note to edit (returned by CreateNote).

​
references
object[]

Replacement set of references. Only honored when update_references=true. Maximum 100 entries.

​
update_references
boolean

If true, the references array fully replaces the prior set. If false (the default), the existing references are left untouched — use this when only the prose changes and the <<ref:...>> tokens are the same as before.

​
uploads
object[]

Reserved for future inline upload support; currently a no-op.

Response

A successful response.

​
note
object

A single note in a thread. Threaded notes are anchored to an (entity_type, entity_id) pair and ordered by created_at.