Skip to main content

​
Prerequisites

  • Git
  • Docker & Docker Compose

​
Setup

1

Clone the repository

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

Configure environment

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

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:
ServiceURL
Frontendhttp://localhost:3000
Backend APIhttp://localhost:3001
Swagger Docshttp://localhost:3001/api/docs
MinIO Consolehttp://localhost:9001
Default login: admin@placet.local / changeme (configurable in .env)

​
Send your first agent message

1

Create an API key

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

Create an agent

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

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"}'
4

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