api.md

Shared

Types:

• Blob
• Callout
• Chunk
• Code
• Comment
• Company
• Conversation
• Deal
• Divider
• Document
• Equation
• Event
• File
• Footnote
• Heading
• Image
• LineBreak
• Link
• List
• ListItem
• Message
• Metadata
• Paragraph
• Person
• Provenance
• ProvenanceEntity
• ProvenanceSource
• ProvenanceStep
• QueryResult
• Quote
• ScoredDocumentResponse
• Table
• TableCell
• TableRow
• Task
• Text
• ToDo
• ToolCall
• ToolResult
• Trace
• TraceMessage
• Transcript
• Utterance
• Website

Connections

Types:

• ConnectionListResponse
• ConnectionRevokeResponse

Methods:

• client.connections.revoke(connectionID) -> ConnectionRevokeResponse
• client.connections.list() -> ConnectionListResponse

Folders

Types:

• FolderListResponse
• FolderDeletePolicyResponse
• FolderListPoliciesResponse
• FolderSetPoliciesResponse

Methods:

• client.folders.list(connectionID, { ...params }) -> FolderListResponse
• client.folders.listPolicies(connectionID) -> FolderListPoliciesResponse
• client.folders.setPolicies(connectionID, { ...params }) -> FolderSetPoliciesResponse
• client.folders.deletePolicy(policyID, { ...params }) -> FolderDeletePolicyResponse

Integrations

Types:

• IntegrationListResponse
• IntegrationConnectResponse

Methods:

• client.integrations.list() -> IntegrationListResponse
• client.integrations.connect(integrationID, { ...params }) -> IntegrationConnectResponse

GoogleCalendar

Types:

• Calendar

Methods:

• client.integrations.googleCalendar.list() -> Calendar

WebCrawler

Types:

• WebCrawlerIndexResponse

Methods:

• client.integrations.webCrawler.index({ ...params }) -> WebCrawlerIndexResponse

Slack

Types:

• SlackListResponse

Methods:

• client.integrations.slack.list({ ...params }) -> unknown

Memories

Types:

• MemoryStatus
• MemoryListResponse
• MemoryDeleteResponse
• MemoryAddBulkResponse
• MemoryGetResponse
• MemoryStatusResponse

Methods:

• client.memories.add({ ...params }) -> MemoryStatus
• client.memories.addBulk({ ...params }) -> MemoryAddBulkResponse
• client.memories.upload({ ...params }) -> MemoryStatus
• client.memories.update(resourceID, { ...params }) -> MemoryStatus
• client.memories.list({ ...params }) -> MemoryListResponsesCursorPage
• client.memories.status() -> MemoryStatusResponse
• client.memories.get(resourceID, { ...params }) -> MemoryGetResponse
• client.memories.search({ ...params }) -> QueryResult
• client.memories.delete(resourceID, { ...params }) -> MemoryDeleteResponse

Evaluate

Types:

• EvaluateListQueriesResponse
• EvaluateScoreHighlightResponse
• EvaluateScoreQueryResponse

Methods:

• client.evaluate.listQueries({ ...params }) -> EvaluateListQueriesResponsesCursorPage
• client.evaluate.getQuery(queryID) -> QueryResult
• client.evaluate.scoreQuery(queryID, { ...params }) -> EvaluateScoreQueryResponse
• client.evaluate.scoreHighlight(highlightID, { ...params }) -> EvaluateScoreHighlightResponse

Actions

Types:

• ActionAddReactionResponse
• ActionSendMessageResponse

Methods:

• client.actions.sendMessage({ ...params }) -> ActionSendMessageResponse
• client.actions.addReaction({ ...params }) -> ActionAddReactionResponse

Sessions

Methods:

• client.sessions.add({ ...params }) -> MemoryStatus

Vaults

Types:

• VaultListResponse

Methods:

• client.vaults.list({ ...params }) -> VaultListResponsesCursorPage

Auth

Types:

• Token
• AuthDeleteUserResponse
• AuthMeResponse

Methods:

• client.auth.userToken({ ...params }) -> Token
• client.auth.me() -> AuthMeResponse
• client.auth.deleteUser() -> AuthDeleteUserResponse