Send an Asynchronous Scan Request

POST 
/v1/scan/async/request

Post a scan request that returns asynchronous scan response

Request

Header Parameters

x-pan-token stringrequired

API key token

application/json

Body

arrayrequired

A list of scan request objects

• Array [
type
items object
req_id uint32required
Unique identifier of an individual element sent in the batch scan request
scan_req objectrequired
tr_id string
Unique identifier for the transaction correlating prompt and response
ai_profile objectrequired
AI profile to use for the scan. You can specify one of the following - profile_id or profile_name
profile_id string
Unique identifier for the profile. If not provided, then profile_name is required.
profile_name string
Name of the profile. If not provided, then profile_id is required.
metadata object
Optionally send the app_name, app_user, and ai_model in the metadata
app_name string
AI application requesting the content scan
app_user string
End user using the AI application
ai_model string
AI model serving the AI application
contents object[]required
List of prompt or response or prompt/response pairs. The last element is the one that needs to be scanned, and the previous elements are the context for the scan.
Array [
prompt string
The prompt content that you want to scan
response string
The response content that you want to scan
]
title
• ]

Responses

200

successfully scanned request

application/json

Schema

Schema

received date-timerequired

Asynchronous scan received timestamp

scan_id stringrequired

Unique identifier for the asynchronous scan request

report_id string

Unique identifier for the asynchronous scan report

Example (from schema)

{
  "received": "2024-07-29T15:51:28.071Z",
  "scan_id": "82f1e879-0000-49af-9345-da907431c08f",
  "report_id": "R82f1e879-0000-49af-9345-da907431c08f"
}

400

Bad Request - Request data is invalid or malformed

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Request data is invalid or malformed"
  }
}

401

Unauthenticated - Not Authenticated

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Not Authenticated"
  }
}

403

Forbidden - Invalid API Key

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Invalid API Key"
  }
}

404

Not Found - Resource is not found

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Resource is not found"
  }
}

405

Method Not Allowed - The method is not allowed

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The method is not allowed"
  }
}

413

Request Too Large - The request body is too large

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The request body is too large"
  }
}

415

Unsupported Media Type - The media type is not supported

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The media type is not supported"
  }
}

429

Too Many Requests - Request exceeds limit

application/json

Schema

Schema

error object
message string
retry_after object
interval integer
unit string

Example (from schema)

{
  "error": {
    "message": "Request exceeds limit",
    "retry_after": {
      "interval": 5,
      "unit": "minute"
    }
  }
}

default

error

application/json

Schema

Schema

status_code int32required

The HTTP status code for the error

message stringrequired

The error message

Example (from schema)

{
  "status_code": 0,
  "message": "string"
}

Loading...