Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cedarai LindaService API

The LindaService API from Cedarai — 9 operation(s) for lindaservice.

Cedarai LindaService API is one of 9 APIs that Cedarai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include LindaService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version version not set.

Requests are made against 2 base URLs: https://api-lg-k-h1.arms.cedarai.com, https://api-lg-k-h1.arms.cedarai.se.

9 operations 9 paths 27 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
version not set
Base URL
https://api-lg.arms.cedarai.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Cedarai LindaService API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-arms-api-key (ApiKeyAuth). An API key is passed in the header as x-arms-assume-user (AssumeUserAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

LindaService 9
POST
/v1/notes/search-references
Search referenceable entities for mentions
SearchReferences 1 param body → 200default
POST
/v1/notes/batch-get-summaries
Batch get note summaries
BatchGetNoteSummaries 1 param body → 200default
POST
/v1/notes/list
List notes
ListNotes 1 param body → 200default
POST
/v1/notes/delete
Delete a note
DeleteNote 1 param body → 200default
POST
/v1/notes/search
Search notes (full-text)
SearchNotes 1 param body → 200default
POST
/v1/notes/get-summary
Get note summary for one entity
GetNoteSummary 1 param body → 200default
POST
/v1/notes/create
Create a note
CreateNote 1 param body → 200default
POST
/v1/notes/update
Update a note
UpdateNote 1 param body → 200default
POST
/v1/notes/summarize-entity
AI summary of a note thread
SummarizeEntityNotes 1 param body → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are lindaNoteEntry (10 properties), lindaSearchNoteResult (7 properties), lindaNoteAttachment (7 properties), lindaListNotesReq (6 properties). Each schema is shown below with its type and property counts.

lindaSummarizeEntityNotesReq
object
2 properties
lindaReferenceSearchResultEntry
object
One match from SearchReferences. The fields map directly onto a NoteReference: copy entitytype, entityid, and displaytext when building a request to CreateNote…
6 properties
lindaNoteAttachmentUpload
object
Metadata describing a file the client intends to attach. Currently reserved for future inline-upload support on CreateNote/UpdateNote; for now, attach files vi…
3 properties
lindaCreateNoteResp
object
1 property
lindaBatchGetNoteSummariesReq
object
1 property
lindaListNotesResp
object
2 properties
lindaSearchNotesReq
object
4 properties
lindaSearchNotesResp
object
3 properties
lindaNoteSummaryEntry
object
One row of summary data for a single entity, returned by GetNoteSummary and BatchGetNoteSummaries. Designed for list-page badges and counters.
4 properties
lindaListNotesReq
object
6 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
lindaSearchNoteResult
object
One match returned from SearchNotes.
7 properties
lindaNoteReference
object
A structured reference to another Cedar entity from inside a note. References are how @-mentions persist: each chip in the editor becomes both an inline token…
5 properties
lindaNoteAttachment
object
A file attached to a note. Attachments are stored in S3 and surfaced to clients via short-lived presigned download URLs.
7 properties
lindaUpdateNoteReq
object
5 properties
lindaDeleteNoteReq
object
1 property
lindaBatchGetNoteSummariesResp
object
1 property
lindaEntityRef
object
A lightweight (entitytype, entityid) pair used by BatchGetNoteSummaries to fetch summaries for many entities at once. Example: { "entitytype": "shipment", "ent…
2 properties
lindaSummarizeEntityNotesResp
object
2 properties
lindaCreateNoteReq
object
5 properties
lindaGetNoteSummaryResp
object
1 property
lindaSearchReferencesReq
object
Request for the @-mention typeahead. Searches across configured entity types in parallel and returns the top N matches per type. Use the result fields to const…
3 properties
lindaNoteEntry
object
A single note in a thread. Threaded notes are anchored to an (entitytype, entityid) pair and ordered by createdat.
10 properties
lindaUpdateNoteResp
object
1 property
lindaSearchReferencesResp
object
1 property
lindaGetNoteSummaryReq
object
2 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cedarai-lindaservice-api-openapi.yml Raw ↑

Other APIs Cedarai publishes across the network.

Cedarai ChargeService API
Cedarai Equipment History API
Cedarai Ims API
Cedarai InvoicesService API
Cedarai NetworkStructureService API
Cedarai QuotesService API
Cedarai TruckLoadTenderService API
Cedarai WorkOrderService API