Skip to main content

Prompt Guard API Reference

Run In Postman

Base URL

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

Response

v-1-guard

POST
https://prompt-guard.aws.us.pangea.cloud/v1/guard

required parameters

array<object>

Prompt content and role array in JSON format. The content is the multimodel text or image input that will be analyzed.

Click 'Save' to use the value

array

Specific analyzers to be used in the call

Click 'Save' to use the value

boolean

Boolean to enable classification of the content

object

Pangea standard response schema

object
boolean

Boolean response for if the prompt was considered malicious or not

object

Prompt Analyzers for identifying and rejecting properties of prompts

string
boolean
string

Type of analysis, either direct or indirect

number

Percent of confidence in the detection result, ranging from 0 to 1

  • minimum: 0

  • maximum: 1

string

Extra information about the detection result

array<object>

List of classification results with labels and confidence scores

string

Classification category

boolean

Classification detection result

number

Confidence score for the classification

string

Classification description

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/guard
curl -sSLX POST 'https://prompt-guard.aws.us.pangea.cloud/v1beta/guard' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

v-1-beta-guard

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

required parameters

array<object>

Prompt content and role array in JSON format. The content is the text that will be analyzed for redaction.

Click 'Save' to use the value

array

Specific analyzers to be used in the call

Click 'Save' to use the value

boolean

Boolean to enable classification of the content

object

Pangea standard response schema

object
boolean

Boolean response for if the prompt was considered malicious or not

object

Prompt Analyzers for identifying and rejecting properties of prompts

string
boolean
string

Type of analysis, either direct or indirect

number

Percent of confidence in the detection result, ranging from 0 to 1

  • minimum: 0

  • maximum: 1

string

Extra information about the detection result

array<object>

List of classification results with labels and confidence scores

string

Classification category

boolean

Classification detection result

number

Confidence score for the classification

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​

Was this article helpful?

Contact us