### Install Dependencies and Start Services

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

These npm commands are used to install project dependencies and start the development server for the Node.js application. This setup allows the application to sync with Restack services for agent execution.

```bash
npm install
npm run dev
```

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

### Install Dependencies and Start Development Server

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

Installs project dependencies using npm and starts the development server. This command is essential for running the Node.js application that syncs with Restack services.

```bash
npm install
npm run dev
```

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

### Install Dependencies and Run Development Servers

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/voice/readme.md

Installs project dependencies using pnpm and starts the development server and services. Requires OPENAI_API_KEY and DEEPGRAM_API_KEY to be set in the .env file.

```bash
pnpm i

pnpm dev-server
pnpm dev-services
```

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

### Install Dependencies and Run Operator

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/posthog/readme.md

Commands to install project dependencies using pnpm and then start the development server for the operator.

```bash
pnpm i
```

```bash
pnpm dev
```

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

### Install Dependencies and Start Services

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Commands to install project dependencies using pnpm and start the development servers for both the frontend and backend applications. Leverages TurboRepo for efficient parallel execution.

```bash
pnpm i
pnpm run dev
```

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

### Start Restack Services and Install Dependencies

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/human-loop/readme.md

These commands are used to install project dependencies and start the development server for your Restack AI agent. Ensure you have Node.js and pnpm installed.

```bash
pnpm i
pnpm dev
```

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

### Run Frontend with Browser Microphone

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/voice/readme.md

Starts the frontend application for use with the browser microphone. Assumes dependencies are installed.

```bash
pnpm dev
```

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

### Install Dependencies and Start Node.js App

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

These npm commands are used to install the project's dependencies and start the Node.js development server. This prepares the application to sync and execute agents with Restack.

```bash
npm install
npm run dev
```

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

### Install Dependencies and Start Services

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

Installs project dependencies using npm and starts the Node.js development server. This command is essential for running the TypeScript application and syncing with Restack services.

```bash
npm install
npm run dev
```

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

### Install and Run Restack Services

Source: https://github.com/restackio/examples-typescript/blob/main/features-alpha/encryption/readme.md

These commands are used to install project dependencies using pnpm and then start the development server. Ensure the OPENAI_API_KEY environment variable is set in a .env file.

```bash
pnpm i

pnpm dev
```

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

### Install Dependencies and Start Services

Source: https://github.com/restackio/examples-typescript/blob/main/child-workflows/readme.md

Installs project dependencies using pnpm and starts the Node.js application, which includes two Restack Services for workflow execution and synchronization with the Restack engine.

```bash
pnpm i
pnpm dev
```

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

### Install Dependencies and Start Services

Source: https://github.com/restackio/examples-typescript/blob/main/agent-apis/readme.md

Installs project dependencies using npm and then starts the development server for the application.

```bash
npm install
npm run dev
```

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

### Install Dependencies and Start Node.js App

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

These npm commands are used to install project dependencies and start the Node.js development server. This process also syncs the code with Restack services to execute agents.

```bash
npm install
npm run dev
```

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

### Install Dependencies and Start Livekit Pipeline

Source: https://github.com/restackio/examples-typescript/blob/main/agent-voice/livekit/readme.md

Commands to install Node.js dependencies and start the Livekit pipeline service for voice processing.

```bash
cd /agent-voice/livekit/livekit-pipeline/
npm install
npm run dev
```

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

### Install Dependencies and Start Agent Stream

Source: https://github.com/restackio/examples-typescript/blob/main/agent-voice/livekit/readme.md

Commands to install Node.js dependencies and start the agent stream service for realtime agent interaction.

```bash
cd /agent-voice/livekit/agent-stream/
npm install
npm run dev
```

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

### Install Restack Web UI

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/posthog/readme.md

Installs the Restack Web UI using Docker. This command downloads the latest Restack image and runs it in detached mode, exposing necessary ports for the UI.

```dockerfile
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
```

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

### Install Dependencies and Run Livekit Agents Playground

Source: https://github.com/restackio/examples-typescript/blob/main/agent-voice/livekit/readme.md

Commands to install dependencies and start the Livekit Agents Playground for interacting with the AI agent.

```bash
npm run install
npm run dev
```

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

### Install and Run Livekit Pipeline Service

Source: https://github.com/restackio/examples-typescript/blob/main/agent-telephony/twilio-livekit/readme.md

Commands to install Node.js dependencies and start the Livekit pipeline service in the '/livekit-pipeline' directory.

```bash
npm install
npm run dev
```

```bash
pnpm install
pnpm run dev
```

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

### Install Restack Web UI with Docker

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/voice/readme.md

Deploys the Restack Web UI using a Docker container. This command downloads the latest Restack image and maps the necessary ports for the UI to be accessible.

