You probably want staging, unless you want raw audio bytes. If you want raw audio bytes, you want dev.
-
brew install ngrok -
Make an ngrok account
-
Navigate to AugmentOS.dev
-
Click "Sign In", and log in with the same Google account you're using for AugmentOS
-
Click "Create App"
-
Set a UNIQUE package name like
org.yourlastname.yoursocialsecuritynumber -
For webhook url, enter your ngrok's static url, appended by
webhook- EX:
- If you Ngrok URL is:
https://my-static-url.ngrok-free.app - Then you enter
https://my-static-url.ngrok-free.app/webhook
- If you Ngrok URL is:
- EX:
-
Clone this repo:
git clone git@github.com:AugmentOS-Community/AugmentOS-Cloud-Example-App.git -
cd into your repo, then type
bun install -
Edit your
index.tsto match the app you registered at AugmentOS.dev
const app = new ExampleAugmentOSApp({
packageName: 'org.yourlastname.yoursocialsecuritynumber', // make sure this matches your app in dev console
apiKey: 'your_api_key', // Not used right now, can be anything
port: 3000, // The port you're hosting the server on
augmentOSWebsocketUrl: 'wss://dev.augmentos.org/tpa-ws' //AugmentOS url
});-
Run your app with
bun run index.ts -
To expose your app to the internet (and thus AugmentOS) with ngrok, run:
ngrok http --url=civil-frankly-javelin.ngrok-free.app 30003000is the port. It must match what is in the app config. If you enteredport: 8080, use8080for ngrok instead.