Getting Started

This guide will walk you through the essential first steps to set up your environment, register your extension, and make your first authenticated request to the DreamNet API.

Prerequisites

Before you begin, ensure you have a basic understanding of:

• Interacting with APIs.

• Core concepts of webhooks and blockchain if you plan to use those features.

Registration & Credentials

First, you must register your extension through the developer portal to receive the necessary credentials. There are three registration paths depending on your project's needs.

• For Custom UIs Only ("Frontend Only") If you are only building a custom user interface, register using your full GitHub profile URL. You will receive an App ID and a Secret.

• For Webhook-Based Triggers Only ("Chat Triggers") If your project only listens to conversation events via a webhook, register your public webhook URL. You will receive a Secret.

• For Custom UIs with Webhook Triggers ("Triggers & Frontend") If your project includes both a custom UI and a webhook, register your public webhook URL. You will receive an App ID, App ID, and a Secret.

Upon successful registration, the portal will display your unique App ID and App Secret.

Authenticating Your API Requests

All requests to our protected API endpoints must be authenticated. You must include the following headers in every request:

Content-Type: application/json
x-mini-app-id: <your-app-id>
x-mini-app-secret: <your-app-secret>

Failure to include these headers will result in an unauthorized access error. For a full list of available endpoints, please see our API Endpoint Reference.