```bash
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
```

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

### Install Restack Web UI with Docker

Source: https://github.com/restackio/examples-typescript/blob/main/features-alpha/encryption/readme.md

This command installs and runs the Restack Web UI using Docker. It maps several ports for communication and uses the latest main branch of the Restack image.

```bash
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
```

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

### Install and Run Agent Service

Source: https://github.com/restackio/examples-typescript/blob/main/agent-telephony/twilio-livekit/readme.md

Commands to install Node.js dependencies and start the Restack agent service in the '/agent' directory.

```bash
npm install
npm run dev
```

```bash
pnpm install
pnpm run dev
```

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

### Run Development Server

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/apps/frontend/README.md

Commands to start the Next.js development server using different package managers (npm, yarn, pnpm, bun). This allows for local development and testing.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

This command starts the Restack service in a Docker container. It exposes several ports required for Restack's operation and ensures the latest version is pulled.

```bash
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
```

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

### Install Restack Web UI with Docker

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/human-loop/readme.md

This command installs and runs the Restack Web UI using Docker. It exposes the necessary ports for the application to function correctly.

```bash
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
```

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

### Schedule a Workflow

Source: https://github.com/restackio/examples-typescript/blob/main/features-alpha/encryption/readme.md

This command schedules an example workflow to run immediately. It should be executed in a separate shell after the main services have started.

```bash
pnpm schedule
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This command starts the Restack service in a Docker container. It exposes several ports required for Restack's operation and ensures the latest version is pulled.

```bash
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 Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This command starts the Restack service in detached mode using Docker. It exposes several ports required for Restack's operation and pulls the latest 'main' version of the Restack image from GitHub Container Registry.

```bash
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
```

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

### API Endpoint to Run Agents

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This is the HTTP POST endpoint used to programmatically trigger agent execution. You send a request to this URL to start an agent, likely `agentChatTool` based on the context.

```APIDOC
POST http://localhost:6233/api/agents/agentChatTool
```

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

### Start Restack Studio with Docker

Source: https://github.com/restackio/examples-typescript/blob/main/child-workflows/readme.md

Launches the Restack Studio using a Docker container. This command pulls the latest Restack image and exposes the necessary ports for the studio to run.

```bash
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
```

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

### Troubleshoot Port Conflicts

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/voice/readme.md

Provides commands to identify and terminate processes that are using a specific port, commonly encountered when a service fails to start due to an address already in use error.

```bash
lsof -i :4000
kill 1234
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Command to run the Restack backend service using Docker. It exposes several ports required for Restack's operation and ensures the latest version is pulled.

```bash
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 Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

This command starts the Restack service in detached mode using Docker. It exposes several ports required for Restack's operation and pulls the latest main branch image.

```bash
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
```

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

### Trigger Twilio Call

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/voice/readme.md

Initiates a Twilio voice call after starting the ngrok funnel. This is used to test voice call integration with Restack.

```bash
pnpm call
```

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

### API Endpoint to Run Agent Chat

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This is the API endpoint used to initiate an agent chat. A POST request to this URL will start the agent, allowing for subsequent interactions.

```APIDOC
POST http://localhost:6233/api/agents/agentChat
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

This command starts the Restack service in detached mode using Docker. It exposes several ports required for Restack's operation and pulls the latest main version of the Restack image.

```bash
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
```

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

### Vercel Deployment Configuration for Frontend

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Configuration settings for deploying the frontend application to Vercel. Specifies the root directory and the build command to use.

```bash
Root directory

agent-reactflow/apps/frontend

Build command

turbo run build --filter=@agent-reactflow/frontend
```

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

### Run Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Example of how to trigger an agent flow using a POST request to the Restack API endpoint.

```bash
POST http://localhost:6233/api/agents/agentFlow
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-telephony/twilio-livekit/readme.md

Command to run the Restack Docker container. It exposes necessary ports for Restack services.

```bash
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
```

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

### Run Agent via Client Command

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This command executes a TypeScript file (`scheduleAgent.ts`) that connects to Restack and runs the `agentChat` agent. It's an example of triggering agent execution from a client-side script.

```bash
npm schedule-agent
```

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

### Restack Cloud Deployment Configuration for Backend

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Configuration details for deploying the backend application on Restack Cloud, including the custom Dockerfile path and the application folder.

```bash
Custom Dockerfile path

/agent-reactflow/Dockerfile

Application folder

/agent-reactflow
```

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

### Schedule Digest Workflow

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/posthog/readme.md

Command to schedule the digest workflow, which likely processes new recordings and generates digests daily.

```bash
pnpm schedule
```

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

### Schedule an Agent Immediately

