Skip to main content

AI Guard Configuration API Reference

Base URL

ai-guard.<csp>.<region>.pangea.cloud

post/v1beta/config
curl -sSLX POST 'https://ai-guard.aws.us.pangea.cloud/v1beta/config' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Get AI Guard config

POST
https://ai-guard.aws.us.pangea.cloud/v1beta/config

Retrieve an AI Guard service configuration by its ID.

required parameters

string

ID of an AI Guard service configuration

object

Pangea standard response schema

object

Configuration used by the AI Guard service

string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/config/create
curl -sSLX POST 'https://ai-guard.aws.us.pangea.cloud/v1beta/config/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

This endpoint cannot be called through the documentation site

Create AI Guard config

POST
https://ai-guard.aws.us.pangea.cloud/v1beta/config/create

Create a new AI Guard service configuration.

required parameters

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

object

Pangea standard response schema

object

Configuration used by the AI Guard service

string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/config/update
curl -sSLX POST 'https://ai-guard.aws.us.pangea.cloud/v1beta/config/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

This endpoint cannot be called through the documentation site

Update AI Guard config

POST
https://ai-guard.aws.us.pangea.cloud/v1beta/config/update

Update an AI Guard service configuration.

To update a configuration, first retrieve the current version, apply your changes, and submit the updated configuration to this endpoint.

For a full example using a Project Admin management client, see the Service Configuration APIs documentation.

required parameters

string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

object

Pangea standard response schema

object

Configuration used by the AI Guard service

string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/config/delete
curl -sSLX POST 'https://ai-guard.aws.us.pangea.cloud/v1beta/config/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

This endpoint cannot be called through the documentation site

Delete AI Guard config

POST
https://ai-guard.aws.us.pangea.cloud/v1beta/config/delete

Delete an AI Guard service configuration.

required parameters

string

ID of an AI Guard service configuration

object

Pangea standard response schema

object

Configuration used by the AI Guard service

string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/config/list
curl -sSLX POST 'https://ai-guard.aws.us.pangea.cloud/v1beta/config/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

List AI Guard configs

POST
https://ai-guard.aws.us.pangea.cloud/v1beta/config/list

Retrieve a paginated list of AI Guard service configurations.

fields

object
string

Only records where id equals this value.

array<string>

Only records where id includes each substring.

Click 'Save' to use the value

array<string>

Only records where id equals one of the provided substrings.

Click 'Save' to use the value

string (date-time)

Only records where created_at equals this value.

string (date-time)

Only records where created_at is greater than this value.

string (date-time)

Only records where created_at is greater than or equal to this value.

string (date-time)

Only records where created_at is less than this value.

string (date-time)

Only records where created_at is less than or equal to this value.

string (date-time)

Only records where updated_at equals this value.

string (date-time)

Only records where updated_at is greater than this value.

string (date-time)

Only records where updated_at is greater than or equal to this value.

string (date-time)

Only records where updated_at is less than this value.

string (date-time)

Only records where updated_at is less than or equal to this value.

string

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

string

Order results asc(ending) or desc(ending).

string

Which field to order results by.

integer

Maximum results to include in the response.

  • minimum: 1

object

Pangea standard response schema

object
integer

Number of service configs matched by the list request

string

Base64-encoded pagination cursor from the previous response, used to retrieve the next page of results

array<object>
string

ID of an AI Guard service configuration

string

Human-readable name of the AI Guard service configuration

object

Configuration for enabling AI Guard Activity Log integration with Pangea Secure Audit Log.

When enabled, this logs AI Guard service interactions (including inputs, outputs, and detection results) to a tamperproof audit trail. You must provide a Secure Audit Log service configuration ID and specify at least one activity area to log, such as text_guard.

boolean

Whether activity logging is enabled for this configuration

string

ID of the Secure Audit Log service configuration where activity events should be recorded

object

Specifies which AI Guard API endpoints should generate audit log entries

boolean

Logs events for requests to the /v1/text/guard endpoint

object

Configuration for service integrations used by AI Guard detectors.

These connections allow AI Guard to leverage additional sources and services for risk detection, sensitive data redaction, analysis, and secret management.

For details, see the AI Guard Settings documentation.

object

Analyzes prompts to identify malicious and harmful intents like prompt injections or attempts to misuse or abuse the LLM.

Used in the Malicious Prompt detector.

boolean

Whether the Prompt Guard integration is enabled for detecting prompt injection attempts

string

ID of the Prompt Guard service configuration to use

number

Minimum confidence level for a detection

  • minimum: 0

  • maximum: 1

object

Detects malicious IP addresses using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the IP Intel integration is enabled for detecting malicious IP addresses

string

ID of the IP Intel service configuration to use

