Getting Started
Welcome. This guide will take you from a fresh account to a working Yedric assistant embedded in your app. Plan for about 20 to 30 minutes for your first setup, less once you have done it before.
By the end you will have an assistant configured with your instructions, your content loaded into the knowledge base, and the widget live in your app so your users can start getting answers right away.
What is an assistant?
An assistant is your configured AI helper for a specific app. Each app you add Yedric to gets its own assistant. It holds your instructions, your knowledge base, your tools, and your widget settings. Together, those things define how it behaves for your users.
Step 1: Sign in
Go to https://app.yedric.ai and sign in.
Most users sign in with their Google account. If your organization uses a different login setup, use your company credentials instead. Check with your admin if you are not sure which applies to you.
Once you are in, you will land on the Assistants screen.
Step 2: Create a new assistant
On the Assistants screen, click New Assistant.
Name: Give your assistant a name that reflects the app it is going into. This is for your reference and will not be visible to your users. Once done, click Create Assistant.
Next, you'll be directed to the Prompt section of your new assistant where you can select the model and create instructions.
Model: Select the AI model you want to power this assistant. New assistants start on a small, fast default model that works without any API key of your own, which makes it a good starting point and easy to change later. The models available in this dropdown depend on which provider keys your organization has set up. If the model you want is not showing up, add the matching provider key under Organizations first. The model roster changes often, so trust the dropdown over any list written down elsewhere.
Instructions: This is pre-filled with a starter prompt to get you going. You can edit it now or come back to it after the assistant is created. More on this in Step 3.
You can duplicate an existing assistant at any time from the assistant list if you want to use one as a starting point for a new one. You can also export an assistant's full configuration as a JSON file and import it elsewhere, which is useful for backups or moving a setup between environments.
Step 3: Write your system prompt
Click the Instructions tab. This is where you give the assistant its instructions.
The system prompt is the first thing the assistant reads before every conversation, so it shapes how it responds, what it focuses on, and how it talks to your users.
A few things to cover in your system prompt:
What the assistant is for and what app it lives in
What it can and cannot help with
Any tone or communication preferences
Any context that helps it give accurate answers
The default prompt Yedric pre-fills is a reasonable starting point, but you should update it to reflect your specific app and use case. The more context you give the assistant, the more useful it will be for your users.
Click Save Changes when you are done.
For a deeper look at what makes a good system prompt, including autocomplete, suggested prompts from the Dashboard, and common pitfalls, see Instructions.
Step 4: Add to your knowledge base
Click the Knowledge tab.
This is where you load in the content the assistant should reference when answering questions. You can add content in several ways:
Add Website: Enter a domain and Yedric will crawl it automatically. Website documents are re-scraped weekly to stay current.
Upload Files: Upload PDF, Word (.docx), or plain text (.txt) files directly.
Write it Yourself: Write or paste content directly into a text editor.
The knowledge base has a built-in search tool that the assistant uses automatically. You do not need to configure anything for it to work.
For more on how to structure your content, keep it current, and understand when knowledge base search kicks in, see Knowledge Base.
Step 5: Set up Page Prompts
Click the Page Prompts tab.
Page Prompts let you control what the assistant shows on different pages of your app. Instead of showing the same suggestions everywhere, you can tailor them to match what a user is likely to need based on where they are.
For example, a user on your dashboard might see setup-focused suggestions, while a user on an orders page sees prompts about recent shipments.
To create a page prompt:
Click New Page Prompt
Enter a URL pattern for the page you want this page prompt to apply to. Leave it blank to use this as the default for any page not covered by another page prompt.
Add suggestions. Each one has a label (what the user sees on the button) and a prompt (what gets sent to the assistant when they click it).
Optionally add custom instructions that override your system prompt for this specific page.
For more detail on how page prompts work, see the Page Prompts documentation.
Step 6: Customize your widget
Click the Widget tab.
This is where you control how the assistant looks inside your app. You can adjust the theme, colors, font, greeting message, suggestion style, position, and whether the widget opens by default.
Make your changes and preview them in real time. When you are happy with how it looks, move to the Install tab to get your embed code.
The Build character tab on the same page generates a custom mascot for the widget with AI, from a description or from your own logo. It is optional, and you can come back to it any time. See Build a Character.
Step 7: Embed and preview
From the Install tab, copy the embed snippet. It looks like this:
Share this with your developer, or paste it yourself if you have access to your app's codebase. They will add it wherever you want the widget to appear. No other dependencies are required.
Once it is in place, open your app and the Yedric widget should appear. Click it to open the assistant and send a test message.
About the Dashboard
After you have set up your assistant and conversations start coming in, the Dashboard tab gives you an overview of how it is performing. When you first create an assistant, it shows a setup checklist so you can track your progress through the steps above.
Once conversations are coming in, the Dashboard shows how your assistant is performing and a ranked list of recommended actions, such as improvements to your instructions and gaps in your knowledge base.
You can apply instruction suggestions without leaving the Dashboard. See Dashboard for what each figure means.
Conversation volume and trends over time
Sentiment breakdown (positive, neutral, negative)
Common topics users are raising
AI-generated suggestions for improving your instructions
AI-generated suggestions for filling gaps in your knowledge base
Feature requests and pain points surfaced from real conversations
Last updated