Quickstart

Prerequisites

Git
Docker & Docker Compose

Setup

Clone the repository

git clone https://github.com/placet-io/placet.git && cd placet

Configure environment

cp .env.example .env Edit .env to set your desired admin email, password, and other settings.

Start everything

make setup This installs dependencies, builds packages, starts all Docker services (Postgres, MinIO, Backend, Frontend), runs migrations, and creates the initial user.

Access the services

Once setup completes, the following services are available:

Service	URL
Frontend	`http://localhost:3000`
Backend API	`http://localhost:3001`
Swagger Docs	`http://localhost:3001/api/docs`
MinIO Console	`http://localhost:9001`

Default login: admin@placet.local / changeme (configurable in .env)

Send your first agent message

Create an API key

Go to Settings → API Keys and create a new key.

Create an agent

Click + New Agent in the inbox sidebar to create a new agent.

Send a message

curl -X POST http://localhost:3001/api/v1/messages \
  -H "x-api-key: hp_your-key-here" \
  -H "Content-Type: application/json" \
  -d '{"channelId": "your-agent-id", "text": "Hello from my agent!", "status": "success"}'

View the message

Open the agent’s chat in the frontend and your message appears in real-time.

Request human approval

curl -X POST http://localhost:3001/api/v1/messages \
  -H "x-api-key: hp_your-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "channelId": "your-agent-id",
    "text": "Deploy v2.1 to production?",
    "review": {
      "type": "approval",
      "payload": {
        "options": [
          { "id": "approve", "label": "Approve", "style": "primary" },
          { "id": "reject", "label": "Reject", "style": "danger" }
        ]
      }
    }
  }'

The message appears with approval buttons. When the user clicks one, you receive the response via webhook or by polling the API.

Next steps

How It Works

Understand how agents and humans interact in Placet

Plugins

Build custom message types with the plugin system

API Reference

Full REST API documentation

Self-Hosting

Deploy Placet on your own infrastructure

Getting Started

Core Concepts

Connections

Examples

Plugins

Prerequisites

Setup

Access the services

Send your first agent message

Request human approval

Next steps

How It Works

Plugins

API Reference

Self-Hosting

​Prerequisites

​Setup

​Access the services

​Send your first agent message

​Request human approval

​Next steps

How It Works

Plugins

API Reference

Self-Hosting

Prerequisites

Setup

Access the services

Send your first agent message

Request human approval

Next steps