Skip to main content
POST
/
v1
/
notes
/
create
Create a note
curl --request POST \
  --url https://api.linda.cedarai.com/v1/notes/create \
  --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>",
  "entity_id": "<string>",
  "entity_type": "<string>",
  "references": [
    {
      "display_text": "<string>",
      "entity_id": "<string>",
      "entity_type": "<string>",
      "is_stale": true,
      "url": "<string>"
    }
  ],
  "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. Notes are isolated per carrier.

Body

application/json
​
content
string

Markdown body. Embed @-mentions as inline reference tokens of the form <<ref:{entity_type}:{entity_id}:{display_text}>> and pass a matching entry in references for each one.

Example:

"Held at <<ref:equipment:54321:BNSF 54321>> waiting on clearance."
​
entity_id
string

Entity ID as a string. UUID for shipment/work_order/etc., or a stringified int64 for equipment/waybill/invoice/charge.

​
entity_type
string

Entity type to attach the note to. Must be a registered type (e.g. shipment, equipment, waybill, work_order, invoice, charge).

​
references
object[]

Sidecar reference rows for every <<ref:...>> token in content. Used for reverse-lookup queries and stale-entity detection. Maximum 100 references per note. Use SearchReferences to look up the entity_type/entity_id/display_text triples to insert here.

Example for the content above:

[
  { "entity_type": "equipment", "entity_id": "54321",
    "display_text": "BNSF 54321" }
]
​
uploads
object[]

Reserved for future inline upload support; currently a no-op. Use UploadNoteAttachment after the note is created to attach files.

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.