string

Provider of the IP reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects compromised user accounts using threat intelligence data

boolean

Whether the User Intel integration is enabled for detecting breached user accounts

string

ID of the User Intel service configuration to use

string

Provider of the user breach data

object

Checks URL reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the URL Intel integration is enabled for detecting malicious URLs

string

ID of the URL Intel service configuration to use

string

Provider of the URL reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Checks domain reputation using threat intelligence data.

Used in the Malicious Entity detector.

boolean

Whether the Domain Intel integration is enabled for detecting malicious domains

string

ID of the Domain Intel service configuration to use

string

Provider of the domain reputation data

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Scans files for known malware

boolean

Whether the File Scan integration is enabled for detecting malicious files

string

ID of the File Scan service configuration to use

string

Malicious content and threats detection provider used for scanning

number

Minimum risk level for a detection

  • minimum: 0

  • maximum: 100

object

Detects and redacts sensitive information from text.

Used in the Confidential and PII, Secret and Key Entity, and Custom Entity detectors.

boolean

Whether the Redact integration is enabled for identifying and removing sensitive information

string

ID of the Redact service configuration to use

object

Securely manages secrets and keys required by the AI Guard service

string

ID of the Vault service configuration to use

object

Language detection and analysis

boolean

Whether the Lingua integration is enabled for detecting languages

object

Detects code snippets and programming languages

boolean

Whether the Code integration is enabled for detecting code snippets

object
object

Defines an AI Guard recipe - a named configuration of detectors and redaction settings used to analyze and protect data flows in AI-powered applications.

Recipes specify which detectors are active, how they behave, and may include reusable settings such as FPE tweaks.

For details, see the AI Guard Recipes documentation.

string

Human-readable name of the recipe

string

Detailed description of the recipe's purpose or use case

string
(default: "v1")

Optional version identifier for the recipe. Can be used to track changes.

array<object>

Settings for AI Guard Detectors, including which detectors to enable and how they behave

string

Identifier of the detector to apply, such as prompt_injection, pii_entity, or malicious_entity

string
(default: "disabled")

Specifies whether the detector is enabled or disabled in this configuration

object

Detector-specific settings

array<object>

List of detection and redaction rules applied by this detector

string

Identifier of the redaction rule to apply. This should match a rule defined in the Redact service.

Configuration for the redaction method applied to detected values.

Each rule supports one redaction type, such as masking, replacement, hashing, Format-Preserving Encryption (FPE), or detection-only mode. Additional parameters may be required depending on the selected redaction type.

For more details, see the AI Guard Recipe Actions documentation.

string

Redaction method to apply for this rule

string

Replacement string to use when redaction_type is replacement

object

Parameters to control how text is masked when redaction_type is partial_masking

string
(default: "unmask")

Defines the masking strategy. Use unmask to specify how many characters to keep visible. Use mask to specify how many to hide.

integer

Number of leading characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of trailing characters to leave unmasked when masking_type is unmask

  • minimum: 0
integer

Number of leading characters to mask when masking_type is mask

  • minimum: 0
integer

Number of trailing characters to mask when masking_type is mask

  • minimum: 0
array<string>

List of characters that should not be masked (for example, hyphens or periods)

string
(default: "*")

Character to use when masking text

  • minLength: 1

  • maxLength: 1

object, null

Hash configuration when redaction_type is hash

Alphabet used for Format-Preserving Encryption (FPE). Determines the character set for encryption.

boolean

If true, indicates that further processing should be stopped when this rule is triggered

boolean

If true, disables this specific rule even if the detector is enabled

boolean

If true, performs a reputation check using the configured intel provider. Applies to the Malicious Entity detector when using IP, URL, or Domain Intel services.

boolean

If true, applies redaction or transformation when the detected value is determined to be malicious by intel analysis

object

Connector-level Redact configuration. These settings allow you to define reusable redaction parameters, such as FPE tweak value.

object

Settings for Redact integration at the recipe level

string

ID of a Vault secret containing the tweak value used for Format-Preserving Encryption (FPE). Enables deterministic encryption, ensuring that identical inputs produce consistent encrypted outputs.

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Status Codes
StatusStatus CodeDescription
AIGBadInputFormat400

The input schema is not currently supported.

AIGFileTooLarge400

File size too large.

AIGInvalidRecipe400

Recipe contains invalid contents.

AIGMissingSvConnection400

A service dependency was not set up.

NoProviderConfigured400

Provider for intelligence services used by ai-guard is not configured

RecipeNotExist400

Recipe does not exist in the ai-guard configuration

AIGServiceConfigFetchError500

Failed to fetch the dependent '{service_name}' service configuration from Pangea Cloud.

Was this article helpful?

Contact us