diff --git a/agent_apis/README.md b/agent_apis/README.md index 61143cc..e7da056 100644 --- a/agent_apis/README.md +++ b/agent_apis/README.md @@ -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 diff --git a/agent_chat/README.md b/agent_chat/README.md index b97ce76..9403fd4 100644 --- a/agent_chat/README.md +++ b/agent_chat/README.md @@ -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 @@ -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" }] } } ``` diff --git a/agent_humanloop/README.md b/agent_humanloop/README.md index c8dc800..5094e43 100644 --- a/agent_humanloop/README.md +++ b/agent_humanloop/README.md @@ -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 diff --git a/agent_rag/README.md b/agent_rag/README.md index 0dedf47..6d88b29 100644 --- a/agent_rag/README.md +++ b/agent_rag/README.md @@ -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 diff --git a/agent_stream/README.md b/agent_stream/README.md index feea715..6850df1 100644 --- a/agent_stream/README.md +++ b/agent_stream/README.md @@ -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 @@ -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" }] } } ``` diff --git a/agent_telephony/twilio_livekit/readme.md b/agent_telephony/twilio_livekit/readme.md index 1e0e212..00792e2 100644 --- a/agent_telephony/twilio_livekit/readme.md +++ b/agent_telephony/twilio_livekit/readme.md @@ -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. @@ -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 @@ -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 diff --git a/agent_telephony/vapi/agent_vapi/readme.md b/agent_telephony/vapi/agent_vapi/readme.md index 34c58b8..acd0f1c 100644 --- a/agent_telephony/vapi/agent_vapi/readme.md +++ b/agent_telephony/vapi/agent_vapi/readme.md @@ -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. @@ -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 @@ -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 diff --git a/agent_todo/README.md b/agent_todo/README.md index 5415f08..e445b81 100644 --- a/agent_todo/README.md +++ b/agent_todo/README.md @@ -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 diff --git a/agent_tool/README.md b/agent_tool/README.md index f125a9b..0b330ac 100644 --- a/agent_tool/README.md +++ b/agent_tool/README.md @@ -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 diff --git a/agent_video/README.md b/agent_video/README.md index a78b193..ffce19c 100644 --- a/agent_video/README.md +++ b/agent_video/README.md @@ -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 diff --git a/agent_voice/livekit/README.md b/agent_voice/livekit/README.md index 37e7463..5fe4b41 100644 --- a/agent_voice/livekit/README.md +++ b/agent_voice/livekit/README.md @@ -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) @@ -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 @@ -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 ``` @@ -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. diff --git a/audio_transcript/README.md b/audio_transcript/README.md index ff2f755..6971d9e 100644 --- a/audio_transcript/README.md +++ b/audio_transcript/README.md @@ -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 diff --git a/child_workflows/README.md b/child_workflows/README.md index 2e2363a..c160798 100644 --- a/child_workflows/README.md +++ b/child_workflows/README.md @@ -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 diff --git a/encryption/README.md b/encryption/README.md index 621c7a3..8d6e997 100644 --- a/encryption/README.md +++ b/encryption/README.md @@ -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 diff --git a/pdf_ocr/README.md b/pdf_ocr/README.md index 482e8b4..6e9d632 100644 --- a/pdf_ocr/README.md +++ b/pdf_ocr/README.md @@ -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 diff --git a/production_demo/README.md b/production_demo/README.md index 52cedf1..35bbb9b 100644 --- a/production_demo/README.md +++ b/production_demo/README.md @@ -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 diff --git a/readme.md b/readme.md index 20191e9..bcce409 100644 --- a/readme.md +++ b/readme.md @@ -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.