Developer

Product guidance, in your UI or ours.

Build with Assist API in your own agent, or install Frigade Assistant with its UI included. Both use what Frigade learns by exploring your product.

Get Started

Assist API

Add Frigade as a tool in a new or existing agent. You keep your model and interface; Frigade provides product answers and on-page guidance.

Build with the API

Assistant

Use our assistant UI, then connect your tools and user context. Control when it opens, how it looks, and how it works with your application.

Use Frigade Assistant

Headless integration

Build Frigade's guidance into your own agent.

Pass the user's goal and conversation to the Assist API. Frigade can start an on-page guide or return an answer or clarification for your agent to handle.

Explore the Assist API

index.html

<script src="https://app.frigade.com/cdn/frigade-assistant.min.js"></script>
<script>
  window.FrigadeAssistAPI({
    apiKey: 'YOUR_PUBLIC_API_KEY',
    apiUrl: 'https://api.frigade.ai',
    assistantId: 'YOUR_ASSISTANT_ID',
    userId: 'SIGNED_IN_USER_ID',
  });
</script>

guide.ts

const query = window.FrigadeAssistAPI?.query;
if (!query) throw new Error('Frigade is still loading.');

const result = await query({
  intent: 'Help me export a workspace report',
  messages: conversation.messages,
});

// showMessage renders in your application's UI.
switch (result.status) {
  case 'started': showMessage('Follow the highlighted steps.'); break;
  case 'answer': showMessage(result.answer); break;
  case 'needs_clarification': showMessage(result.question); break;
  case 'unavailable':
  case 'error': showMessage('Please try another way.'); break;
}

tools.ts

// In your browser handler for a frigade_guide call:
// toolCall = { toolName: 'frigade_guide', input: { intent } }
const handle = window.FrigadeAssistAPI?.handleToolCall;
if (!handle) throw new Error('Frigade is still loading.');

const result = await handle(toolCall, {
  messages: conversation.messages,
});

if (result) {
  // Send result back to your agent as the tool output.
}

Pass the conversation

Send the person's goal and message history so Frigade has the context for the requested workflow.

Handle the result

Respond to a started guide, answer, or clarification. Handle unavailable and error results in your own UI.

Connect your agent's tools

Frigade Assistant

Start with the UI included.

Give people an assistant that answers questions and guides them through your product. Use the ready-made interface, then connect your tools and control its behavior from your application.

Example answer in Frigade Assistant.

Make the assistant yours

A ready-made UI with room for your code.

Launch a question

Use the Ask API to submit a question from a help button or another action in your product.

Connect your functions

Define tools with their inputs and an execute function. The assistant can call them to work with your application's APIs.

Listen for activity

Respond to events such as open, ask, complete, and feedback ratings with your own application logic.

Pass user context

Include user properties, such as an account role, to give the assistant context. Your application remains responsible for enforcing access.

Exclude page content

Mark elements with data-fr-ignore to remove their content from the page HTML sent with a question.

Set the presentation

Configure colors, button text, and position. Choose whether the assistant starts visible, then show or hide it from your code.

Works with

Build on the controls you need.

Connect an application action or a service your team already uses to extend what the assistant can do.

Connect actions with tool calls

Describe your functions and let the assistant call them with structured inputs.

See the available integrations

Connect support tickets, knowledge sources, and customer context.