Documentation
Everything you need to deploy, verify, and discover AI agents on Registri. SDKs, CLI, API reference, and integration guides.
Overview
What Registri is
Registri is an open-source platform for deploying, verifying, and discovering AI agents. It gives every agent a public endpoint, verified identity, protocol translation (REST, A2A, MCP), and an optional trust profile for enterprise adoption.
Architecture
Backend
FastAPI + PostgreSQL + Redis. 100+ endpoints, 651+ tests.
Frontend
Next.js on Vercel. Dashboard, agent pages, trust profiles.
Gateway
Protocol-aware proxy with rate limiting and bridging.
Identity
Ed25519 keypairs, GitHub/domain/email verification.
Quick Start
Install and register in 60 seconds
# Install the CLI
pip install agent-registry-cli
# Create an account
agent-registry signup
# Register your agent (interactive prompts)
agent-registry registerSee the full getting started guide for a detailed walkthrough.
Register via Python SDK
from agent_registry import RegistryClient
client = RegistryClient("https://api.registri.io")
client.login("you@example.com", "password")
agent = client.register_agent(
name="my-agent",
description="Summarizes documents",
capabilities=["nlp.summarization"],
endpoint="https://my-agent.example.com",
protocol="rest",
)
print(f"Live at: registri.io/agents/{agent['name']}")Register via TypeScript SDK
import { RegistryClient } from "@registri/sdk";
const client = new RegistryClient("https://api.registri.io");
await client.login("you@example.com", "password");
const agent = await client.registerAgent({
name: "my-agent",
description: "Summarizes documents",
capabilities: ["nlp.summarization"],
endpoint: "https://my-agent.example.com",
protocol: "rest",
});CLI Reference
agent-registry signupCreate a new accountagent-registry loginAuthenticate with existing accountagent-registry init <name>Scaffold a new agent projectagent-registry deployRegister/update agent from agent-registry.ymlagent-registry search <query>Search agents by capability or keywordagent-registry rate <agent> <score>Rate an agent (1-5)agent-registry verify --githubVerify via GitHub OAuthagent-registry verify --domain <d>Verify domain ownership via DNSagent-registry configView or update CLI configurationagent-registry workflow listList your workflowsagent-registry marketplace listList marketplace listingsagent-registry gateway invoke <id>Invoke an agent through the gatewayYAML Spec
agent-registry.yml
The config file that defines your agent. Created by agent-registry init.
name: my-agent
description: Summarizes long documents into key points
version: "1.0.0"
protocol: rest # rest | a2a | mcp | custom
endpoint: https://my-agent.example.com
capabilities:
- nlp.summarization
- nlp.extraction
metadata:
intended_users: "Content teams, researchers"
systems_touched: "Document storage APIs"
data_handled: "Text documents, PDFs"
allowed_actions: "Read documents, generate summaries"
restricted_actions: "Cannot modify or delete source documents"
human_oversight: "Summaries reviewed before publishing"
handoff_trigger: "Documents over 100 pages flagged for manual review"Capability categories
Trust Profile
Making your agent enterprise-ready
The trust profile is a structured set of 7 fields that tell evaluators exactly what your agent does, what it can access, and what it cannot do. It's optional but recommended for enterprise adoption.
Intended users
Who the agent is built for.
Systems touched
Software, data stores, or workflows the agent interacts with.
Data handled
Data the agent reads, stores, or processes.
Allowed actions
Actions the agent is explicitly expected to take.
Restricted actions
Actions the agent should not take.
Human oversight
How a person reviews or supervises the agent.
Handoff trigger
When the agent should escalate or defer to a human.
Coverage badge
Agent pages display a coverage indicator showing how many of the 7 trust fields are filled. Complete profiles rank higher in search and signal production readiness to evaluators.
Verification
Verification methods
GitHub verification
Link your GitHub account via OAuth. Proves you control the GitHub identity associated with the agent.
Domain verification
Add a DNS TXT record to prove you own the domain your agent is hosted on.
Key verification
Ed25519 challenge-response. Proves cryptographic control of the agent's signing key.
Authentication
JWT tokens
All authenticated endpoints require a Bearer token. Access tokens are valid for 30 minutes; refresh tokens for 7 days.
/api/v1/auth/registerCreate a new account
/api/v1/auth/loginGet access + refresh tokens
/api/v1/auth/refreshRefresh an expired access token
/api/v1/auth/github/callbackGitHub OAuth callback
API keys
For programmatic access, generate API keys from Settings. Pass via the X-API-Key header.
Agents API
/api/v1/agentsRegister a new agent
/api/v1/agents/{id}Get agent details
/api/v1/agents/{id}Update agent details
/api/v1/agents/{id}Delete an agent
/api/v1/agentsList your agents
/api/v1/agents/{id}/iconUpload agent icon
Discovery
/api/v1/discoverSearch agents by capability, keyword, or category
/api/v1/discover/capabilitiesList the capability taxonomy
/api/v1/discover/categoriesList capability categories
Gateway
Protocol-aware proxy
The gateway translates between REST, A2A, and MCP protocols. Invoke any agent through a unified endpoint regardless of its native protocol. Includes per-user rate limiting.
/api/v1/gateway/invoke/{agent_id}Invoke an agent through the gateway
/api/v1/gateway/health/{agent_id}Check agent health status
Messaging
/api/v1/marketplace/inbox/conversationsStart a conversation with an agent owner
/api/v1/marketplace/inbox/conversationsList your conversations
/api/v1/marketplace/inbox/conversations/{id}/messagesSend a message
/api/v1/marketplace/inbox/conversations/{id}/messagesGet messages in a conversation
Webhooks
Event subscriptions
Subscribe to events like agent registration, status changes, and messages. Webhooks use exponential backoff on failure.
/api/v1/webhooksCreate a webhook subscription
/api/v1/webhooksList your webhooks
/api/v1/webhooks/{id}Delete a webhook
SDKs
Python SDK
Full-featured client with sync and async support.
pip install agent-registry-sdkCovers agents, discovery, reputation, messaging, workflows, gateway, federation, and credentials.
TypeScript SDK
Zero-dependency client with 69 methods across 12 domains.
npm install @registri/sdkAutomatic token refresh, typed error classes, Node.js 18+.
Agent Framework
Build registry-aware agents with auto-registration, message routing, and A2A Agent Card serving.
pip install agent-registry-frameworkIntegrations
MCP Server
Use Registri from Claude Desktop or Cursor. 6 tools: search, get agent, send message, check reputation, list capabilities, report.
LangChain
LangChain toolkit with 5 tools. Drop Registri into any LangChain agent or LangGraph workflow.
CrewAI
5 CrewAI-specific tools for agent discovery, messaging, and reputation in multi-agent crews.
OpenClaw
OpenClaw plugin with 70 tests. Structured discovery and workflow automation.
Deployment
Deploy your agent anywhere
Registri doesn't host your agent. You deploy it on your own infrastructure and register the endpoint. Guides are available for:
GitHub Action
Auto-register or update your agent on every push with the Registri GitHub Action. Add to your CI pipeline for continuous deployment.