Quickstart
Four requests take you from a new key to a booked meeting with live updates.
Before you begin
You need your key from Aura. It has two parts, a key id and a secret, sent together as one bearer token:
Authorization: Bearer <key id>.<secret>
The secret is shown once, when your key is issued. Keep it on your server, never in a browser or mobile app. Every request goes to https://meetings.auraplatform.org/v1/external.
1. Add your customer
Use your own reference for the customer. Sending the same reference again returns the same customer, so a retry is always safe.
curl https://meetings.auraplatform.org/v1/external/tenants \
-H "Authorization: Bearer $AURA_API_KEY" -H "Content-Type: application/json" \
-d '{ "tenantRef": "northwind-dental", "displayName": "Northwind Dental" }'
2. Give them a meeting address
An address is where meetings for this customer live, with the Aura member who hosts them.
curl https://meetings.auraplatform.org/v1/external/tenants/northwind-dental/identities \
-H "Authorization: Bearer $AURA_API_KEY" -H "Content-Type: application/json" \
-d '{ "address": "northwind-sales", "assignedHostUserId": "<host member id>",
"durationMinutes": 30, "timezone": "America/New_York" }'
3. Book a meeting
curl https://meetings.auraplatform.org/v1/external/meetings \
-H "Authorization: Bearer $AURA_API_KEY" -H "Content-Type: application/json" \
-d '{ "tenantRef": "northwind-dental", "title": "Discovery call",
"scheduledAt": "2026-12-03T19:00:00Z",
"invitees": [{ "email": "dana@northwind.com", "displayName": "Dana Kim" }],
"idempotencyKey": "booking-48213" }'
You get the meeting back with its externalId, its status and each guest's status. Leave out scheduledAt to let the guest pick a time.
4. Follow what happens
Aura sends each update to the address you gave us, signed so your app can check it came from Aura. You can also read the meeting at any time:
curl https://meetings.auraplatform.org/v1/external/meetings/<externalId> \ -H "Authorization: Bearer $AURA_API_KEY"