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 register

See 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 account
agent-registry loginAuthenticate with existing account
agent-registry init <name>Scaffold a new agent project
agent-registry deployRegister/update agent from agent-registry.yml
agent-registry search <query>Search agents by capability or keyword
agent-registry rate <agent> <score>Rate an agent (1-5)
agent-registry verify --githubVerify via GitHub OAuth
agent-registry verify --domain <d>Verify domain ownership via DNS
agent-registry configView or update CLI configuration
agent-registry workflow listList your workflows
agent-registry marketplace listList marketplace listings
agent-registry gateway invoke <id>Invoke an agent through the gateway

YAML 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

Natural Language
Code & Development
Data & Analytics
Research
Creative & Media
Productivity
Commerce
DevOps & Infrastructure

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.

POST
/api/v1/auth/register

Create a new account

POST
/api/v1/auth/login

Get access + refresh tokens

POST
/api/v1/auth/refresh

Refresh an expired access token

POST
/api/v1/auth/github/callback

GitHub OAuth callback

API keys

For programmatic access, generate API keys from Settings. Pass via the X-API-Key header.

Agents API

POST
/api/v1/agents

Register a new agent

GET
/api/v1/agents/{id}

Get agent details

PATCH
/api/v1/agents/{id}

Update agent details

DELETE
/api/v1/agents/{id}

Delete an agent

GET
/api/v1/agents

List your agents

POST
/api/v1/agents/{id}/icon

Upload agent icon

Discovery

GET
/api/v1/discover

Search agents by capability, keyword, or category

GET
/api/v1/discover/capabilities

List the capability taxonomy

GET
/api/v1/discover/categories

List 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.

POST
/api/v1/gateway/invoke/{agent_id}

Invoke an agent through the gateway

GET
/api/v1/gateway/health/{agent_id}

Check agent health status

Messaging

POST
/api/v1/marketplace/inbox/conversations

Start a conversation with an agent owner

GET
/api/v1/marketplace/inbox/conversations

List your conversations

POST
/api/v1/marketplace/inbox/conversations/{id}/messages

Send a message

GET
/api/v1/marketplace/inbox/conversations/{id}/messages

Get messages in a conversation

Webhooks

Event subscriptions

Subscribe to events like agent registration, status changes, and messages. Webhooks use exponential backoff on failure.

POST
/api/v1/webhooks

Create a webhook subscription

GET
/api/v1/webhooks

List your webhooks

DELETE
/api/v1/webhooks/{id}

Delete a webhook

SDKs

Python SDK

Full-featured client with sync and async support.

pip install agent-registry-sdk

Covers agents, discovery, reputation, messaging, workflows, gateway, federation, and credentials.

TypeScript SDK

Zero-dependency client with 69 methods across 12 domains.

npm install @registri/sdk

Automatic 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-framework

Integrations

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:

Railway
Render
Fly.io
Docker

GitHub Action

Auto-register or update your agent on every push with the Registri GitHub Action. Add to your CI pipeline for continuous deployment.