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    
Suggest Edits

/choose

Have improve.ai choose the best property value from a list of candidates to maximize funnel conversion

 
posthttps://api.improve.ai/v1/choose
curl -H "Content-Type: application/json" -H "x-api-key: lv7xLCob5D7tn7fhih5j572syR1g6wkt67LCHq9G" -d '{
  "variants": {
    "headline": ["Truck Carrying Fruit Crashes, Creates Jam", "Accident Backs up Traffic", "Morning Commute Slower than Usual"]
  }
}' https://api.improve.ai/v2/choose
A binary file was returned

You couldn't be authenticated

{
  "properties": {
    "headline": "Truck Carrying Fruit Crashes, Creates Jam"
  }
}

Body Params

property_key
string

The property key to choose the best value for

variants
array of mixed types

a list of candidate property values

user_id
string

a unique id for the user

 
Suggest Edits

/track

Track an event and associated properties so that improve.ai can learn which property values perform best

 
posthttps://api.improve.ai/v1/track
curl -H "Content-Type: application/json" -H "x-api-key: lv7xLCob5D7tn7fhih5j572syR1g6wkt67LCHq9G" -d '{
    "event": "Viewed",
    "properties": {
      "headline": "Truck Carrying Fruit Crashes, Creates Jam"
    },
    "user_id": "asdf123"
  }' https://api.improve.ai/v1/track 
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}

Body Params

event
string

The name of the event

properties
object

The properties to track with this event

user_id
string

a unique id for the user that triggered the event

Headers

x-api-key
string

the api key