@mdwelsh/fixie

Fixie Platform SDK

This package contains an SDK and command-line interface to the Fixie.ai platform.

Web APIs

This package contains a number of ways for you to integrate a Fixie agent into your web app, depending on what level of opinionation / flexibility you prefer:

• Embed an iframe to the generic hosted Fixie UI:
  • <FloatingFixieEmbed />
  • <ControlledFloatingFixieEmbed />
  • <InlineFixieEmbed />
• Bring Your Own Frontend:
  • useFixie
  • FixieClient

Embed

Fixie provides a generic hosted UI. You can embed it in your UI, similar to how you might embed an Intercom widget.

<FloatingFixieEmbed />

import { FloatingFixieEmbed } from 'fixie';

This React component will place a Fixie chat window floating above your content. It will also create a launcher button. The user can click the button to open and close the Fixie chat window.

<ControlledFloatingFixieEmbed />

import { ControlledFloatingFixieEmbed } from 'fixie';

This React component will place a Fixie chat window floating above your content. Unlike FloatingFixieEmbed, it does not additionally create a launcher button. Instead, you manage the visibility yourself, via the visible prop.

<InlineFixieEmbed />

import { InlineFixieEmbed } from 'fixie';

This React component will embed a Fixie chat window inline with your content.

Bring Your Own Frontend

If you want to directly integrate Fixie into your webapp, use these APIs.

useFixie

import { useFixie } from 'fixie';

This hook provides a fully managed API for a conversation. It returns a number of fields you can use to drive a rich UI, including loading states and debug diagnostics.

FixieClient

import { FixieClient } from 'fixie';

This low-level API provides direct access to the Fixie Conversation and Corpus APIs. You need to manage things like loading state and response parsing on your own, but it's the most flexible.

Dev Notes

To publish this package:

• Update the version number in package.json.
• Run yarn install in the root to get the changes to yarn.lock.
• Finally, run yarn npm publish in this directory to get the updated package published to npm.