Skip to main content
POST
/
api
/
v1
/
guard
Guard Content
curl --request POST \
  --url https://api.promptguard.co/api/v1/guard \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "messages": [
    {
      "role": "<string>",
      "content": ""
    }
  ],
  "direction": "input",
  "model": "<string>",
  "context": {
    "framework": "<string>",
    "chain_name": "<string>",
    "agent_id": "<string>",
    "session_id": "<string>",
    "tool_calls": [
      {}
    ],
    "metadata": {}
  },
  "retrieved_context": [
    {
      "content": "<string>",
      "source": "<string>",
      "metadata": {}
    }
  ],
  "media": [
    {
      "type": "<string>",
      "mime_type": "<string>",
      "url": "<string>",
      "base64": "<string>",
      "metadata": {}
    }
  ]
}
'
import requests

url = "https://api.promptguard.co/api/v1/guard"

payload = {
    "messages": [
        {
            "role": "<string>",
            "content": ""
        }
    ],
    "direction": "input",
    "model": "<string>",
    "context": {
        "framework": "<string>",
        "chain_name": "<string>",
        "agent_id": "<string>",
        "session_id": "<string>",
        "tool_calls": [{}],
        "metadata": {}
    },
    "retrieved_context": [
        {
            "content": "<string>",
            "source": "<string>",
            "metadata": {}
        }
    ],
    "media": [
        {
            "type": "<string>",
            "mime_type": "<string>",
            "url": "<string>",
            "base64": "<string>",
            "metadata": {}
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{role: '<string>', content: ''}],
    direction: 'input',
    model: '<string>',
    context: {
      framework: '<string>',
      chain_name: '<string>',
      agent_id: '<string>',
      session_id: '<string>',
      tool_calls: [{}],
      metadata: {}
    },
    retrieved_context: [{content: '<string>', source: '<string>', metadata: {}}],
    media: [
      {
        type: '<string>',
        mime_type: '<string>',
        url: '<string>',
        base64: '<string>',
        metadata: {}
      }
    ]
  })
};

fetch('https://api.promptguard.co/api/v1/guard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.promptguard.co/api/v1/guard",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'role' => '<string>',
                'content' => ''
        ]
    ],
    'direction' => 'input',
    'model' => '<string>',
    'context' => [
        'framework' => '<string>',
        'chain_name' => '<string>',
        'agent_id' => '<string>',
        'session_id' => '<string>',
        'tool_calls' => [
                [
                                
                ]
        ],
        'metadata' => [
                
        ]
    ],
    'retrieved_context' => [
        [
                'content' => '<string>',
                'source' => '<string>',
                'metadata' => [
                                
                ]
        ]
    ],
    'media' => [
        [
                'type' => '<string>',
                'mime_type' => '<string>',
                'url' => '<string>',
                'base64' => '<string>',
                'metadata' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptguard.co/api/v1/guard"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"role\": \"<string>\",\n      \"content\": \"\"\n    }\n  ],\n  \"direction\": \"input\",\n  \"model\": \"<string>\",\n  \"context\": {\n    \"framework\": \"<string>\",\n    \"chain_name\": \"<string>\",\n    \"agent_id\": \"<string>\",\n    \"session_id\": \"<string>\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"metadata\": {}\n  },\n  \"retrieved_context\": [\n    {\n      \"content\": \"<string>\",\n      \"source\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"media\": [\n    {\n      \"type\": \"<string>\",\n      \"mime_type\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.promptguard.co/api/v1/guard")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"role\": \"<string>\",\n      \"content\": \"\"\n    }\n  ],\n  \"direction\": \"input\",\n  \"model\": \"<string>\",\n  \"context\": {\n    \"framework\": \"<string>\",\n    \"chain_name\": \"<string>\",\n    \"agent_id\": \"<string>\",\n    \"session_id\": \"<string>\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"metadata\": {}\n  },\n  \"retrieved_context\": [\n    {\n      \"content\": \"<string>\",\n      \"source\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"media\": [\n    {\n      \"type\": \"<string>\",\n      \"mime_type\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.promptguard.co/api/v1/guard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"role\": \"<string>\",\n      \"content\": \"\"\n    }\n  ],\n  \"direction\": \"input\",\n  \"model\": \"<string>\",\n  \"context\": {\n    \"framework\": \"<string>\",\n    \"chain_name\": \"<string>\",\n    \"agent_id\": \"<string>\",\n    \"session_id\": \"<string>\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"metadata\": {}\n  },\n  \"retrieved_context\": [\n    {\n      \"content\": \"<string>\",\n      \"source\": \"<string>\",\n      \"metadata\": {}\n    }\n  ],\n  \"media\": [\n    {\n      \"type\": \"<string>\",\n      \"mime_type\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "decision": "<string>",
  "event_id": "<string>",
  "confidence": 123,
  "latency_ms": 123,
  "threat_type": "<string>",
  "redacted_messages": [
    {
      "role": "<string>",
      "content": ""
    }
  ],
  "threats": [
    {
      "type": "<string>",
      "confidence": 123,
      "details": "<string>"
    }
  ]
}
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>"
  }
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "current_plan": "<string>",
    "requests_used": 123,
    "requests_limit": 123,
    "upgrade_url": "<string>",
    "retry_after": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

PromptGuard API key for developer endpoints. Keys start with pg_live_ and are created in the dashboard.

Headers

​
x-api-key
string | null

Body

application/json

Request body for the guard endpoint.

​
messages
GuardMessage · object[]
required

Messages to scan (OpenAI-style message array)

Minimum array length: 1
​
direction
string
default:input

Scan direction: 'input' (pre-LLM) or 'output' (post-LLM)

Pattern: ^(input|output)$
​
model
string | null

Model being used (for logging)

​
context
GuardContext · object | null

Optional framework context

​
retrieved_context
ContextDoc · object[] | null

RAG-retrieved documents to scan for knowledge poisoning. Each document is individually scanned before being merged into the LLM prompt. Optional; backwards-compatible.

​
media
MediaPartSchema · object[] | null

Media attachments to scan for steganographic payloads, adversarial patches, and font injection. Optional.

Response

Successful Response

Response from the guard endpoint.

​
decision
string
required

Policy decision: 'allow', 'block', or 'redact'

​
event_id
string
required

Unique event identifier for tracking

​
confidence
number
required

Confidence score of the decision

​
latency_ms
number
required

Processing time in milliseconds

​
threat_type
string | null

Primary threat type detected

​
redacted_messages
GuardMessage · object[] | null

Redacted messages (only present when decision='redact')

​
threats
ThreatDetail · object[]

Detailed threat breakdown