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

Documentation Index

Fetch the complete documentation index at: https://docs.promptguard.co/llms.txt

Use this file to discover all available pages before exploring further.

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