What is the SayAs API
The SayAs API provides two core capabilities:
1) Make any entity in the AI living world say a phrase, at any time (including the ability to 'randomize' how the phrase is spoken).
2) Programmatically cause the pilot to say something to any entity in the AI living world (effectively simulating the pilot comms).
Typically this is used by pilots who are using some form of flight sim automation, and want to make the crew/co-pilot/ATC say specific things when certain events happen. For example, you might program SPAD.Next so that when the landing gear goes down, the co-pilot says some variation of a phrase to let you know the landing gear is down.
WARNING: All communications must remain "family friendly" and "aviation themed". Using this API to create obscene, or otherwise "unrelated" communications will result in the immediate termination of your SayIntentions.AI account.
Note that this API is not available to demo customers.
Which positions can I control?
- COM1 (ATC)
- COM2 (ATC)
- INTERCOM1 (Cabin-Crew, Co-Pilot, TourGuide, or Mentor)
- INTERCOM2 (Cabin-Crew, Co-Pilot, TourGuide, or Mentor)
- ACARS
Is there a limit to the size of the message?
Messages cannot exceed 255 characters.
Is there a rate-limit?
Not yet, though customers who abuse the system by sending more than a few dozen messages per flight may have their ability to use this feature restricted. (Remember, every time voices are generates, costs are incurred on our side).
How do I use it?
Send a simple HTTP GET request to:
https://apipri.sayintentions.ai/sapi/sayAs
The following parameters are required:
- api_key=your_api_key
- channel=comms_channel [One of: INTERCOM1, INTERCOM1_IN, INTERCOM2, INTERCOM2_IN, COM1, COM1_IN, COM2, COM2_IN, ACARS_IN].
- message=your_message (Must be in URL encoded format. For example, spaces are %20)
- rephrase=1 or 0 (1 means you would like the AI to rephrase the message so it sounds different / natural each time.. 0 means you would like it to use the EXACT message you've defined). This is only supported for "_IN" channels.
The following parameters can also be used if channel is ACARS
- from=acars_station_id
- response_code=acars_response_code ('WU', 'NE', etc.)
What is each channel used for?
- COM1 - Send a message from the pilot to ATC (on COM1)
- COM1_IN - Send a message from ATC to the pilot (on COM1)
- COM2 - Send a message from the pilot to aTC (on COM2)
- COM2_IN - Send a message from ATC to the pilot (on COM2)
- INTERCOM1 - Send a message from the pilot to the Intercom Passenger on Intercom-1
- INTERCOM1_IN - Send a message from the Intercom Passenger on Intercom-1 to the Pilot
- INTERCOM2 - Send a message from the pilot to the Intercom Passenger on Intercom-2
- INTERCOM2_IN - Send a message from the Intercom Passenger on Intercom-1 to the Pilot
- ACARS_IN - Send a message from an ACARS station to the pilot.
Where do I get my API Key?
Login to your pilot portal. It should be on the main account page.
Usage Examples:
Example 1: Make the Co-Pilot say some variation of "Good morning". (Assumes your Co-Pilot is on Intercom Channel 1)
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=INTERCOM1_IN&message=Good%20morning%20Captain&rephrase=1
Example 2: Make ATC ask the Pilot (you) for an altitude verification
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=COM1_IN&message=Verify%20altitude
Example 3: Have the Pilot (you) tell ATC they're holding short and ready for departure
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=COM1&message=Holding%20Short%20Runway%2020%20Ready%20For%20Departure
Example 4: Make the Pilot (you) notify the Cabin-Crew that they're now parked at the gate, and ask them to make an announcement apologizing about being late. (Assumes your Cabin-Crew is on Intercom Channel 1).
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=INTERCOM1&message=Weve%20rrived%20at%20the%20gate.%20Apologize%20to%20the%20passengers%20for%20being%20late.
Example 5: Make the Cabin-Crew say EXACTLY "Cross check and all call". (Assumes your Cabin-Crew is on Intercom Channel 2).
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=INTERCOM2_IN&message=Cross%20Check%20And%20All-Call&rephrase=0
Example 6: Sends an ACARS message to you that appears to be from station XXYY
https://apipri.sayintentions.ai/sapi/sayAs?api_key=YOUR_API_KEY&channel=ACARS_IN&message=HAPPY%20BIRTHDAY&from=XXYY&response_code=NE
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