> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/airops.md).

# AirOps

Connect AirOps to StackAI to run your AirOps agents and workflows as part of a larger process. Pass information into AirOps and use its results in the next step of your workflow.

### Use AirOps in your workflow

* **Run agents and workflows.** Send a message or structured inputs to AirOps and retrieve the result. Use the asynchronous actions for longer-running work.
* **Manage reusable knowledge.** Create, update, retrieve, or delete content in AirOps memory stores.
* **Work with brand resources.** Access brand kits and their prompts, topics, personas, and related content.
* **Move data between steps.** Upload files to AirOps or export grid data as CSV.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| AirOps    | API Key        |

#### AirOps

Connect to AirOps to run agents, workflows, grid CSV exports, and file uploads from your StackAI flows.

**Set up in AirOps**

1. Sign in to AirOps and open **Settings → Workspace**.
2. Copy your workspace **API Key** (also shown in Workspace Settings). Keep it secret; regenerating it immediately invalidates the old key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **AirOps**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                    |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Key       | Yes      | Your AirOps API key. Generate one in AirOps under Workspace Settings > API Keys. [Provider instructions](https://docs.airops.com/api-reference). |

**Provider documentation:** [Setup reference](https://docs.airops.com/api-reference).

#### Verify the connection

Check that the connection is healthy, then verify access with a read operation:

1. Add **List Workflows** and select the saved AirOps connection. This action requires no input fields.
2. Run the action and inspect **Workflows** and **Count**.
3. Confirm that a workflow you expect to access appears. An empty list can be a valid response; it does not prove access to a particular workflow.

A successful connection check confirms authentication. It does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **AirOps** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Action reference

#### Run Agent

Send a message to an AirOps Agent app and wait for the response.

**Inputs**

| Field          | Type   | Required | Description                                                                                                                                    |
| -------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Agent App UUID | string | Yes      | The UUID of the AirOps Agent app to invoke. Copy it from the agent URL, e.g. <https://app.airops.com/public\\_apps/\\><UUID>/run.              |
| Message        | string | Yes      | The message to send to the agent.                                                                                                              |
| Session ID     | string | No       | Optional session id to continue an existing conversation. Pass the session\_id returned by a previous run. Leave blank to start a new session. |
| Inputs         | object | No       | Optional JSON object of inputs to pass to the agent.                                                                                           |

**Outputs**

| Field          | Type   | Description                                                                                                      |
| -------------- | ------ | ---------------------------------------------------------------------------------------------------------------- |
| Result         | object | The agent app result payload.                                                                                    |
| Response Text  | string | The agent's natural-language reply (result.response).                                                            |
| Result (JSON)  | string | JSON-serialized result for easy chaining into LLM nodes.                                                         |
| Execution UUID | string | The UUID of the AirOps execution.                                                                                |
| Session ID     | string | Session token to continue this conversation. Pass as session\_id in a follow-up run\_agent call to keep context. |
| Status         | string | Final status reported by AirOps.                                                                                 |
| Credits Used   | number | Credits consumed by this execution.                                                                              |

#### Run Agent (Async)

Invoke an AirOps Agent app asynchronously and poll until it finishes. Use for long-running agents that exceed sync request limits.

**Inputs**

| Field             | Type    | Required | Description                                                                                                                                    |
| ----------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Agent App UUID    | string  | Yes      | The UUID of the AirOps Agent app to invoke. Copy it from the agent URL, e.g. <https://app.airops.com/public\\_apps/\\><UUID>/run.              |
| Message           | string  | Yes      | The message to send to the agent.                                                                                                              |
| Session ID        | string  | No       | Optional session id to continue an existing conversation. Pass the session\_id returned by a previous run. Leave blank to start a new session. |
| Inputs            | object  | No       | Optional JSON object of inputs to pass to the agent.                                                                                           |
| Timeout (seconds) | integer | No       | How long to wait for the execution to finish (default: 300s, max: 1800s). Default: 300.                                                        |

**Outputs**

| Field             | Type   | Description                                                     |
| ----------------- | ------ | --------------------------------------------------------------- |
| Output            | object | The final execution output payload.                             |
| Response Text     | string | The agent's natural-language reply (output.response).           |
| Output (JSON)     | string | JSON-serialized output for easy chaining into LLM nodes.        |
| Execution UUID    | string | The UUID of the AirOps execution that was polled.               |
| Session ID        | string | Session token to continue this conversation in a follow-up run. |
| Status            | string | Final status reported by AirOps.                                |
| Runtime (seconds) | number | How long AirOps reports the execution took.                     |
| Credits Used      | number | Credits consumed by this execution.                             |

#### Run Workflow

Run an AirOps Workflow (app) synchronously and return the result.

**Inputs**

| Field         | Type            | Required | Description                                                                                          |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Workflow UUID | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection.               |
| Inputs        | object          | No       | JSON object of inputs for the workflow, keyed by input name (e.g. {"keywords": \["coffee", "tea"]}). |

**Outputs**

| Field             | Type   | Description                                              |
| ----------------- | ------ | -------------------------------------------------------- |
| Output            | object | The workflow execution output payload.                   |
| Output (JSON)     | string | JSON-serialized output for easy chaining into LLM nodes. |
| Execution UUID    | string | UUID of the AirOps execution.                            |
| Status            | string | Final status reported by AirOps.                         |
| Runtime (seconds) | number | How long AirOps reports the execution took.              |
| Credits Used      | number | Credits consumed by this execution.                      |

#### Run Workflow (Async)

Run an AirOps Workflow asynchronously and poll until it finishes. Use for long-running workflows that exceed the sync timeout.

**Inputs**

| Field             | Type            | Required | Description                                                                            |
| ----------------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Workflow UUID     | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection. |
| Inputs            | object          | No       | JSON object of inputs for the workflow.                                                |
| Timeout (seconds) | integer         | No       | How long to wait for the workflow to finish (default: 300s, max: 1800s). Default: 300. |

**Outputs**

| Field             | Type   | Description                                   |
| ----------------- | ------ | --------------------------------------------- |
| Output            | object | The final workflow output payload.            |
| Output (JSON)     | string | JSON-serialized output.                       |
| Execution UUID    | string | UUID of the AirOps execution that was polled. |
| Status            | string | Final status reported by AirOps.              |
| Runtime (seconds) | number | How long AirOps reports the execution took.   |
| Credits Used      | number | Credits consumed by this execution.           |

#### List Workflows

List all AirOps workflows the connected API key has access to.

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field     | Type   | Description                                                     |
| --------- | ------ | --------------------------------------------------------------- |
| Workflows | object | Array of AirOps workflow records (id, uuid, name, description). |
| Count     | number | Number of workflows returned.                                   |

#### Get Workflow

Fetch details of a single AirOps workflow by uuid.

**Inputs**

| Field         | Type            | Required | Description                                                                            |
| ------------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Workflow UUID | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection. |

**Outputs**

| Field    | Type   | Description                                                   |
| -------- | ------ | ------------------------------------------------------------- |
| Workflow | object | The AirOps workflow record (id, uuid, name, definition, etc). |

#### Get Execution

Fetch an AirOps execution record by uuid.

**Inputs**

| Field          | Type   | Required | Description                                                                                                             |
| -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Execution UUID | string | Yes      | The UUID of the AirOps execution to fetch. Get this from `List Executions` or from a previous AirOps run action output. |

**Outputs**

| Field     | Type   | Description                                  |
| --------- | ------ | -------------------------------------------- |
| Execution | object | The full execution record.                   |
| Status    | string | Current status of the execution.             |
| Output    | object | Execution output (empty when still running). |

#### Cancel Execution

Cancel an AirOps execution that is still running.

**Inputs**

| Field          | Type   | Required | Description                                                                                                              |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| Execution UUID | string | Yes      | The UUID of the AirOps execution to cancel. Get this from `List Executions` or from a previous AirOps run action output. |

**Outputs**

| Field     | Type    | Description                                 |
| --------- | ------- | ------------------------------------------- |
| Cancelled | boolean | True when AirOps accepted the cancellation. |

#### Retry Execution

Retry an AirOps execution that previously failed or was cancelled.

**Inputs**

| Field          | Type   | Required | Description                                                                                                             |
| -------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Execution UUID | string | Yes      | The UUID of the AirOps execution to retry. Get this from `List Executions` or from a previous AirOps run action output. |

**Outputs**

| Field   | Type    | Description                          |
| ------- | ------- | ------------------------------------ |
| Retried | boolean | True when AirOps accepted the retry. |

#### Submit Execution Feedback

Record positive, neutral, or negative feedback on an AirOps execution.

**Inputs**

| Field          | Type   | Required | Description                                                                                                                        |
| -------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Execution UUID | string | Yes      | The UUID of the AirOps execution to give feedback on. Get this from `List Executions` or from a previous AirOps run action output. |
| Feedback       | string | Yes      | One of 'positive', 'neutral', or 'negative'.                                                                                       |

**Outputs**

| Field     | Type    | Description                             |
| --------- | ------- | --------------------------------------- |
| Submitted | boolean | True when AirOps accepted the feedback. |

#### Export Grid CSV

Generate and download a CSV export of an AirOps grid sheet.

**Inputs**

| Field             | Type    | Required | Description                                                                                     |
| ----------------- | ------- | -------- | ----------------------------------------------------------------------------------------------- |
| Grid ID           | string  | Yes      | The ID of the AirOps grid. This integration cannot list grids yet.                              |
| Sheet ID          | string  | Yes      | The ID of the sheet within the grid to export. This integration cannot list sheets yet.         |
| Timeout (seconds) | integer | No       | How long to wait for the CSV generation job to finish (default: 120s, max: 900s). Default: 120. |

**Outputs**

| Field            | Type   | Description                                                                    |
| ---------------- | ------ | ------------------------------------------------------------------------------ |
| CSV URL          | string | Signed download URL for the generated CSV file. Short-lived.                   |
| CSV Text         | string | Raw CSV contents as text (may be empty when AirOps returns only a signed URL). |
| Bytes Downloaded | number | Size of the downloaded CSV in bytes.                                           |

#### Upload File

Upload a file (URL or raw text) to the connected AirOps workspace.

**Inputs**

| Field               | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| File Name           | string          | Yes      | Name the file should have in the AirOps workspace.                                                                                                                                                                                                                                                                                                                                                                                                                |
| File Content or URL | string          | Yes      | Either a signed URL to download the file from, or the raw file content as text (converted to PDF/DOCX based on file\_name extension).                                                                                                                                                                                                                                                                                                                             |
| Content Type        | select (string) | No       | Optional MIME type override. Usually leave this blank and let the action infer it from the file name or URL response headers. Select a common MIME type or type one manually if detection is wrong. Available values: PDF, Plain Text, CSV, JSON, Word Document, Word Document (DOCX), Excel Spreadsheet, Excel Spreadsheet (XLSX), PowerPoint Presentation, PowerPoint Presentation (PPTX), JPEG Image, PNG Image, GIF Image, ZIP Archive, MP4 Video, MP3 Audio. |

**Outputs**

| Field          | Type   | Description                                      |
| -------------- | ------ | ------------------------------------------------ |
| File ID        | string | ID of the uploaded file in the AirOps workspace. |
| File Name      | string | Name of the uploaded file.                       |
| Bytes Uploaded | number | Size of the uploaded payload in bytes.           |

#### List Executions

List executions for an AirOps app with optional pagination.

**Inputs**

| Field    | Type            | Required | Description                                                                           |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| App ID   | select (string) | Yes      | Select a workflow, or type an ID manually. Options load from the selected connection. |
| Page     | integer         | No       | Page number for pagination.                                                           |
| Per Page | integer         | No       | Number of executions per page.                                                        |

**Outputs**

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Executions | object | Array of execution records.    |
| Count      | number | Number of executions returned. |

#### Search Memory Store

Search an AirOps memory store (vector store) for relevant documents.

**Inputs**

| Field           | Type    | Required | Description                                                                                                 |
| --------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| Memory Store ID | string  | Yes      | The ID of the AirOps memory store (vector store) to search. This integration cannot list memory stores yet. |
| Query           | string  | Yes      | The search query text.                                                                                      |
| Top K           | integer | No       | Maximum number of results to return.                                                                        |
| Filter          | object  | No       | Optional metadata filter for narrowing search results.                                                      |

**Outputs**

| Field          | Type   | Description                                             |
| -------------- | ------ | ------------------------------------------------------- |
| Results        | object | Array of search results with text, metadata, and score. |
| Results (JSON) | string | JSON-serialized search results.                         |
| Count          | number | Number of results returned.                             |

#### Add Memory Store Document

Add a document to an AirOps memory store (vector store).

**Inputs**

| Field           | Type   | Required | Description                                                                                        |
| --------------- | ------ | -------- | -------------------------------------------------------------------------------------------------- |
| Memory Store ID | string | Yes      | The ID of the memory store to add the document to. This integration cannot list memory stores yet. |
| Document Name   | string | Yes      | Name of the document.                                                                              |
| Document Text   | string | Yes      | The text content of the document.                                                                  |
| Metadata        | object | No       | Optional metadata to attach to the document.                                                       |

**Outputs**

| Field           | Type   | Description                      |
| --------------- | ------ | -------------------------------- |
| Document        | object | The created document record.     |
| Document (JSON) | string | JSON-serialized document record. |

#### Update Memory Store Document

Update a document in an AirOps memory store (vector store).

**Inputs**

| Field           | Type   | Required | Description                                                                                                                          |
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Memory Store ID | string | Yes      | The ID of the memory store containing the document. This integration cannot list memory stores yet.                                  |
| Document ID     | string | Yes      | The ID of the document to update. Get this from a previous `Add Memory Store Document` output or an existing AirOps document record. |
| Document Name   | string | No       | New name for the document.                                                                                                           |
| Document Text   | string | No       | New text content for the document.                                                                                                   |
| Metadata        | object | No       | New metadata for the document.                                                                                                       |

**Outputs**

| Field           | Type   | Description                              |
| --------------- | ------ | ---------------------------------------- |
| Document        | object | The updated document record.             |
| Document (JSON) | string | JSON-serialized updated document record. |

#### Delete Memory Store Document

Delete a document from an AirOps memory store (vector store).

**Inputs**

| Field           | Type   | Required | Description                                                                                                                          |
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Memory Store ID | string | Yes      | The ID of the memory store containing the document. This integration cannot list memory stores yet.                                  |
| Document ID     | string | Yes      | The ID of the document to delete. Get this from a previous `Add Memory Store Document` output or an existing AirOps document record. |

**Outputs**

| Field   | Type    | Description                             |
| ------- | ------- | --------------------------------------- |
| Deleted | boolean | True when AirOps accepted the deletion. |

#### List Brand Kits

List AirOps brand kits with optional filtering and pagination.

**Inputs**

| Field        | Type    | Required | Description                                 |
| ------------ | ------- | -------- | ------------------------------------------- |
| Workspace ID | integer | No       | Optional workspace ID to filter brand kits. |
| Filters      | object  | No       | Optional filters for the brand kit list.    |
| Page         | integer | No       | Page number for pagination.                 |
| Per Page     | integer | No       | Number of brand kits per page.              |

**Outputs**

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Brand Kits | object | Array of brand kit records.    |
| Count      | number | Number of brand kits returned. |

#### Get Brand Kit

Fetch details of a single AirOps brand kit by ID.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |

**Outputs**

| Field     | Type   | Description                  |
| --------- | ------ | ---------------------------- |
| Brand Kit | object | The AirOps brand kit record. |

#### List Brand Kit Prompts

List AirOps brand kit prompts with optional filtering, sorting, and pagination.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the prompt list.                                                  |
| Sort         | object          | No       | Optional sort options for the prompt list.                                             |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of prompts per page.                                                            |

**Outputs**

| Field   | Type   | Description                        |
| ------- | ------ | ---------------------------------- |
| Prompts | object | Array of brand kit prompt records. |
| Count   | number | Number of prompts returned.        |

#### Get Brand Kit Prompt

Fetch details of a single AirOps brand kit prompt by ID.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Prompt ID    | select (string) | Yes      | Select a prompt, or type an ID manually. Options load from the selected connection.    |

**Outputs**

| Field  | Type   | Description                         |
| ------ | ------ | ----------------------------------- |
| Prompt | object | The AirOps brand kit prompt record. |

#### List Brand Kit Topics

List AirOps brand kit topics with optional filtering, sorting, and pagination.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the topic list.                                                   |
| Sort         | object          | No       | Optional sort options for the topic list.                                              |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of topics per page.                                                             |

**Outputs**

| Field  | Type   | Description                       |
| ------ | ------ | --------------------------------- |
| Topics | object | Array of brand kit topic records. |
| Count  | number | Number of topics returned.        |

#### Get Brand Kit Topic

Fetch details of a single AirOps brand kit topic by ID.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Topic ID     | select (string) | Yes      | Select a topic, or type an ID manually. Options load from the selected connection.     |

**Outputs**

| Field | Type   | Description                        |
| ----- | ------ | ---------------------------------- |
| Topic | object | The AirOps brand kit topic record. |

#### List Brand Kit Personas

List AirOps brand kit personas with optional filtering, sorting, and pagination.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the persona list.                                                 |
| Sort         | object          | No       | Optional sort options for the persona list.                                            |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of personas per page.                                                           |

**Outputs**

| Field    | Type   | Description                         |
| -------- | ------ | ----------------------------------- |
| Personas | object | Array of brand kit persona records. |
| Count    | number | Number of personas returned.        |

#### Get Brand Kit Persona

Fetch details of a single AirOps brand kit persona by ID.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Persona ID   | select (string) | Yes      | Select a persona, or type an ID manually. Options load from the selected connection.   |

**Outputs**

| Field   | Type   | Description                          |
| ------- | ------ | ------------------------------------ |
| Persona | object | The AirOps brand kit persona record. |

#### List Brand Kit Citations

List AirOps brand kit citations with optional filters, sort, and pagination.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the citation list.                                                |
| Sort         | object          | No       | Optional sort clause for the citation list.                                            |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of citations per page.                                                          |

**Outputs**

| Field     | Type   | Description                          |
| --------- | ------ | ------------------------------------ |
| Citations | object | Array of brand kit citation records. |
| Count     | number | Number of citations returned.        |

#### Show Brand Kit Citation

Fetch detailed metrics for a single AirOps brand kit citation by ID.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Citation ID  | select (string) | Yes      | Select a citation, or type an ID manually. Options load from the selected connection.  |

**Outputs**

| Field    | Type   | Description                           |
| -------- | ------ | ------------------------------------- |
| Citation | object | The AirOps brand kit citation record. |

#### List Brand Kit Competitors

List AirOps brand kit competitors with optional filters, sort, and pagination.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the competitor list.                                              |
| Sort         | object          | No       | Optional sort clause for the competitor list.                                          |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of competitors per page.                                                        |

**Outputs**

| Field       | Type   | Description                            |
| ----------- | ------ | -------------------------------------- |
| Competitors | object | Array of brand kit competitor records. |
| Count       | number | Number of competitors returned.        |

#### Get Brand Kit Competitor

Fetch details of a single AirOps brand kit competitor by ID.

**Inputs**

| Field         | Type            | Required | Description                                                                             |
| ------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Brand Kit ID  | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection.  |
| Competitor ID | select (string) | Yes      | Select a competitor, or type an ID manually. Options load from the selected connection. |

**Outputs**

| Field      | Type   | Description                             |
| ---------- | ------ | --------------------------------------- |
| Competitor | object | The AirOps brand kit competitor record. |

#### List Brand Kit Content Updates

List content updates for an AirOps brand kit.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the content update list.                                          |
| Sort         | object          | No       | Optional sort options for the content update list.                                     |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of content updates per page.                                                    |

**Outputs**

| Field           | Type   | Description                                |
| --------------- | ------ | ------------------------------------------ |
| Content Updates | object | Array of brand kit content update records. |
| Count           | number | Number of content updates returned.        |

#### Create Brand Kit Content Update

Create a new content update for an AirOps brand kit.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Payload      | object          | Yes      | The content update payload to send to AirOps.                                          |

**Outputs**

| Field          | Type   | Description                                  |
| -------------- | ------ | -------------------------------------------- |
| Content Update | object | The created brand kit content update record. |

#### Get Brand Kit Content Update

Fetch a single AirOps brand kit content update by ID.

**Inputs**

| Field             | Type            | Required | Description                                                                                 |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------- |
| Brand Kit ID      | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection.      |
| Content Update ID | select (string) | Yes      | Select a content update, or type an ID manually. Options load from the selected connection. |

**Outputs**

| Field          | Type   | Description                                 |
| -------------- | ------ | ------------------------------------------- |
| Content Update | object | The AirOps brand kit content update record. |

#### Delete Brand Kit Content Update

Delete an AirOps brand kit content update by ID.

**Inputs**

| Field             | Type            | Required | Description                                                                                 |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------- |
| Brand Kit ID      | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection.      |
| Content Update ID | select (string) | Yes      | Select a content update, or type an ID manually. Options load from the selected connection. |

**Outputs**

| Field   | Type    | Description                             |
| ------- | ------- | --------------------------------------- |
| Deleted | boolean | True when AirOps accepted the deletion. |

#### List Brand Kit Web Pages

List web page metrics for an AirOps brand kit.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection. |
| Filters      | object          | No       | Optional filters for the web page list.                                                |
| Sort         | object          | No       | Optional sort options for the web page list.                                           |
| Page         | integer         | No       | Page number for pagination.                                                            |
| Per Page     | integer         | No       | Number of web pages per page.                                                          |

**Outputs**

| Field     | Type   | Description                                 |
| --------- | ------ | ------------------------------------------- |
| Web Pages | object | Array of brand kit web page metric records. |
| Count     | number | Number of web pages returned.               |

#### Query Brand Kit Analytics

Query analytics for an AirOps brand kit using metrics, dimensions, and filters.

**Inputs**

| Field        | Type            | Required | Description                                                                                                                                                                                                             |
| ------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Brand Kit ID | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection.                                                                                                                                  |
| Metrics      | object          | Yes      | List of metric names. Valid values: mention\_rate, share\_of\_voice, citation\_rate, citation\_share, citation\_count, sentiment\_score, average\_position, answer\_count, first\_mention\_rate.                        |
| Dimensions   | object          | No       | List of dimensions to group by (max 3). Valid values: date, provider, topic, country, persona, domain, competitor, domain\_category, theme.                                                                             |
| Grain        | string          | No       | Time granularity: daily, weekly, monthly, or total (default: total).                                                                                                                                                    |
| Start Date   | string          | No       | Start date in YYYY-MM-DD format (default: 7 days ago).                                                                                                                                                                  |
| End Date     | string          | No       | End date in YYYY-MM-DD format (default: yesterday).                                                                                                                                                                     |
| Limit        | integer         | No       | Maximum number of rows to return (1-1000, default: 100).                                                                                                                                                                |
| Filters      | object          | No       | Filter object with top-level keys: providers (list of strings), topics (list of ints), countries (list of ISO codes), personas (list of ints), themes (list of ints), brand\_mentioned (string: "brand" or "category"). |

**Outputs**

| Field            | Type   | Description                                                    |
| ---------------- | ------ | -------------------------------------------------------------- |
| Analytics        | object | The analytics payload returned by AirOps.                      |
| Analytics (JSON) | string | JSON-serialized analytics payload for chaining into LLM nodes. |

#### Query Brand Kit Sentiment Theme Answers

Query individual AI answers with sentiment details for a brand kit theme.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                                    |
| ------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Brand Kit ID       | select (string) | Yes      | Select a brand kit, or type an ID manually. Options load from the selected connection.                                                         |
| Sentiment Theme ID | integer         | Yes      | The ID of the sentiment theme to analyze. This integration cannot list sentiment themes yet.                                                   |
| Start Date         | string          | No       | Start date in YYYY-MM-DD format (default: 30 days ago).                                                                                        |
| End Date           | string          | No       | End date in YYYY-MM-DD format (default: yesterday).                                                                                            |
| Page               | integer         | No       | Page number for pagination (default: 1).                                                                                                       |
| Per Page           | integer         | No       | Results per page, 1-50 (default: 10).                                                                                                          |
| Filters            | object          | No       | Filter object with top-level keys: providers (list of strings), countries (list of ISO codes), topics (list of ints), personas (list of ints). |

**Outputs**

| Field          | Type   | Description                                                  |
| -------------- | ------ | ------------------------------------------------------------ |
| Answers        | object | The sentiment theme answers payload returned by AirOps.      |
| Answers (JSON) | string | JSON-serialized answers payload for chaining into LLM nodes. |

#### Execute Definition

Execute an ad-hoc AirOps app definition synchronously and return the result.

**Inputs**

| Field         | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                        |
| ------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| App UUID      | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection.                                                                                                                                                                                                                                                                                                             |
| Inputs        | object          | Yes      | JSON object of inputs keyed by input name, matching inputs\_schema.                                                                                                                                                                                                                                                                                                                                |
| Inputs Schema | object          | Yes      | Array of input definitions. Required fields per entry: interface (long\_text\|short\_text\|json\|single\_select\|number), label, name, required (bool), group\_id (use 'no-group'), options (array, can be empty \[]). Optional: hint, placeholder, action\_id, test\_value. Use get\_workflow to retrieve the schema from an existing app.                                                        |
| Definition    | object          | Yes      | Array of workflow steps (min 1). Each entry requires: name (must match ^step\_\d+$, e.g. 'step\_1'), type (llm\|conditional\|app\|text\|web\_scrape\|fetch\_api\|code\|iteration), config (varies by type — for text: {template: '...'}, for llm: {model: '...', config: {prompt: '...', messages: \[...], temperature: 0.7}}). Use get\_workflow to retrieve the definition from an existing app. |

**Outputs**

| Field             | Type   | Description                                              |
| ----------------- | ------ | -------------------------------------------------------- |
| Output            | object | The definition execution output payload.                 |
| Output (JSON)     | string | JSON-serialized output for easy chaining into LLM nodes. |
| Execution UUID    | string | UUID of the AirOps execution.                            |
| Status            | string | Final status reported by AirOps.                         |
| Runtime (seconds) | number | How long AirOps reports the execution took.              |
| Credits Used      | number | Credits consumed by this execution.                      |

#### Async Execute Definition

Execute an ad-hoc AirOps app definition asynchronously and poll until it finishes. Use for long-running definitions that exceed the sync timeout.

**Inputs**

| Field             | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| App UUID          | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection.                                                                                                                                                                                                                                                                                                             |
| Inputs            | object          | Yes      | JSON object of inputs keyed by input name, matching inputs\_schema.                                                                                                                                                                                                                                                                                                                                |
| Inputs Schema     | object          | Yes      | Array of input definitions. Required fields per entry: interface (long\_text\|short\_text\|json\|single\_select\|number), label, name, required (bool), group\_id (use 'no-group'), options (array, can be empty \[]). Optional: hint, placeholder, action\_id, test\_value. Use get\_workflow to retrieve the schema from an existing app.                                                        |
| Definition        | object          | Yes      | Array of workflow steps (min 1). Each entry requires: name (must match ^step\_\d+$, e.g. 'step\_1'), type (llm\|conditional\|app\|text\|web\_scrape\|fetch\_api\|code\|iteration), config (varies by type — for text: {template: '...'}, for llm: {model: '...', config: {prompt: '...', messages: \[...], temperature: 0.7}}). Use get\_workflow to retrieve the definition from an existing app. |
| Timeout (seconds) | integer         | No       | How long to wait for the definition to finish (default: 300s, max: 1800s). Default: 300.                                                                                                                                                                                                                                                                                                           |

**Outputs**

| Field             | Type   | Description                                   |
| ----------------- | ------ | --------------------------------------------- |
| Output            | object | The final definition output payload.          |
| Output (JSON)     | string | JSON-serialized output.                       |
| Execution UUID    | string | UUID of the AirOps execution that was polled. |
| Status            | string | Final status reported by AirOps.              |
| Runtime (seconds) | number | How long AirOps reports the execution took.   |
| Credits Used      | number | Credits consumed by this execution.           |

#### Webhook Async Execute

Fire-and-forget execution of an AirOps app via its webhook endpoint. Returns the execution UUID immediately without polling.

**Inputs**

| Field        | Type            | Required | Description                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------- |
| App UUID     | select (string) | Yes      | Select a workflow, or type a UUID manually. Options load from the selected connection. |
| Inputs       | object          | No       | Optional JSON object of inputs for the app.                                            |
| Version Slug | integer         | No       | Optional published-version identifier to target a specific app version.                |

**Outputs**

| Field          | Type   | Description                                          |
| -------------- | ------ | ---------------------------------------------------- |
| Execution UUID | string | UUID of the AirOps execution started by the webhook. |
| Status         | string | Status reported by AirOps at kickoff.                |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/airops.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
