Developer documentation is currently in Alpha

Miri SDK & API

Documentation for Developers

TOC

The following outlines the content of the documentation.

Miri SDK Overview

Overview & Quick Start

Setup & Installation

Follow these steps to install and configure the SDK into your existing React Native application.

Basic Usage

The following steps are intended to help you get a basic MIri integration up and running in your existing React Native application.

Chat / Conversational UI

Powers all conversational UX. From the Onboarding conversation to logging a meal, this component will enable the back and forth with the user, including the display of in-context sub-components.

Goals and Tracking

During the course of the chat modules, the user will generate artifacts, such as Meals and Activities (coming soon). These components are used to list, edit and summarize these different artifact types.

Measurements

Goals and tracking of simpler measurements like weight or waist circumference.

Settings

Update the user's goals and profile information

Admin

These components contain all of the Organization-facing components to manage users, programs and coaches.

Webhooks

The Miri SDK includes web hook events that support real-time data updates, event tracking, and actionable alerts in your application

SDK Authorization Requests Guide

Instructions for developers to use the miri-react-native-sdk to make authorization requests during token exchange for external users.

Custom Token Validation API

API specification for implementing custom token validation endpoints that integrate with Miri's authentication system.

Admin User Viewing Guide

Guide for admin users to view care seekers through the miri web app using external care seeker IDs and API keys.

Empower more. Reach further.

©2024 Miri • 66 Franklin Street, Suite 300 Oakland, CA 94607