AI Guard API Reference

Base URL

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

• OpenAPI Specification

post/v1beta/text/guard

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

v-1-beta-text-guard

POST

https://data-guard.aws.us.pangea.cloud/v1beta/text/guard

fields

text

string

text

text

recipe

string

(default: "pangea_prompt_guard")

recipe

recipe

debug

boolean

(default: false)

debug

​

debug

Response Fields

Response Schema

object

Pangea standard response schema

result

object

redacted_prompt

string

recipe

string

findings

object

malicious_count

integer

artifact_count

integer

security_issues

object

matched_rules_count

integer

malicious_ip_count

integer

malicious_domain_count

integer

malicious_url_count

integer

compromised_email_addresses

integer

artifacts

array<object>

type

string

value

string

start

integer

end

integer

defanged

defanged

verdict

string

The verdict, given by the Pangea service, for the indicator

report

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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

Status	Status Code	Description
NoProviderConfigured	400	Provider for intelligence services used by data-guard is not configured
RecipeNotExist	400	Recipe does not exist in the data-guard configuration

Was this article helpful?

Contact us