Getting Started

Quickstart

Set up your Restrct workspace, install the SDK, and register your first agent in under five minutes.

Get started with the Restrct API in under 5 minutes. This guide shows you how to authenticate and register your first agent.

Only need the CLI? Jump straight to Installation to install the SDK via npm, pip, or cURL.

Prerequisites

Restrct workspace account (Create one)
API key (Get one from the dashboard)
Node.js 18+, Python 3.10+, or cURL

Installation

Install the CLI and authenticate your workspace.

Terminal

# install the CLI
$ npm install -g @restrct/cli

# register this agent
$ restrct init --agent my-agent

# store your first memory
$ restrct memory add "Remembers user preferences"

# and search it back
$ restrct memory search "user preferences"

What's next?

Head to Installation for SDK-specific setup, or read Core Concepts to understand how memory, guardrails, and the agent harness fit together.