Skip to main content

Integration Overview

This page is the roadmap for building your first feature with Asgard. This site (the SDK Demo) focuses on the frontend @asgard-js/react usage; "how to build a bot, design its conversation logic, and obtain credentials" lives on the platform side, documented in the Asgard developer docs. Below we connect the whole path, pointing to the right page at each step.

In one sentence

First build and publish your bot as a Bot Provider in Odin (get the endpoint and credentials) → then wire it into your frontend with @asgard-js/react from this site.

The full development journey

1. Understand the concepts, pick an integration pattern

Decide how your app connects to Asgard first — it affects every later step:

PatternBest forDocs
Direct ConnectFrontend talks to the Bot Provider directly; fastest to shipDirect Connect
Backend RelayRelay through your own backend, hide keys, add business logicBackend Relay
Hosted EmbedEmbed the official iframe directly, no frontend codeHosted Embed

Further reading: Integration intro. The demos on this site default to Direct Connect.

2. Build a bot in Odin and publish it as a Bot Provider

This is where developers most often get stuck — the botProviderEndpoint your frontend needs comes from here. In Odin Studio:

  1. Create a Project and Workflow, and design the conversation logic (HTTP calls, SQL queries, knowledge-base retrieval…).

  2. Publish it as a Bot Provider and obtain the endpoint and credentials:

    https://api.asgard-ai.com/ns/{namespace}/bot-provider/{botProviderId}

Hands-on tutorials:

3. Wire it into your frontend with @asgard-js/react

Once you have the endpoint, come back to this site:

4. Design messages and how replies render

Bot replies are delivered as message templates, which the frontend renders:

5. Authentication and private bots

If your bot requires authentication:

Next steps