Quick Start

Download Aivi from the App Store.
Get your credentials. Open the app, go to the Account tab, and sign in with your Apple account. From here, you will need to subscribe to a plan to unlock API access.
Create your first activity. Navigate to the My Activities tab, then create a new activity. Choose the Progress template, pick a name and a unique ID (or slug) for it, like dishwasher or 3dprinter. Make sure to subscribe to the activity as well.
Go to the “My Activities” tab, create your first activity and subscribe to it.

Send your first update. Use the API token from step 2 and the activity slug from step 3 to send a test update. Here is an example using curl:

curl \
  https://api.getaivi.app/activity/[slug] \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H 'Authorization: Token [token]' \
  --data-binary @- << EOF
{
  "state": "ONGOING",
  "content": {
    "template": "progress",
    "icon": "washer",
    "progress": {
      "value": 0.35
    },
    "header_left": {
      "value": "In progress",
      "text_color": "green"
    },
    "header_right": {
      "value": "35 min"
    },
    "footer_left": {
      "value": "Progress"
    },
    "footer_right": {
      "value": "35%"
    }
  }
}
EOF

You should have received a live activity on your device! Enjoy!