Introduction

What is Seirime?

Seirime hooks you up with powerful assistants that not only shoot back spot-on responses to your customers' questions but also get things done for them. Not just boring chit-chat here — they're action-packed!

You can set up these assistants either through the dashboard, which is like a breeze for non-tech folks, or dive into the API if you're feeling a bit more tech-savvy. It's all about making it work for you!

Building blocks

Below are the components that Seirime consists of. They all play together to build a good customer experience.

Feel free to check them out:

Core API concepts

Public endpoints

API endpoints that start with /public can be accessed without a bearer token. This allows end users to access them without needing your API key. Instead, they are secured using a signature. When a web client opens a chat with an assistant, for example, it can send messages using a personally generated public URL:

Private endpoints

Non-public endpoints require a bearer token. The token can fetched through authentication.

Model relationships

Relations between models are represented using links. This makes it easy to navigate between them. Consider this GET /assistants API response:

Stateless and stateful communication

The Seirime API utilizes both REST (stateless) and WebSockets (stateful) to cater to different use cases. Websockets are used for real-time communication between the assistant, customer and support personnel. All other endpoints are available as REST APIs.