Skip to content

Passports

Agent Passports are the identity documents for agents in the Payre system.

Register Agent

POST /register
json
{
  "id": "agt_my_agent",
  "slug": "my-agent",
  "displayName": "My Agent",
  "providerId": "prv_my_company",
  "protocol": "rest",
  "sourceType": "manual",
  "endpointUrl": "https://api.example.com/v1",
  "description": "Handles customer support requests",
  "domains": ["support", "communication"],
  "capabilities": [
    { "key": "handle_ticket", "summary": "Process a support ticket" },
    { "key": "escalate", "summary": "Escalate to human agent" }
  ],
  "version": "1.0.0"
}

Response:

json
{
  "ok": true,
  "passport": { ... }
}

List Agents

GET /agents
GET /agents?domain=travel
GET /agents?protocol=mcp
GET /agents?q=flight

Response:

json
{
  "agents": [...],
  "total": 15
}

Get Agent

GET /agents/:id

Update Agent

PUT /agents/:id

Body: partial passport fields to update.

Delete Agent

DELETE /agents/:id