Source: https://github.com/restackio/examples-typescript/blob/main/refactor-needed/human-loop/readme.md

This command schedules an agent to run immediately. It is used to trigger the execution of your agent, typically defined in a `scheduleAgent` file.

```bash
pnpm schedule
```

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

### Send Event to Agent via API (Message)

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Example of sending a specific event with input data to an agent run using a PUT request to the Restack API.

```json
{
  "name": "idVerification",
  "input": {
    "type": "id",
    "documentNumber": "1234567890"
  }
}
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-apis/readme.md

This command starts the Restack service in detached mode using Docker. It exposes multiple ports required for Restack's operation and pulls the latest main branch image.

```bash
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
```

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

### Run Agent via CLI

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Command to execute a scheduled agent flow using a client script.

```bash
pnpm schedule-agent
```

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

### Run Agent via Client

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

Executes a TypeScript file (`scheduleAgent.ts`) that connects to Restack and runs a predefined agent (`agentTodo`). This demonstrates programmatic agent execution.

```bash
npm run schedule
```

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

### Run Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

This API endpoint allows you to trigger agent execution programmatically. It's a POST request to the Restack service.

```APIDOC
POST http://localhost:6233/api/agents/agentStream
```

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

### Next.js Font Optimization

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/apps/frontend/README.md

Demonstrates the use of `next/font` for automatic optimization and loading of Google Fonts, specifically the Inter font, in a Next.js application.

```typescript
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load Inter, a custom Google Font.
```

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

### Execute Agent with Client

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

This command executes a TypeScript file that connects to Restack and runs a scheduled agent. It requires modifying agentId and runId in the script.

```bash
pnpm event-agent
```

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

### Create Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-telephony/twilio-livekit/readme.md

API endpoint to create a new agent named 'AgentTwilio'. This action initiates a Livekit WebRTC room setup.

```APIDOC
POST http://localhost:6233/api/agents/AgentTwilio
```

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

### Run Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

This is the API endpoint to trigger the `agentChatRAG` agent. It uses the POST method to initiate an agent run.

```APIDOC
POST http://localhost:6233/api/agents/agentChatRAG
```

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

### Send Event to Agent via CLI

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Command to execute a client script that sends an event to a running agent.

```bash
pnpm event-agent
```

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

### Send Event to Agent via API (End)

Source: https://github.com/restackio/examples-typescript/blob/main/agent-reactflow/README.md

Example of sending an 'end' event to terminate an agent conversation using a PUT request to the Restack API.

```json
{
  "eventName": "end"
}
```

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

### API Event Payload Examples

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

These JSON payloads are used with the API endpoint to send events to an agent. The `message` event includes user input, while the `end` event signals the termination of the interaction.

```json
{
  "eventName": "message",
  "eventInput": { "content": "Sales on boots?" }
}
```

```json
{
  "eventName": "end"
}
```

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

### Run Agent via Client Script

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This command executes a TypeScript script (`scheduleAgent.ts`) that connects to Restack and runs a specific agent named `agentChatTool`. This is an alternative to running agents via the UI or direct API calls.

```bash
npm run schedule
```

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

### Schedule Parent Workflow

Source: https://github.com/restackio/examples-typescript/blob/main/child-workflows/readme.md

Executes a script to schedule the parent workflow within the Restack environment.

```bash
pnpm schedule-workflow
```

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

### Run Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

This is an HTTP POST request to trigger an agent execution through the Restack API. It targets the `agentTodo` agent on the local development server.

```APIDOC
POST http://localhost:6233/api/agents/agentTodo
```

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

### Start Restack Docker Container

Source: https://github.com/restackio/examples-typescript/blob/main/agent-voice/livekit/readme.md

Command to run Restack in detached mode using Docker. It exposes several ports required for Restack services.

```bash
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
```

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

### API Payload for Ending Conversation

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

The JSON payload structure for signaling the end of a conversation with an agent via the API.

```json
{
  "eventName": "end"
}
```

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

### API Payload for Sending Messages

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

The JSON payload structure for sending user messages to an agent via the API. It includes the event name and the message content.

```json
{
  "eventName": "messages",
  "eventInput": {
    "messages": [{ "role": "user", "content": "tell me another joke" }]
  }
}
```

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

### Send Events to Agent via Client Command

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This command executes a TypeScript file (`eventAgent.ts`) to send events to a running agent. It demonstrates how to programmatically interact with an agent by sending messages and ending the conversation.

```bash
pnpm event-agent
```

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

### Run Agent via Client Script

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

This command executes a TypeScript script (`scheduleAgent.ts`) that connects to Restack and runs the `agentChatRAG` agent. It's a way to programmatically trigger agent execution.

```typescript
npm run schedule
```

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

### Send Message Event Payload

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This JSON payload is used with the agent event API to send a message to the agent. The `eventName` is 'message', and `eventInput` contains the message content.

```json
{
  "eventName": "message",
  "eventInput": { "content": "Sales on boots?" }
}
```

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

### Send Event to Agent via Client

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

Executes a TypeScript file (`eventAgent.ts`) that connects to Restack and sends events to an agent. It requires modification of `agentId` and `runId` within the file.

```bash
npm run event
```

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

### Send Events to Agent via Client Script

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This command executes a TypeScript script (`eventAgent.ts`) to send events to a running Restack agent. The script requires modification to specify the correct `agentId` and `runId`. It demonstrates sending multiple events, including one to generate another agent and one to end the conversation.

```bash
npm run event
```

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

### Send End Event Payload

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This JSON payload is used with the agent event API to signal the end of a conversation or interaction with the agent. The `eventName` is set to 'end'.

```json
{
  "eventName": "end"
}
```

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

### Send Events to Agent via Client Script

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

This command executes a TypeScript script (`eventAgent.ts`) which connects to Restack and sends events to a running agent. It demonstrates how to interact with an agent programmatically by sending messages or ending a conversation.

```typescript
npm run event
```

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

### API Endpoint to Send Events to Agent

Source: https://github.com/restackio/examples-typescript/blob/main/agent-tool/readme.md

This HTTP PUT endpoint allows sending events to a specific agent run. It requires the `agentId` and `runId` in the URL path. The request body contains the `eventName` (e.g., 'message', 'end') and `eventInput`.

```APIDOC
PUT http://localhost:6233/api/agents/agentChatTool/:agentId/:runId
```

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

### Send Message Event to Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

This is an HTTP PUT request to send a 'message' event to a specific agent run. It includes the event name and input payload, such as a todo item description.

```APIDOC
PUT http://localhost:6233/api/agents/agentTodo/:agentId/:runId

