Skip to content
Aivi Docs

Quick Start

  1. Download Aivi from the App Store.

  2. 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.

  3. 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. Then subscribe to the activity on your device: this is what makes the Live Activity appear, and is separate from the billing plan in step 2.

  4. 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": {
          "style": "simple",
          "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

  5. You should now see a Live Activity on your device.

    A newly received Live Activity on an iPhone.

Updating the activity

Section titled “Updating the activity”

As the task progresses, send the same request again with new values, for example a higher progress value or different header text. The activity updates in place on every subscribed device; you never create a second one.

Ending the activity

Section titled “Ending the activity”

When the task is done, end the activity by sending state: "IDLE". The same content you last sent is fine:

curl \
  https://api.getaivi.app/activity/[slug] \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H 'Authorization: Token [token]' \
  --data-binary @- << 'EOF'
{
  "state": "IDLE",
  "content": { "template": "progress", "progress": { "style": "simple", "value": 1.0 } }
}
EOF

The Live Activity then dismisses after the per-activity delay you configure in the app. See Activity states.

Next steps

Section titled “Next steps”