1. API
  2. Quickstart

Your first app, from code

Omi can build anything. In six steps your script asks for an app, watches Omi build it, puts it online, writes its data and downloads its code. Pick curl, JavaScript or Python once; every block follows.

  1. Create a key

    Open API keys, sign in, and create a key with the default scopes. Copy it: it is shown once. Every account starts on the free sandbox; see pricing for more.

  2. Check it works

    This reads your plan and credits. A 401 means the key is wrong or revoked.

    export BUILDITOMI_KEY="bio_..."   # the key you just created
    export API="https://api.builditomi.com/v1"
    curl -s "$API/usage" -H "Authorization: Bearer $BUILDITOMI_KEY"
  3. Ask for an app

    Describe it like you would to a person. You get the app's id straight away; the build has not run yet.

    ID=$(curl -s -X POST "$API/apps" \
      -H "Authorization: Bearer $BUILDITOMI_KEY" -H "Content-Type: application/json" \
      -d '{"prompt":"A booking app for my salon with stylists, time slots and reminders"}' | jq -r .id)
    echo "$ID"
  4. Watch it build

    Each call to /stream runs one step (up to about 48 seconds) and streams what Omi's agents are doing. Call again until you see done. A full app usually takes a few minutes. Prefer plain JSON? Use /step the same way.

    # -N shows each event as it arrives. Repeat until the last event is "done".
    until curl -sN -X POST "$API/apps/$ID/stream" -H "Authorization: Bearer $BUILDITOMI_KEY" \
      | tee /dev/stderr | grep -q "^event: done"; do :; done
  5. Publish it

    The app goes live at its own link. Connect your own domain later with the domains API.

    curl -s -X POST "$API/apps/$ID/publish" -H "Authorization: Bearer $BUILDITOMI_KEY"
  6. Use its data and code

    Write and read records as the app's owner, then download the whole project as a ZIP. Your code is yours.

    curl -s -X POST "$API/apps/$ID/records/bookings" \
      -H "Authorization: Bearer $BUILDITOMI_KEY" -H "Content-Type: application/json" \
      -d '{"name":"Asha","slot":"10:30"}'
    curl -s "$API/apps/$ID/records/bookings?limit=10" -H "Authorization: Bearer $BUILDITOMI_KEY"
    curl -s "$API/apps/$ID/source?download=zip" -H "Authorization: Bearer $BUILDITOMI_KEY" -o app.zip