TABLE OF CONTENTS
1. Overview
Connect your Platform stack with Airmeet APIs and create events, add sessions, or add participants for an Airmeet event.
2. Use cases
- Adding registrations to an event
- Adding speakers in bulk
- Creating sessions in bulk
- Creating booths in bulk
- Fetching attendance for the event, sessions, and booths for an event
- Fetching poll responses, questions asked for an event
Datacenter (region)-wise API endpoints:
1. Use the "Default region" API if your community URL looks like this:
Default region (Mumbai): https://api-gateway.airmeet.com/prod
2. Use the "EU region" API if your community URL looks like this:
EU region: https://api-gateway-prod.eu.airmeet.com/prod
3. Use the "US region" API if your community URL looks like this:
US region: https://api-gateway-prod.us.airmeet.com/prod
Community dashboard: https://www.airmeet.com/ (use this to get a key pair issued).
3. Authentication
3.1 Generate Access token & key
Step 1: Sign in to your airmeet account ( https://www.airmeet.com/signup )
Step 2: Click on the "Integrations" tab and select the "API Access Key" section.
Step 3: Click on "Generate access key" and provide a name/label to your key (can be anything that can be remembered later)
Step 4: After providing your label name 'X-Airmeet-Access-Key' with 'X-Airmeet-Secret-Key' would be generated, which can be used in API integration
Access Key = X-Airmeet-Access-Key
Secret Key = X-Airmeet-Secret-Key
All APIs expect a Content-Type: application/JSON header.
3.2 Authentication
POST /auth
This API issues a token for use with the other APIs mentioned in this doc.
Tokens issued by this API are valid for 30 days and can be cached on the consumer service.
Headers
X-Airmeet-Access-Key and X-Airmeet-Secret-Key (can be obtained over from the integrations tab in the community dashboard)
Response
200 OK {"success": true, "data": {"label": "test", "token":
<your_access_token>}}
400 Bad Request - in case the request is missing a header or the supplied values are incorrect
403 Forbidden - in case the keys are revoked (abuse prevention)
500 Internal Server Error - generic server error
4. Manage Event
4.1 Create Airmeet
Create an Airmeet in your community
Automatically create a new Airmeet for a monthly review meeting for your employees or a new batch of students.
Endpoint:
POST /airmeet
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
Only hostEmail, eventName, shortDesc, timing - startTime, endTime, and timezone are mandatory fields
Access Type can be “INVITED_ONLY” or “WITH_VERIFIED_EMAIL” or “WITHOUT_VERIFIED_EMAIL.” or “EMAIL_UNIQUE_LINK”. Default is “INVITED_ONLY”
“INVITED_ONLY” - only those who have been invited will be able to join the event
“WITH_VERIFIED_EMAIL” - only those users who have a verified email will be able to join the event
“WITHOUT_VERIFIED_EMAIL” - anyone with the event link will be able to join the event
“EMAIL_UNIQUE_LINK” - during registration, users will receive a unique link on their email which they have to click to complete registration and join the event.
Start and End time should be unix timestamp
timezone is a Canonical tz name, e.g., "Asia/Kolkata" see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the full list
Few timezones might not be available - please check the dashboard for available timezones
Response:
200 OK - {"uuid":"a23f56d0-ba1d-11eb-86c0-exampleuuid", "airmeet status" : "CREATED"}
400 Bad Request - in case the passed token is bad
401 Unauthorized - in case the passed token does not have permission for the passed community_id
404 Not Found - in case the supplied community_id param is invalid
412 Precondition Failed - the passed access token has expired
500 Internal Server Error - generic server error
4.2 Add Speaker
Add a speaker to your Airmeet event
Call this API multiple times for adding speakers in bulk
Endpoint:
POST /airmeet/{airmeet_id}/speaker
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
Only name and email are mandatory fields
All fields are strings
imageUrl only accepts urls ending with “.jpg”, “.jpeg” and “.png”. If any other imageUrl is passed, the speaker will be added with a default profile image. This can be updated from the Airmeet dashboard.
Response:
200 OK - {"email":"string","status":"ADDED_TO_EVENT"}
400 Bad Request - in case the speaker with the same name or email already exists for the specified Airmeet.
404 Not Found - in case the supplied airmeet_id param is invalid
500 Internal Server Error - generic server error
4.3 Create Session
Add a session to your Airmeet event.
Call this API multiple times for creating sessions in bulk.
Endpoint:
POST /airmeet/{airmeet_id}/session
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
Only sessionTitle, sessionStartTime, hostEmail and sessionDuration are mandatory fields
Speakers should be added to the Airmeet before creating the session
Team members should be added to the community before creating the session
If you want a speaker to get the same privilege as a co-host, you can add their email in both the speaker and cohost fields
Uploading of background assets for the ‘FLUID_LOUNGE’ session is not supported
Response:
200 OK
400 Bad Request - in case there is already an overlapping session(same time)
404 Not Found - in case the supplied airmeet_id param is invalid
412 Precondition Failed - the passed access token has expired
500 Internal Server Error - generic server error
4.4 Update Airmeet Status
Use this API to start and end your Airmeet once it is created, without requiring a visit to the community dashboard. You can also use this API to Pause and Archive your Airmeet.
status can be [‘ONGOING’, ’PAUSED’, ‘FINISHED’, ‘ARCHIVE’]
Endpoint:
POST /airmeet/{airmeet_id}/status
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
Response:
200 OK - { "statusUpdated": true }
400 Bad Request - in case the status does not exist
404 Not Found - in case the supplied airmeet_id param is invalid
500 Internal Server Error - generic server error
4.5. Create Booth
- Add a booth to your Airmeet event
- Call this API multiple times for creating booths in bulk
Endpoint:
POST /airmeet/{airmeet_id}/booths
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
The “name” field is the only mandatory field.
Booth Logo cannot be uploaded from the API and need to be added to the dashboard.
Response:
200 OK - {"uuid":"64975ddc-c09e-47cd-b89e-832c6b7dc7e1" }
400 Bad Request - in case there is already an overlapping session(same time)
404 Not Found - in case the supplied airmeet_id param is invalid
412 Precondition Failed - the passed access token has expired
500 Internal Server Error - generic server error
4.6. Delete Session
Use this API to Delete a Session in your Airmeet
Endpoint:
DELETE /airmeet/{airmeet_id}/session/{session_id}
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Response:
200 OK - { "success": true }
400 Bad Request - in case the status does not exist
404 Not Found - in case the supplied airmeet_id param is invalid
500 Internal Server Error - generic server error
4.7. Customize Event Landing Page
Use this API to customize the landing page for your Airmeet. You can add 1 slide image, choose between dark and light themes, choose between modern and classic layouts, and set the color code for buttons and highlights on the landing page.
ambience can be [‘LIGHT’, ‘DARK’]
layout can be [‘CLASSIC’, ‘MODERN’]
highlightColor and buttonTextColor should be hex color codes (‘#’ followed by the 6 character hex code)
imageUrl only accepts urls ending with “.jpg”, “.jpeg” and “.png”
Endpoint:
PUT /airmeet/{airmeet_id}/landing-page
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Request Payload:
Response:
200 OK - { "success": true }
400 Bad Request - in case the payload is incorrect
404 Not Found - in case the supplied airmeet_id param is invalid
500 Internal Server Error - generic server error
4.8. Duplicate Event
Use this API to duplicate an Airmeet.
Endpoint:
POST /airmeet/{airmeetid}/duplicationHeaders:
X-Airmeet-Access-Token: airmeet_access_tokenRequest Payload:
Start time should be unix timestamp in milliseconds
timezone is a Canonical tz name, e.g., "Asia/Kolkata" see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the full list
Few timezones might not be available - please check the dashboard for available timezones
Response:
200 OK - {"uuid":"a23f56d0-ba1d-11eb-86c0-exampleuuid"}
400 Bad Request - in case the passed token is bad
401 Unauthorized - in case the passed token does not have permission for the passed community_id
404 Not Found - in case the supplied community_id param is invalid
412 Precondition Failed - the passed access token has expired
500 Internal Server Error - generic server error
5. Points to keep in mind and Limitations
- A few time zones might not be available. Kindly check the dashboard for available time zones while creating an event.
- Email address and First and last name are mandatory fields in uploading the CSV file and the custom registration form.
- While fetching the list of Airmeets, The before and after cursors cannot be used simultaneously. If they are both specified, the API ignores them before the cursor.
- Tokens issued by this API are valid for 30 days and can be cached on the consumer service.
- While creating a session:
- Only SessionTitle, SessionStartTime, and Host Email are mandatory fields.
- Speakers should be added to the Airmeet before creating the session.
- Team members should be added to the community before creating the session.
- If you want a speaker to get the same privilege as a co-host, you can add their email in both the speaker and cohost fields.
- The session type should be HOSTING only.
Need more help? Contact [email protected] or visit our 24*7 Support Lounge.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article