Payload:
{
  "eventName": "message",
  "eventInput": { "content": "Create todo to send email to CEO" }
}
```

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

### Send End Event to Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-todo/readme.md

This is an HTTP PUT request to send an 'end' event to a specific agent run, signaling the termination of the conversation or task.

```APIDOC
PUT http://localhost:6233/api/agents/agentTodo/:agentId/:runId

Payload:
{
  "eventName": "end"
}
```

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

### Send Events to Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-stream/readme.md

This API endpoint allows sending events to a running agent. You can send messages or signal the end of a conversation. It requires the agent ID and run ID.

```APIDOC
PUT http://localhost:6233/api/agents/agentStream/:agentId/:runId
```

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

### API Payload for Sending Messages

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This JSON payload is sent to the agent event API to deliver a message to the agent. The `content` field within `eventInput` contains the actual message text.

```json
{
  "eventName": "message",
  "eventInput": { "content": "tell me another joke" }
}
```

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

### Send Events to Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-rag/readme.md

This API endpoint allows sending events to a specific agent run. It supports sending messages with content or signaling the end of a conversation.

```APIDOC
PUT http://localhost:6233/api/agents/agentChatRAG/:agentId/:runId
```

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

### API Endpoint to Send Events to Agent

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This API endpoint is used to send events, such as messages or termination signals, to a specific agent run. It requires the agent's ID and the run ID to target the correct conversation.

```APIDOC
PUT http://localhost:6233/api/agents/AgentChat/:agentId/:runId
```

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

### Run Agent using uv client

Source: https://github.com/restackio/examples-typescript/blob/main/agent-apis/readme.md

Executes the schedule-workflow command using the 'uv' Python environment manager to connect to Restack and execute a workflow.

```bash
uv run schedule-workflow
```

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

### Run Agent using pip and Python script

Source: https://github.com/restackio/examples-typescript/blob/main/agent-apis/readme.md

Executes a Python script named 'schedule_workflow.py' using the 'python -c' command. This script is responsible for connecting to Restack and running the 'multistepWorkflow'.

```python
from src.schedule_workflow import run_schedule_workflow; run_schedule_workflow()
```

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

### API Payload for Ending Conversation

Source: https://github.com/restackio/examples-typescript/blob/main/agent-chat/readme.md

This JSON payload is sent to the agent event API to signal the end of a conversation with the agent. It's a simple payload with `eventName` set to `end`.

```json
{
  "eventName": "end"
}
```

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

### Create Agent via API

Source: https://github.com/restackio/examples-typescript/blob/main/agent-voice/livekit/readme.md

API endpoint and JSON payload to create a new agent named 'agentVoice'. Requires a 'room_id' obtained from the Livekit Agents Playground.

```APIDOC
POST http://localhost:6233/api/agents/agentVoice

Request Body:
{
  "room_id": "room_id"
}
```