API

AirOps API

Introduction

This guide explains how to use your Apps through endpoints. Endpoints allow you to call the App with the required input parameters and receive a response. They are useful for integrating Apps into your internal workflows.

Authentication:

All endpoints require authentication using a Bearer token. To authenticate, include an Authorization header in your request with the value Bearer YOUR_API_KEY. You can find your API key in your workspace settings:

Getting a App Id:

The ID of an app is the number found in the app's URL. For instance, in the URL https://app.airops.com/{your_workspace}/apps/123, the app ID is 123.

App Parameters:

Applications require specific parameters in order to function properly. To obtain these parameters, go to the app and click on "API Doc." Next, look for the "Available Parameters" section. For example, in the image below, you can see that the available parameter is [sql_query].

Ready to make your first request? Check out API Reference