Skip to main content

Sign up to start using Honcho!

Start using the platform to manage Honcho instances for your workspace or app.
The quickest way to begin using Honcho in production is with the Honcho Cloud Platform. Sign up, generate an API key, and start building with Honcho.

1. Go to app.honcho.dev

Create an account to start using Honcho. If a teammate already uses Honcho, ask them to invite you to their organization. Otherwise, you’ll see a banner prompting you to create a new one.
Honcho Platform Dashboard
Once you’ve created an organization, you’ll be taken to the welcome dashboard.
Honcho Dashboard Getting Started
Each organization has dedicated infrastructure running to isolate your workloads. Once you add a valid payment method under the Billing page, your instance will turn on.

2. Activate your Honcho instance

With credits and a payment method on file (managed via the Billing page), your Honcho instance will be provisioned and ready to use. Monitor your machine status, and check for version upgrades on the Instance Status page.
Instance Status Page
If there is an upgrade available you will see an indicator like this:
Upgrade Honcho
Upgrading your machines may take a few minutes and you can monitor progress. If for any reason your machine goes offline, you will see a red status indicator. Navigate to the Instance Status page and try to trigger a refresh of your machines.

3. Manage API Keys

The API Keys page allows you to create and manage authentication tokens for different environments. You can create admin-level keys with full instance access or scope keys to specific Workspaces, Peers, or Sessions.
API Key Management Dashboard

4. Test with API Playground

The API Playground provides a developer-friendly interface to quickly iterate and test queries, explore endpoints, and validate your integration directly from your browser—no code required.
API Playground Interface
The playground automatically loads all available API endpoints to match your Honcho instance version. Endpoints can be filtered by category at the top of the list. If you prefer, you can set up your queries in the UI and copy to cURL for help with building scripts or general terminal use.

Step-by-Step:

1. Select an Endpoint: Choose your desired endpoint from the available list. 2. Choose Path Parameters: For fields like Workspace, Session, or Peer, select options from dropdown menus—no need to manually enter IDs. 3. Add Request Body Data: Complete any required fields for POST/PUT requests. 4. Execute or Copy Request: Run it directly or copy as cURL to use elsewhere (just add your API key).

Example Usage

Build a complete conversation flow without ever leaving the playground:
  1. Create a Workspace: select POST Get or Create Workspace and type workspace name into the request body → Returns workspace ID
  2. Create new Peer(s): select POST Get or Create Peer, choose your workspace from the dropdown, and type peer name into the request body. (repeat for each peer) → Returns peer ID
  3. POST Get or Create Session POST /sessions selecting your workspace from the dropdown then type session name into the request body → Returns session ID and adds to dropdown
  4. POST Create Messages for Session POST /messages selecting your workspace & session from the dropdown then type peer id(s) and message content into the request body → Adds message(s) to the session

5. Workspaces

The Explore page provides comprehensive Workspace management where you can create workspaces and begin exploring the platform. Each Workspace serves as a container for organizing your Honcho data.
Workspace Table
Click into any workspace to access a general overview of Peers and Sessions. Here you can quickly create Peers, Sessions, and add multiple Peers to any Session. Edit the metadata and configuration for a Workspace with the Edit Config button. Click into any entity to navigate to their respective utilities pages or click the expand icon to view Workspace-wide Peers and Sessions data tables with more details.
Workspace Dashboard Overview

6. Peer Dashboard & Utilities

Expand the Peers list from the Workspace dashboard to see a detailed view of Peers.
Peer Dashboard
Click into any peer to navigate to their respective utilities page. Next to the Peer name you can edit the Global Peer Configuration, and in the tabs below, explore all utilities for the Peer.
Peer Management Dashboard
Utilities include:
  • Message search across all sessions for a Peer
  • Dialectic Chat to query Peer representations globally or session-scoped (results vary dependant on the Peer’s configuration)
Chat Endpoint
  • Session logs view which Sessions the Peer is active
  • Peer configuration and metadata management including Session-Peer Configuration
Peer Management Dashboard

7. Session Dashboard & Utilities

Click into the sessions view within a workspace to see a table of all of your Sessions data.
Sessions Table
Click into a Session to open its utilities page.
Session Utilities
Here you can:
  • View and add Messages within the Session; filter messages by Peer
  • Advanced search across Session messages
  • Peer management for adding/removing Peers and editing a Peer’s Session-level configuration
  • Get Context to generate LLM-ready context with customizable token limits
Get Context

8. Performance Monitoring & Analytics

The Performance page offers comprehensive monitoring tools, including usage metrics, health analytics, API response times, and endpoint usage across Honcho.
Performance Analytics Dashboard

9. Webhooks Integration

The Webhooks page allows managing and creation of webhooks for Honcho. React to events in real-time—such as message delivery, session updates, peer state changes, and more—by sending event payloads via HTTP POST requests to your provided endpoints.
Webhooks Dashboard
Create New Webhook

10. Organization Member Access

The Members page provides organization administration to manage your team’s access to Honcho with the ability to grant admin permissions.
Members Dashboard

Go Further

View the Architecture to see how Honcho works under the hood. Dive into our API Reference to explore all available endpoints.

Next Steps

We’re excited to see what you’ll build with Honcho Platform. Let’s create smarter, more personalized AI experiences together!
Ready to build personally aligned AI? Get started with Honcho →