api.md

Apps

Types:

from honcho.types import App

Methods:

• client.apps.create(**params) -> App
• client.apps.update(app_id, **params) -> App
• client.apps.get(app_id) -> App
• client.apps.get_by_name(name) -> App
• client.apps.get_or_create(name) -> App

Users

Types:

from honcho.types.apps import PageUser, User

Methods:

• client.apps.users.create(app_id, **params) -> User
• client.apps.users.update(user_id, *, app_id, **params) -> User
• client.apps.users.list(app_id, **params) -> SyncPage[User]
• client.apps.users.get(user_id, *, app_id) -> User
• client.apps.users.get_by_name(name, *, app_id) -> User
• client.apps.users.get_or_create(name, *, app_id) -> User

Metamessages

Methods:

• client.apps.users.metamessages.list(user_id, *, app_id, **params) -> SyncPage[Metamessage]

Sessions

Types:

from honcho.types.apps.users import (
    AgentChat,
    PageSession,
    Session,
    SessionDeleteResponse,
    SessionStreamResponse,
)

Methods:

• client.apps.users.sessions.create(user_id, *, app_id, **params) -> Session
• client.apps.users.sessions.update(session_id, *, app_id, user_id, **params) -> Session
• client.apps.users.sessions.list(user_id, *, app_id, **params) -> SyncPage[Session]
• client.apps.users.sessions.delete(session_id, *, app_id, user_id) -> object
• client.apps.users.sessions.chat(session_id, *, app_id, user_id, **params) -> AgentChat
• client.apps.users.sessions.clone(session_id, *, app_id, user_id, **params) -> Session
• client.apps.users.sessions.get(session_id, *, app_id, user_id) -> Session
• client.apps.users.sessions.stream(session_id, *, app_id, user_id, **params) -> object

Messages

Types:

from honcho.types.apps.users.sessions import Message, PageMessage, MessageBatchResponse

Methods:

• client.apps.users.sessions.messages.create(session_id, *, app_id, user_id, **params) -> Message
• client.apps.users.sessions.messages.update(message_id, *, app_id, user_id, session_id, **params) -> Message
• client.apps.users.sessions.messages.list(session_id, *, app_id, user_id, **params) -> SyncPage[Message]
• client.apps.users.sessions.messages.batch(session_id, *, app_id, user_id, **params) -> MessageBatchResponse
• client.apps.users.sessions.messages.get(message_id, *, app_id, user_id, session_id) -> Message

Metamessages

Types:

from honcho.types.apps.users.sessions import Metamessage, PageMetamessage

Methods:

• client.apps.users.sessions.metamessages.create(session_id, *, app_id, user_id, **params) -> Metamessage
• client.apps.users.sessions.metamessages.update(metamessage_id, *, app_id, user_id, session_id, **params) -> Metamessage
• client.apps.users.sessions.metamessages.list(session_id, *, app_id, user_id, **params) -> SyncPage[Metamessage]
• client.apps.users.sessions.metamessages.get(metamessage_id, *, app_id, user_id, session_id, **params) -> Metamessage

Collections

Types:

from honcho.types.apps.users import Collection, PageCollection, CollectionDeleteResponse

Methods:

• client.apps.users.collections.create(user_id, *, app_id, **params) -> Collection
• client.apps.users.collections.update(collection_id, *, app_id, user_id, **params) -> Collection
• client.apps.users.collections.list(user_id, *, app_id, **params) -> SyncPage[Collection]
• client.apps.users.collections.delete(collection_id, *, app_id, user_id) -> object
• client.apps.users.collections.get(collection_id, *, app_id, user_id) -> Collection
• client.apps.users.collections.get_by_name(name, *, app_id, user_id) -> Collection

Documents

Types:

from honcho.types.apps.users.collections import (
    Document,
    PageDocument,
    DocumentDeleteResponse,
    DocumentQueryResponse,
)

Methods:

• client.apps.users.collections.documents.create(collection_id, *, app_id, user_id, **params) -> Document
• client.apps.users.collections.documents.update(document_id, *, app_id, user_id, collection_id, **params) -> Document
• client.apps.users.collections.documents.list(collection_id, *, app_id, user_id, **params) -> SyncPage[Document]
• client.apps.users.collections.documents.delete(document_id, *, app_id, user_id, collection_id) -> object
• client.apps.users.collections.documents.get(document_id, *, app_id, user_id, collection_id) -> Document
• client.apps.users.collections.documents.query(collection_id, *, app_id, user_id, **params) -> DocumentQueryResponse