diff --git a/docs/images/app-screenshots/api-playground.png b/docs/images/app-screenshots/api-playground.png index 3a3c4c5f..d8d73811 100644 Binary files a/docs/images/app-screenshots/api-playground.png and b/docs/images/app-screenshots/api-playground.png differ diff --git a/docs/v2/documentation/reference/platform.mdx b/docs/v2/documentation/reference/platform.mdx index 3b01717a..e6575ec3 100644 --- a/docs/v2/documentation/reference/platform.mdx +++ b/docs/v2/documentation/reference/platform.mdx @@ -26,39 +26,31 @@ prompting you to create a new one. -Once you've created an organization, you'll be taken to the dashboard and see -the Welcome page with integration guidance and links to documentation. +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. Until you activate a subscription under the -[Billing](https://app.honcho.dev/billing) page, the infrastructure will remain -inactive. +workloads which activates when you add a payment method on the [Billing](https://app.honcho.dev/billing) page. ## 2. Activate your Honcho instance -Navigate to the [Billing](https://app.honcho.dev/billing) page to activate your subscription. Your Honcho instance provisions automatically, and you can monitor the deployment on the [Instance Status](https://app.honcho.dev/status) page until all systems show a green check mark. +When you have 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. Instance Status Page -You can also upgrade Honcho when new versions are made available directly from the status page. +If there is an upgrade available you will see an indicator like this:
Upgrade Honcho
- -The **Performance** page provides comprehensive monitoring with usage metrics, health analytics, API response times, and endpoint usage across Honcho. - - - Performance Analytics Dashboard - +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`. @@ -68,12 +60,48 @@ The [API Keys](https://app.honcho.dev/api-keys) page allows you to create and ma ## 4. Test with API Playground -The [API Playground](https://app.honcho.dev/playground) provides a Postman-like interface to test queries, explore endpoints, and validate your integration. Authenticate with an API key and send requests directly to your Honcho instance with real-time responses and full request/response logging. +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. 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](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. @@ -138,14 +166,27 @@ Here you can: Get Context -## 8. Webhooks Integration -The [Webhooks](https://app.honcho.dev/webhooks) page enables Webhook creation and management. +## 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](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. Webhooks Dashboard + + Create New Webhook + + +## 10. Organization Member Access -## 9. 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.