Skip to main content
POST
/
v1
/
notes
/
search
Search notes (full-text)
curl --request POST \
  --url https://api.linda.cedarai.com/v1/notes/search \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "entity_type": "<string>",
  "page_size": 123,
  "page_token": "<string>",
  "query": "<string>"
}
'
{
  "next_page_token": "<string>",
  "results": [
    {
      "content_snippet": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_name": "<string>",
      "entity_id": "<string>",
      "entity_type": "<string>",
      "note_id": "<string>",
      "score": 123
    }
  ],
  "total_count": 123
}

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
​
entity_type
string

Restrict results to one entity type (e.g. shipment). Empty string searches all entity types for the carrier.

​
page_size
integer<int32>

Page size for cursor pagination. Defaults to 20 if unset or zero.

​
page_token
string

Opaque cursor from a previous response's next_page_token.

​
query
string

Free-text query. Tokenized via Postgres plainto_tsquery('english', ...). Entity reference chips and #group(content) hashtag syntax are normalized server-side so chip text and automation-written hashtag content are searchable as plain words. Empty query returns an empty result set.

Response

A successful response.

​
next_page_token
string

Opaque cursor for the next page. Empty when there are no more results. Pass back as page_token on the next request.

​
results
object[]

Matching notes ordered by score descending.

​
total_count
integer<int32>

Total matching notes across all pages — useful for displaying "showing X of Y results" labels.