Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agent_apis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It demonstrates how to set up a multi steps workflow with Weather API and OpenAI
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
4 changes: 2 additions & 2 deletions agent_chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It demonstrates how to set up a workflow to have a conversation with an AI agent
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down Expand Up @@ -102,7 +102,7 @@ with the payload:
{
"eventName": "messages",
"eventInput": {
"messages": [{"role": "user", "content": "tell me a joke"}]
"messages": [{ "role": "user", "content": "tell me a joke" }]
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion agent_humanloop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It demonstrates how to set up a basic Agent and functions.
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion agent_rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Follow [the step-by-step tutorial](https://docs.restack.io/examples/projects/age
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
4 changes: 2 additions & 2 deletions agent_stream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Build an Agent user can chat with and return streaming response.
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down Expand Up @@ -93,7 +93,7 @@ with the payload:
{
"eventName": "messages",
"eventInput": {
"messages": [{"role": "user", "content": "tell me a joke"}]
"messages": [{ "role": "user", "content": "tell me a joke" }]
}
}
```
Expand Down
4 changes: 1 addition & 3 deletions agent_telephony/twilio_livekit/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Restack AI - Agent with telephony - Twilio

Build an AI agent that do an outbound call with Twilio and can interact with in realtime with voice.
Expand All @@ -24,7 +23,7 @@ In /livekit-trunk-setup you can find a script to create automaticlaly trunk setu
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Configure environment variables
Expand All @@ -33,7 +32,6 @@ In all subfolders, duplicate the `env.example` file and rename it to `.env`.

Obtain a Restack API Key to interact with the 'gpt-4.1-mini' model at no cost from [Restack Cloud](https://console.restack.io/starter)


## Start Restack Agent with Twilio

### Start python shell
Expand Down
4 changes: 1 addition & 3 deletions agent_telephony/vapi/agent_vapi/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Restack AI - Agent with telephony - Vapi

Build an AI agent that do an outbound call with Vapi and can interact with in realtime with voice.
Expand All @@ -21,7 +20,7 @@ See more on [Vapi documentation](https://docs.vapi.ai/quickstart/phone/outbound)
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Configure environment variables
Expand All @@ -30,7 +29,6 @@ In all subfolders, duplicate the `env.example` file and rename it to `.env`.

Obtain a Restack API Key to interact with the 'gpt-4.1-mini' model at no cost from [Restack Cloud](https://console.restack.io/starter)


## Start Restack Agent with Twilio

### Start python shell
Expand Down
2 changes: 1 addition & 1 deletion agent_todo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It demonstrates how to set up a basic agent with tool call with a basic workflow
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion agent_tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Follow [the step-by-step tutorial](https://docs.restack.io/examples/projects/age
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion agent_video/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For a complete documentation on how the agent works and how to setup the service
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
25 changes: 14 additions & 11 deletions agent_voice/livekit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,22 @@ In all subfolders, duplicate the `env.example` file and rename it to `.env`.
### How to setup

1. **Set up Deepgram**
- Sign up at [Deepgram](https://developers.deepgram.com/home/introduction)
- Get an API key

- Sign up at [Deepgram](https://developers.deepgram.com/home/introduction)
- Get an API key

2. **Set up Livekit**
- Sign up at [Livekit](https://docs.livekit.io/home/)
- In .env file:
- Set `LIVEKIT_URL` to `WEBSOCKET_URL` value
- Set `LIVEKIT_API_KEY` to `API_KEY` value
- Set `LIVEKIT_API_SECRET` to `API_SECRET` value

- Sign up at [Livekit](https://docs.livekit.io/home/)
- In .env file:
- Set `LIVEKIT_URL` to `WEBSOCKET_URL` value
- Set `LIVEKIT_API_KEY` to `API_KEY` value
- Set `LIVEKIT_API_SECRET` to `API_SECRET` value

3. **Set up ElevenLabs**
- Sign up at [ElevenLabs](https://elevenlabs.io/docs/overview)
- Add `ELEVENLABS_API_KEY` to .env file

- Sign up at [ElevenLabs](https://elevenlabs.io/docs/overview)
- Add `ELEVENLABS_API_KEY` to .env file

Obtain a Restack API Key to interact with the 'gpt-4.1-mini' model at no cost from [Restack Cloud](https://console.restack.io/starter)

Expand All @@ -41,7 +44,7 @@ Obtain a Restack API Key to interact with the 'gpt-4.1-mini' model at no cost fr
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start Restack Agent with Voice
Expand Down Expand Up @@ -117,6 +120,7 @@ https://github.com/livekit/agents-playground
Modify your .env in https://github.com/livekit/agents-playground/blob/main/.env.example

Run the following commands:

```bash
npm run install
```
Expand Down Expand Up @@ -165,7 +169,6 @@ The Livekit pipleine worker will connect to the room and you can start talking t

![Talk to the agent](./agent_voice_livekit.png)


## Follow the agent run

You can replay and follow the agent run in the UI.
Expand Down
2 changes: 1 addition & 1 deletion audio_transcript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This example showcases how to transcribe an mp3 audio and then translate the gen
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion child_workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This repository contains a simple example project to help you get started with c
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion encryption/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This repository contains a simple example project to help you get started with t
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion pdf_ocr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use pytorch to OCR and OpenAI to make a summary.
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion production_demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ https://lmstudio.ai
To start the Restack, use the following Docker command:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

## Start python shell
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To run Restack locally using Docker, you have two options:
Using `docker run`:

```bash
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 ghcr.io/restackio/restack:main
docker run -d --pull always --name restack -p 5233:5233 -p 6233:6233 -p 7233:7233 -p 9233:9233 -p 10233:10233 ghcr.io/restackio/restack:main
```

This will force repulling and rebuilding.
Expand Down