The Improve.ai Developer Hub

Welcome to the improve.ai developer hub. You'll find comprehensive guides and documentation to help you start working with improve.ai as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with Improve.ai

AI-Powered App Configuration to Automatically Improve User Retention and Revenue

Welcome! Improve.ai is AI-powered app configuration that automatically improves user retention and revenue. It's like A/B testing on AI-powered steroids. The service evolves unique app configurations for each user, learns which configurations perform best, and automatically serves those optimized configurations to new users.

The API is simple, just /choose and /track. The API calls are comprised of the basic components of Properties, Variants, and Events. Given a list of candidate property values, or Variants, the API will choose various property values and learn which generate the most revenue and best user retention.

Example Configuration

The input to the /choose endpoint is YAML or JSON describing possible variants for properties in the app's configuration.

variants:
  message:
    - Hello World!
    - Hi World!
    - Howdy World!
  price:
    - id: tier_2
      success_value: 1.99
    - id: tier_3
      success_value: 2.99
    - id: tier_4
      success_value: 3.99
    
properties:
  title: My App
  

The output is JSON containing the configuration for that user.

{
  "properties":{
    "title": "My App",
    "message": "Hi World",
    "price": "tier_2"
  }
}

Initially, the property values chosen will be fairly random, but will quickly hone in on the most profitable variants and return those more often.

Track Property Usage

Any time a property becomes causal, or visible to the user, track it with an event named using. Multiple properties may appear in a single event.

{
  "event": "using",
  "user_id": "23ajfasdf",
  "properties": {
    "message": "Hi World",
    "price": "tier_2"
  }
}

Track Successful Results

If use of the property was successful, for example a message led to a purchase, then track it with an event named success.

{
  "event": "success",
  "user_id": "23ajfasdf",
  "properties": {
    "message": "Hi World",
    "price": "tier_2"
  }
}

Once property usage and success is tracked, improve.ai will have all of the information it needs to discover and choose the properties that lead to the highest rate of success.

Quick Start

Download an example configuration file and send it to improve.ai:

# Download the example improve.yml file
curl -O https://orasis.github.io/improve.yml
# POST it to /choose to recieve a unique configuration
curl -X POST -H 'x-api-key:lv7xLCob5D7tn7fhih5j572syR1g6wkt67LCHq9G' --data-binary "@improve.yml" https://api.improve.ai/v2/choose
  • Run the above a few times and you should see different configurations being returned from the endpoint.

  • Open the improve.yml file, edit it, then upload that file to your web server.

  • Get an API key from AWS Marketplace. (the example API key is wiped periodically)

  • Test your API key and improve.yml file by modifying the curl commands above to point to your improve.yml URL.

  • When you're ready to integrate into your app, you'll repeat the same process of fetching the improve.yml and then POSTing it to the /choose endpoint. You'll save the resulting properties object for that user's configuration

  • Add /track calls for revenue, user retention, and property usage to your app so that improve.ai can learn which variants are performing best and return those more often.


What's Next

Properties

Getting Started with Improve.ai

AI-Powered App Configuration to Automatically Improve User Retention and Revenue