Linchpin

https://linchpin.work/docs
Admin
Linchpin is an open-source, self-hostable runtime for managed AI agents that provides persistent...
Tokens:2,151
Snippets:29
Trust Score:5.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Linchpin Runtime

Source: https://linchpin.work/docs

Use Docker Compose to build and start the Linchpin stack.

```bash
docker compose up --build
```

--------------------------------

### Bring up the stack

Source: https://linchpin.work/docs

Use Docker Compose to start the API, connector, database, and web console services.

```bash
$ docker compose up --build

# Services
# → http://localhost:8000   API
# → http://localhost:3000   Console
# → http://localhost:8001   Connector (internal)
```

--------------------------------

### Clone and configure environment

Source: https://linchpin.work/docs

Clone the repository and generate the required .env file with API and encryption keys.

```bash
# Clone
$ git clone https://github.com/linchpinhq/linchpin.git
$ cd linchpin

# Configure
$ cat > .env <<EOF
LINCHPIN_API_KEY=$(openssl rand -hex 24)
VAULT_ENCRYPTION_KEY=$(python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())")
OPENROUTER_API_KEY="sk-or-v1-..."
EOF
```

--------------------------------

### Create a Session

Source: https://linchpin.work/docs

Initialize a new agent session by sending a POST request to the sessions endpoint.

```bash
curl -sX POST localhost:8000/v1/sessions \
-H "Authorization: Bearer $KEY" \
-d '{"agent_id":"a1","environment_id":"e1"}'
```

--------------------------------

### Create an agent

Source: https://linchpin.work/docs

Send a POST request to the API to create a new agent with specific model and tool configurations.

```bash
$ curl -sX POST http://localhost:8000/v1/agents \
    -H "Authorization: Bearer $LINCHPIN_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "coder",
      "model": { "provider": "openrouter", "id": "anthropic/claude-sonnet-4" },
      "system": "You are a careful engineer.",
      "tools": [{"name": "bash", "permission": "always_ask"}]
    }'
```

--------------------------------

### Send a User Message

Source: https://linchpin.work/docs

Send a message to an active session to trigger agent interaction.

```bash
curl -sX POST .../sessions/0cd24b30/events \
-d '{"type":"user.message",
"payload":{"text":"Say hi in 5 words"}}'
```

--------------------------------

### Stream Session Events

Source: https://linchpin.work/docs

Subscribe to the session event stream to receive real-time updates and agent responses.

```bash
curl -N .../sessions/0cd24b30/stream
```
Tokens:
Raw