SayIntentions.AI API Documentation

Complete Examples

Basic Communication Scenario

# 1. Get weather for departure airport
curl "https://apipri.sayintentions.ai/sapi/getWX" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "icao=KJFK" 
  --data-urlencode "with_comms=1"

# 2. Make co-pilot announce ready for pushback
curl "https://apipri.sayintentions.ai/sapi/sayAs" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "channel=INTERCOM1_IN" 
  --data-urlencode "message=Captain, ready for pushback" 
  --data-urlencode "rephrase=1"

# 3. Set COM1 to ground frequency
curl "https://apipri.sayintentions.ai/sapi/setFreq" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "freq=121.900" 
  --data-urlencode "com=1" 
  --data-urlencode "mode=active"

# 4. Simulate pilot call to ground
curl "https://apipri.sayintentions.ai/sapi/sayAs" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "channel=COM1" 
  --data-urlencode "message=JFK Ground, N12345 at gate A1, ready to taxi"

Gate Assignment Workflow

# 1. Request specific gate assignment
curl "https://apipri.sayintentions.ai/sapi/assignGate" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "gate=A21" 
  --data-urlencode "airport=KATL"

# 2. Get current parking information
curl "https://apipri.sayintentions.ai/sapi/getParking" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY"

# 3. Announce arrival at gate
curl "https://apipri.sayintentions.ai/sapi/sayAs" 
  -G 
  --data-urlencode "api_key=YOUR_API_KEY" 
  --data-urlencode "channel=INTERCOM1" 
  --data-urlencode "message=Ladies and gentlemen, we have arrived at gate A21"

JavaScript Integration Example

// GPT: SAPI JavaScript wrapper class
class SayIntentionsAPI {
    constructor(apiKey) {
        this.apiKey = apiKey;
        this.baseUrl = 'https://apipri.sayintentions.ai/sapi/';
    }

    async makeRequest(endpoint, params = {}) {
        const url = new URL(this.baseUrl + endpoint);
        url.searchParams.append('api_key', this.apiKey);
        
        Object.keys(params).forEach(key => {
            url.searchParams.append(key, params[key]);
        });

        const response = await fetch(url);
        return await response.json();
    }

    async sayAs(channel, message, options = {}) {
        return await this.makeRequest('sayAs', {
            channel,
            message,
            ...options
        });
    }

    async getWeather(icao, withComms = false) {
        return await this.makeRequest('getWX', {
            icao,
            with_comms: withComms ? 1 : 0
        });
    }

    async assignGate(gate, airport) {
        return await this.makeRequest('assignGate', {
            gate,
            airport
        });
    }

    async setFrequency(freq, com = 1, mode = 'active') {
        return await this.makeRequest('setFreq', {
            freq,
            com,
            mode
        });
    }

    async pauseSimulation(pause = true) {
        return await this.makeRequest('setPause', {
            value: pause ? 1 : 0
        });
    }

    async getCommsHistory() {
        return await this.makeRequest('getCommsHistory');
    }

    async getTFRs() {
        return await this.makeRequest('getTFRs');
    }

    async getVATSIM() {
        return await this.makeRequest('getVATSIM');
    }
}

// Usage examples
const sapi = new SayIntentionsAPI('YOUR_API_KEY');

// Make co-pilot announce takeoff
sapi.sayAs('INTERCOM1_IN', 'Ladies and gentlemen, prepare for takeoff', { 
    rephrase: 1 
})
.then(response => {
    console.log('Co-pilot announcement sent:', response);
})
.catch(error => {
    console.error('Error:', error);
});

// Get weather for multiple airports
sapi.getWeather('KJFK,KLGA,KEWR', true)
.then(weather => {
    console.log('Weather data:', weather);
})
.catch(error => {
    console.error('Error:', error);
});

// Request gate assignment
sapi.assignGate('A21', 'KATL')
.then(result => {
    console.log('Gate assigned:', result.assigned_gate_name);
})
.catch(error => {
    console.error('Gate assignment failed:', error);
});

// Set radio frequency
sapi.setFrequency(121.900, 1, 'active')
.then(response => {
    console.log('Frequency set:', response);
})
.catch(error => {
    console.error('Frequency error:', error);
});