Community

Blog

Honcho

Guides

API Reference

Get an App by Name

Args:
    app_name (str): The name of the app

Returns:
    schemas.App: App object

Get App By Name

Location

Message

Error Type

ValidationError

HTTPBearer

HTTPValidationError

Honcho is an open source platform for building personalized AI experiences.

Overview

🫡 Welcome to Honcho

Start building with Honcho in under 5 minutes

Quickstart

Learn the core primitives and the structure of Honcho

Architecture

Guidelines for contributing to the Honcho Project

Guidelines

Running a local version of the Honcho API Server

Self-Hosting

Self-Hosting Honcho

Deploying the Honcho API Server with Docker

Deploying

Deploying Honcho

License

Helpful guides and design patterns for building with Honcho

Spellbooks and Tutorials

Discord is a powerful chat application that handles many UI complications

Discord

Discord Bots with Honcho

Using Honcho with LangChain with drop-in primitives

LangChain

LangChain Integration 🦜⛓️

A simple example of how to store and derive facts about individual users

Simple Memory

An endpoint for easily reasoning about your users

Dialectic Endpoint

Introduction

Get an App by ID

Args:
    app_id (uuid.UUID): The ID of the app

Returns:
    schemas.App: App object

Get App

Update an App

Args:
    app_id (uuid.UUID): The ID of the app to update
    app (schemas.AppUpdate): The App object containing any new metadata

Returns:
    schemas.App: The App object of the updated App

Update App

Create an App

Args:
    app (schemas.AppCreate): The App object containing any metadata

Returns:
    schemas.App: Created App object

Create App

Get or Create an App

Args:
    app_name (str): The name of the app

Returns:
    schemas.App: App object

Get Or Create App

Get All Users for an App

Args:
    app_id (uuid.UUID): The ID of the app representing the client
    application using honcho

Returns:
    list[schemas.User]: List of User objects

Get Users

Create a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user (schemas.UserCreate): The User object containing any metadata

Returns:
    schemas.User: Created User object

Create User

Get a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user

Returns:
    schemas.User: User object

Get User By Name

Get User

Get or Create a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user

Returns:
    schemas.User: User object

Get Or Create User

Update a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    user (schemas.UserCreate): The User object containing any metadata

Returns:
    schemas.User: Updated User object

Update User

Get All Sessions for a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user

Returns:
    list[schemas.Session]: List of Session objects

Get Sessions

Create a Session for a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client
    application using honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user
    session (schemas.SessionCreate): The Session object containing any
    metadata

Returns:
    schemas.Session: The Session object of the new Session

Create Session

Get a specific session for a user by ID

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user
    session_id (uuid.UUID): The ID of the Session to retrieve

Returns:
    schemas.Session: The Session object of the requested Session

Raises:
    HTTPException: If the session is not found

Get Session

Update the metadata of a Session

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user
    session_id (uuid.UUID): The ID of the Session to update
    session (schemas.SessionUpdate): The Session object containing any new metadata

Returns:
    schemas.Session: The Session object of the updated Session

Update Session

Delete a session by marking it as inactive

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user
    session_id (uuid.UUID): The ID of the Session to delete

Returns:
    dict: A message indicating that the session was deleted

Raises:
    HTTPException: If the session is not found

Delete Session

Get Chat

Get Chat Stream

Get all messages for a session

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    session_id (int): The ID of the Session to retrieve
    reverse (bool): Whether to reverse the order of the messages

Returns:
    list[schemas.Message]: List of Message objects

Raises:
    HTTPException: If the session is not found

Get Messages

Adds a message to a session

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    session_id (int): The ID of the Session to add the message to
    message (schemas.MessageCreate): The Message object to add containing the
    message content and type

Returns:
    schemas.Message: The Message object of the added message

Raises:
    HTTPException: If the session is not found

Create Message For Session

Get Message

Update Message

Get all messages for a session

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    session_id (int): The ID of the Session to retrieve
    reverse (bool): Whether to reverse the order of the metamessages

Returns:
    list[schemas.Message]: List of Message objects

Raises:
    HTTPException: If the session is not found

Get Metamessages

Adds a metamessage to a session

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    session_id (int): The ID of the Session to add the metamessage to
    metamessage (schemas.MetamessageCreate): The Metamessage object to add containing the
    metamessage content and type

Returns:
    schemas.Metamessage: The Metamessage object of the added metamessage

Raises:
    HTTPException: If the session is not found

Create Metamessage

Get a specific Metamessage by ID

Args:
    app_id (uuid.UUID): The ID of the app representing the client application using
    honcho
    user_id (str): The User ID representing the user, managed by the user
    session_id (int): The ID of the Session to retrieve

Returns:
    schemas.Session: The Session object of the requested Session

Raises:
    HTTPException: If the session is not found

Get Metamessage

Update Metamessage

Get All Collections for a User

Args:
    app_id (uuid.UUID): The ID of the app representing the client
    application using honcho
    user_id (uuid.UUID): The User ID representing the user, managed by the user

Returns:
    list[schemas.Collection]: List of Collection objects

API Documentation

apps

users

sessions

messages

collections

documents

Get App By Name

Authorizations

Path Parameters

Response