api.md

Apps

Types:

• App

Methods:

• client.apps.create({ ...params }) -> App
• client.apps.update(appId, { ...params }) -> App
• client.apps.get(appId) -> App
• client.apps.getByName(name) -> App
• client.apps.getOrCreate(name) -> App

Users

Types:

• PageUser
• User

Methods:

• client.apps.users.create(appId, { ...params }) -> User
• client.apps.users.update(appId, userId, { ...params }) -> User
• client.apps.users.list(appId, { ...params }) -> UsersPage
• client.apps.users.get(appId, userId) -> User
• client.apps.users.getByName(appId, name) -> User
• client.apps.users.getOrCreate(appId, name) -> User

Metamessages

Methods:

• client.apps.users.metamessages.list(appId, userId, { ...params }) -> MetamessagesPage

Sessions

Types:

• AgentChat
• PageSession
• Session
• SessionDeleteResponse
• SessionStreamResponse

Methods:

• client.apps.users.sessions.create(appId, userId, { ...params }) -> Session
• client.apps.users.sessions.update(appId, userId, sessionId, { ...params }) -> Session
• client.apps.users.sessions.list(appId, userId, { ...params }) -> SessionsPage
• client.apps.users.sessions.delete(appId, userId, sessionId) -> unknown
• client.apps.users.sessions.chat(appId, userId, sessionId, { ...params }) -> AgentChat
• client.apps.users.sessions.clone(appId, userId, sessionId, { ...params }) -> Session
• client.apps.users.sessions.get(appId, userId, sessionId) -> Session
• client.apps.users.sessions.stream(appId, userId, sessionId, { ...params }) -> unknown

Messages

Types:

• Message
• PageMessage
• MessageBatchResponse

Methods:

• client.apps.users.sessions.messages.create(appId, userId, sessionId, { ...params }) -> Message
• client.apps.users.sessions.messages.update(appId, userId, sessionId, messageId, { ...params }) -> Message
• client.apps.users.sessions.messages.list(appId, userId, sessionId, { ...params }) -> MessagesPage
• client.apps.users.sessions.messages.batch(appId, userId, sessionId, { ...params }) -> MessageBatchResponse
• client.apps.users.sessions.messages.get(appId, userId, sessionId, messageId) -> Message

Metamessages

Types:

• Metamessage
• PageMetamessage

Methods:

• client.apps.users.sessions.metamessages.create(appId, userId, sessionId, { ...params }) -> Metamessage
• client.apps.users.sessions.metamessages.update(appId, userId, sessionId, metamessageId, { ...params }) -> Metamessage
• client.apps.users.sessions.metamessages.list(appId, userId, sessionId, { ...params }) -> MetamessagesPage
• client.apps.users.sessions.metamessages.get(appId, userId, sessionId, metamessageId, { ...params }) -> Metamessage

Collections

Types:

• Collection
• PageCollection
• CollectionDeleteResponse

Methods:

• client.apps.users.collections.create(appId, userId, { ...params }) -> Collection
• client.apps.users.collections.update(appId, userId, collectionId, { ...params }) -> Collection
• client.apps.users.collections.list(appId, userId, { ...params }) -> CollectionsPage
• client.apps.users.collections.delete(appId, userId, collectionId) -> unknown
• client.apps.users.collections.get(appId, userId, collectionId) -> Collection
• client.apps.users.collections.getByName(appId, userId, name) -> Collection

Documents

Types:

• Document
• PageDocument
• DocumentDeleteResponse
• DocumentQueryResponse

Methods:

• client.apps.users.collections.documents.create(appId, userId, collectionId, { ...params }) -> Document
• client.apps.users.collections.documents.update(appId, userId, collectionId, documentId, { ...params }) -> Document
• client.apps.users.collections.documents.list(appId, userId, collectionId, { ...params }) -> DocumentsPage
• client.apps.users.collections.documents.delete(appId, userId, collectionId, documentId) -> unknown
• client.apps.users.collections.documents.get(appId, userId, collectionId, documentId) -> Document
• client.apps.users.collections.documents.query(appId, userId, collectionId, { ...params }) -> DocumentQueryResponse