Merge pull request #778 from PaloAltoNetworks/airs-apis-updtes-nov20

AIRS APIs: Update description and blur image

openapi-specs/ai-runtime-security/scan/ScanService.yaml

@@ -37,7 +37,7 @@ paths:
       tags:
         - Scans
       parameters:
-        - description: API key token
+        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
           required: true
           in: header
           name: x-pan-token
@@ -93,7 +93,7 @@ paths:
       tags:
         - Scans
       parameters:
-        - description: API key token
+        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
           required: true
           in: header
           name: x-pan-token
@@ -146,7 +146,7 @@ paths:
       tags:
         - Scan Results
       parameters:
-        - description: API key token
+        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
           required: true
           in: header
           name: x-pan-token
@@ -206,7 +206,7 @@ paths:
         - Scan Reports
       operationId: GetThreatScanReports
       parameters:
-        - description: API key token
+        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
           required: true
           in: header
           name: x-pan-token
@@ -262,7 +262,7 @@ components:
       properties:
         tr_id:
           type: string
-          description: Unique identifier for the transaction correlating prompt and response
+          description: Provide any unique identifier string for correlating the prompt and response transactions. This is an optional field. The tr_id value received for scan request is returned in the scan response along with the scan ID.
         ai_profile:
           $ref: '#/components/schemas/AiProfile'
           description: AI profile to use for the scan. You can specify one of the following - profile_id or profile_name  

products/ai-runtime-security/api/airuntimesecurityapi.md

@@ -10,27 +10,31 @@ keywords:
   - API
 ---
 
-AI Runtime Security: API intercept is a threat detection service. The APIs offer a RESTful API service that protects your AI models, applications, and datasets by programmatically scanning prompts and models for threats, enabling robust protection across public and private models with model-agnostic functionality.
+**AI Runtime Security: API Intercept** is a threat detection service designed to secure AI applications. It helps discover and protect applications using REST APIs by embedding Security-as-Code directly into source code.
 
-You can integrate the AI security detection engine directly into your applications, to efficiently scan for various threats, including Prompt injections, Insecure outputs, and Sensitive data loss.
+The scan API service scans prompt and responses in real-time to identify potential threats and provide threat assessments with actionable recommendations.
+These APIs protect your AI models, applications, and datasets by programmatically scanning prompts and models for threats, enabling robust protection across public and private models with model-agnostic functionality.
 
-The APIs let you scan AI prompts and AI model responses in real-time and to get threat assessments and recommended actions.
+You can integrate the AI security detection engine directly into your applications, to efficiently scan for various threats, including prompt injections, insecure outputs, and sensitive data loss.
+To use these APIs, send prompts or model responses from your application and receive a threat assessment with recommended actions based on your AI security profile.
+
+For licensing, onboarding, activation, and to obtain the API authentication key and profile name, refer to the [AI Runtime Security: API Intercept Overview](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview) administration documentation.
 
 ## Prerequisites
 
-1. Create and associate a [deployment profile for AI Runtime Security: API Intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/ai-deployment-profile-airs-api-intercept) in your CSP.
-2. [Onboard AI Runtime Security: API Intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager (SCM).
-3. [Manage applications, API keys, and security profiles](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/airs-apirs-manage-api-keys-profile-apps) in SCM.
+1. Create and associate a [deployment profile for AI Runtime Security: API Intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/ai-deployment-profile-airs-api-intercept) in your Customer Support Poral.
+2. [Onboard AI Runtime Security: API Intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager.
+3. [Manage applications, API keys, and security profiles](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/airs-apirs-manage-api-keys-profile-apps) in Strata Cloud Manager.
 
 ## Requirements for API Usage
 
-1. **API Key Token**: This token is generated during the onboarding process in SCM (see prerequisite step 2).
+1. **API Key Token**: This token is generated during the onboarding process in Strata Cloud Manager (see prerequisite step 2).
 Include the API key token in all API requests using the `x-pan-token` header.
-2. **AI Security Profile Name**: This is the security profile created during the onboarding process in SCM (see prerequisite step 2).
+2. **AI Security Profile Name**: This is the security profile created during the onboarding process in Strata Cloud Manager (see prerequisite step 2).
 Specify this profile name or the profile ID in the API request payload in the `ai_profile` field.
 
 :::info
-You can manage API keys and AI security profiles in SCM.
+You can manage API keys and AI security profiles in Strata Cloud Manager.
 
 1. Log in to Strata Cloud Manager [SCM](http://stratacloudmanager.paloaltonetworks.com/).
 2. Navigate to **Insights > AI Runtime Security**.
@@ -42,3 +46,10 @@ You can manage API keys and AI security profiles in SCM.
 
 For complete details, refer to the Manage Applications, API Keys, and Security Profiles Administration guide.
 :::
+
+## Limitation
+
+- One AI security profile per Tenant Service Group (TSG) - Limited to one security profile per group.
+- One API key per deployment profile - Each deployment profile in the [Customer Support Portal](https://support.paloaltonetworks.com/Support/Index) allows a single API key.
+- 2 MB maximum payload size per synchronous scan request - Limited to a maximum of 100 URLs per request.
+- 5 MB maximum payload size per asynchronous scan request - Limited to a maximum of 100 URLs per request.

products/ai-runtime-security/api/usecases.md

@@ -11,6 +11,8 @@ keywords:
   - API
 ---
 
+This document outlines key use cases for AI Runtime Security: API Intercept. It covers detecting prompt injection, malicious URLs, and sensitive data loss (DLP). Each use case includes sample code or API requests, along with expected responses, demonstrating how to leverage the AI Runtime Security: API intercept for enhanced protection.
+
 ## Prerequisites
 
 1. Log in to Strata Cloud Manager ([SCM](http://stratacloudmanager.paloaltonetworks.com/)).