225 lines
11 KiB
Plaintext
225 lines
11 KiB
Plaintext
---
|
|
title: "The Honcho Dashboard"
|
|
icon: "rocket"
|
|
description: "Build socially intelligent agents without worrying about infrastructure"
|
|
sidebarTitle: "Dashboard Overview"
|
|
---
|
|
|
|
<Card title="Sign up to start using Honcho!" icon="rocket" href="https://app.honcho.dev">
|
|
Start using the platform to manage Honcho instances for your workspace or app.
|
|
</Card>
|
|
|
|
The quickest way to begin using Honcho in production is with the
|
|
[Honcho Cloud Platform](https://app.honcho.dev). Sign up, generate an API key,
|
|
and start building with Honcho.
|
|
|
|
## 1. Go to [app.honcho.dev](https://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.
|
|
|
|
<div style={{ maxWidth: "400px", margin: "0 auto" }}>
|
|
<Frame>
|
|
<img src="/images/app-screenshots/welcome-to-honcho.png" alt="Honcho Platform Dashboard" loading="lazy" decoding="async" fetchpriority="low" style={{ width: "100%", height: "auto" }} />
|
|
</Frame>
|
|
</div>
|
|
|
|
|
|
Once you've created an organization, you'll be taken to the welcome dashboard.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/get-started-copy.png" alt="Honcho Dashboard Getting Started" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
Each organization has dedicated infrastructure running to isolate your workloads.
|
|
Once you add a valid payment method under the
|
|
[Billing](https://app.honcho.dev/billing) page, your instance will turn on.
|
|
|
|
## 2. Activate your Honcho instance
|
|
|
|
With credits and a payment method on file (managed via the [Billing](https://app.honcho.dev/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](https://app.honcho.dev/status) page.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/status-page.png" alt="Instance Status Page" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
If there is an upgrade available you will see an indicator like this:
|
|
|
|
<div style={{ maxWidth: "700px", margin: "0 auto" }}>
|
|
<Frame>
|
|
<img src="/images/app-screenshots/upgrade-honcho.png" alt="Upgrade Honcho" loading="lazy" decoding="async" fetchpriority="low" style={{ width: "100%", height: "auto" }} />
|
|
</Frame>
|
|
</div>
|
|
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](https://app.honcho.dev/status) page and try to trigger a refresh of your machines.
|
|
|
|
## 3. Manage API Keys
|
|
The [API Keys](https://app.honcho.dev/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`.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/api-keys.png" alt="API Key Management Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 4. Test with API Playground
|
|
The [API Playground](https://app.honcho.dev/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.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/api-playground.png" alt="API Playground Interface" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
|
|
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](https://app.honcho.dev/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.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/explore-honcho.png" alt="Workspace Table" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
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.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/workspace-dash.png" alt="Workspace Dashboard Overview" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 6. Peer Dashboard & Utilities
|
|
Expand the `Peers` list from the `Workspace` dashboard to see a detailed view of `Peers`.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/peer-dash.png" alt="Peer Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
Click into any peer to navigate to their respective utilities page. Next to the `Peer` name you can edit the [Global Peer Configuration](/v2/documentation/core-concepts/configuration), and in the tabs below, explore all utilities for the `Peer`.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/peer-utilities.png" alt="Peer Management Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
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)
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/chat-endpoint.png" alt="Chat Endpoint" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
- **Session logs** view which `Sessions` the `Peer` is active
|
|
- **Peer configuration and metadata management** including [Session-Peer Configuration](/v2/documentation/core-concepts/configuration#session-peer-configuration)
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/peer-utilities.png" alt="Peer Management Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 7. Session Dashboard & Utilities
|
|
Click into the sessions view within a workspace to see a table of all of your `Sessions` data.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/session-dash.png" alt="Sessions Table" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
Click into a `Session` to open its utilities page.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/session-utilities.png" alt="Session Utilities" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
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
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/get-context.png" alt="Get Context" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 8. Performance Monitoring & Analytics
|
|
|
|
The **Performance** page offers comprehensive monitoring tools, including usage metrics, health analytics, API response times, and endpoint usage across Honcho.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/performance-analytics.png" alt="Performance Analytics Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 9. Webhooks Integration
|
|
|
|
The [Webhooks](https://app.honcho.dev/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.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/webhooks-page.png" alt="Webhooks Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
<Frame>
|
|
<img src="/images/app-screenshots/webhooks-create.png" alt="Create New Webhook" width="400" height="267" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## 10. Organization Member Access
|
|
|
|
The [Members](https://app.honcho.dev/members) page provides organization administration to manage your team's access to Honcho with the ability to grant admin permissions.
|
|
|
|
<Frame>
|
|
<img src="/images/app-screenshots/members-dashboard.png" alt="Members Dashboard" width="1200" height="800" loading="lazy" decoding="async" fetchpriority="low" />
|
|
</Frame>
|
|
|
|
## Go Further
|
|
|
|
View the [Architecture](/v2/documentation/core-concepts/architecture) to see how Honcho works under the hood.
|
|
|
|
Dive into our [API Reference](/v2/api-reference) to explore all available endpoints.
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Sign up to Honcho Platform" icon="rocket" href="https://app.honcho.dev">
|
|
Get started with managed Honcho instances
|
|
</Card>
|
|
<Card title="Join our Discord" icon="discord" href="http://discord.gg/plasticlabs">
|
|
Connect with 1000+ developers building with Honcho
|
|
</Card>
|
|
<Card title="Contribute to Honcho" icon="code" href="/v2/contributing/guidelines">
|
|
View our guidelines and explore the codebase
|
|
</Card>
|
|
<Card title="Explore Examples" icon="book" href="/v2/guides">
|
|
See Honcho in action with real examples
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
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 →](https://app.honcho.dev)*
|