Skip to main content
POST
/
api
/
v1
/
proxy
/
agent
/
register
Register Agent
curl --request POST \
  --url https://api.promptguard.dev/api/v1/proxy/agent/register \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_name": "<string>",
  "allowed_tools": [
    "<string>"
  ]
}
'
import requests

url = "https://api.promptguard.dev/api/v1/proxy/agent/register"

payload = {
"agent_name": "<string>",
"allowed_tools": ["<string>"]
}
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({agent_name: '<string>', allowed_tools: ['<string>']})
};

fetch('https://api.promptguard.dev/api/v1/proxy/agent/register', 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.dev/api/v1/proxy/agent/register",
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([
'agent_name' => '<string>',
'allowed_tools' => [
'<string>'
]
]),
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.dev/api/v1/proxy/agent/register"

payload := strings.NewReader("{\n \"agent_name\": \"<string>\",\n \"allowed_tools\": [\n \"<string>\"\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.dev/api/v1/proxy/agent/register")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_name\": \"<string>\",\n \"allowed_tools\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.promptguard.dev/api/v1/proxy/agent/register")

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 \"agent_name\": \"<string>\",\n \"allowed_tools\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "agent_id": "<string>",
  "agent_name": "<string>",
  "agent_secret": "<string>",
  "credential_prefix": "<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 to register a new agent identity.

agent_name
string
required
allowed_tools
string[] | null

Response

Successful Response

Response from agent registration — secret is shown only once.

agent_id
string
required
agent_name
string
required
agent_secret
string
required
credential_prefix
string
required