Sim

https://docs.sim.ai/
Admin
Sim is an open-source visual workflow builder for designing and deploying AI agent workflows with a...
Tokens:578,337
Snippets:2,609
Trust Score:8.2
Update:9 months ago
Show doc for...
Tokens:
Raw
### Quick Start Docker Deployment

Source: https://docs.sim.ai/self-hosting

This snippet demonstrates the quick start process for deploying Sim Studio using Docker Compose in a production environment. It involves cloning the repository and starting the services defined in the production Docker Compose file. Ensure Docker and Docker Compose are installed.

```bash
git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d
```

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

### Caddy: Install and Configure for Sim Studio SSL

Source: https://docs.sim.ai/self-hosting/docker

This section details installing Caddy and configuring its Caddyfile to handle SSL certificates automatically for Sim Studio. It sets up reverse proxying for the main application and WebSocket connections.

```bash
# Install Caddy
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update && sudo apt install caddy
```

```caddyfile
sim.yourdomain.com {
    reverse_proxy localhost:3000

    handle /socket.io/* {
        reverse_proxy localhost:3002
    }
}
```

```bash
sudo systemctl restart caddy
```

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

### Nginx + Certbot: Install and Configure for Sim Studio SSL

Source: https://docs.sim.ai/self-hosting/docker

This section outlines the installation of Nginx and Certbot, followed by the creation of an Nginx server block to proxy requests to Sim Studio and handle WebSocket connections. It then enables the site and obtains an SSL certificate.

```bash
# Install
sudo apt install nginx certbot python3-certbot-nginx -y

# Create /etc/nginx/sites-available/sim
server {
    listen 80;
    server_name sim.yourdomain.com;

    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location /socket.io/ {
        proxy_pass http://127.0.0.1:3002;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

# Enable and get certificate
sudo ln -s /etc/nginx/sites-available/sim /etc/nginx/sites-enabled/
sudo certbot --nginx -d sim.yourdomain.com
```

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

### Install Sim Studio with Helm (GCP GKE)

Source: https://docs.sim.ai/self-hosting/kubernetes

Installs the Sim Studio Helm chart using GCP GKE-specific values. It requires the base installation secrets and overrides default configurations with settings from './helm/sim/examples/values-gcp.yaml'. Ensure 'NEXT_PUBLIC_APP_URL' is correctly set.

```bash
helm install sim ./helm/sim \
  --values ./helm/sim/examples/values-gcp.yaml \
  --set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
  --set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
  --set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
  --set app.env.NEXT_PUBLIC_APP_URL="https://sim.yourdomain.com" \
  --namespace simstudio --create-namespace
```

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

### Install Sim Studio with Helm (Basic)

Source: https://docs.sim.ai/self-hosting/kubernetes

Clones the Sim Studio repository, generates necessary secrets (BETTER_AUTH_SECRET, ENCRYPTION_KEY, INTERNAL_API_SECRET), and installs the Helm chart in the 'simstudio' namespace. Requires Kubernetes 1.19+ and Helm 3.0+.

```bash
# Clone repo
git clone https://github.com/simstudioai/sim.git && cd sim

# Generate secrets
BETTER_AUTH_SECRET=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)
INTERNAL_API_SECRET=$(openssl rand -hex 32)

# Install
helm install sim ./helm/sim \
  --set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
  --set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
  --set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
  --namespace simstudio --create-namespace
```

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

### Sim Studio Helm Chart Key Configuration Example

Source: https://docs.sim.ai/self-hosting/kubernetes

Illustrates key parameters for customizing the Sim Studio Helm deployment. This includes replica count, environment variables like NEXT_PUBLIC_APP_URL and OPENAI_API_KEY, PostgreSQL persistence settings, and Ingress configuration for external access.

```yaml
# Custom values.yaml
app:
  replicaCount: 2
  env:
    NEXT_PUBLIC_APP_URL: "https://sim.yourdomain.com"
    OPENAI_API_KEY: "sk-..."

postgresql:
  persistence:
    size: 50Gi

ingress:
  enabled: true
  className: nginx
  tls:
    enabled: true
  app:
    host: sim.yourdomain.com
```

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

### Install Sim Studio with Helm (Azure AKS)

Source: https://docs.sim.ai/self-hosting/kubernetes

Installs the Sim Studio Helm chart using Azure AKS-specific values. It requires the base installation secrets and overrides default configurations with settings from './helm/sim/examples/values-azure.yaml'. Ensure 'NEXT_PUBLIC_APP_URL' is correctly set.

```bash
helm install sim ./helm/sim \
  --values ./helm/sim/examples/values-azure.yaml \
  --set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
  --set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
  --set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
  --set app.env.NEXT_PUBLIC_APP_URL="https://sim.yourdomain.com" \
  --namespace simstudio --create-namespace
```

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

### Install Sim Studio with Helm (AWS EKS)

Source: https://docs.sim.ai/self-hosting/kubernetes

Installs the Sim Studio Helm chart using AWS EKS-specific values. It requires the base installation secrets and overrides default configurations with settings from './helm/sim/examples/values-aws.yaml'. Ensure 'NEXT_PUBLIC_APP_URL' is correctly set.

```bash
helm install sim ./helm/sim \
  --values ./helm/sim/examples/values-aws.yaml \
  --set app.env.BETTER_AUTH_SECRET="$BETTER_AUTH_SECRET" \
  --set app.env.ENCRYPTION_KEY="$ENCRYPTION_KEY" \
  --set app.env.INTERNAL_API_SECRET="$INTERNAL_API_SECRET" \
  --set app.env.NEXT_PUBLIC_APP_URL="https://sim.yourdomain.com" \
  --namespace simstudio --create-namespace
```

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

### Quick Start: Execute a Sim AI workflow with TypeScript SDK

Source: https://docs.sim.ai/sdks/typescript

A basic example demonstrating how to initialize the SimStudioClient and execute a workflow. Requires an API key and optionally a custom base URL. Handles success and error scenarios during execution.

```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';

// Initialize the client
const client = new SimStudioClient({
  apiKey: 'your-api-key-here',
  baseUrl: 'https://sim.ai' // optional, defaults to https://sim.ai
});

// Execute a workflow
try {
  const result = await client.executeWorkflow('workflow-id');
  console.log('Workflow executed successfully:', result);
} catch (error) {
  console.error('Workflow execution failed:', error);
}
```

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

### Docker Compose: Production Setup Environment Configuration

Source: https://docs.sim.ai/self-hosting/docker

This snippet generates a .env file with necessary secrets for the production environment. It includes database credentials and secrets for authentication and encryption. Ensure to replace placeholder URLs with your actual domain.

```bash
# Generate secrets
cat > .env << EOF
DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
BETTER_AUTH_SECRET=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)
INTERNAL_API_SECRET=$(openssl rand -hex 32)
NEXT_PUBLIC_APP_URL=https://sim.yourdomain.com
BETTER_AUTH_URL=https://sim.yourdomain.com
NEXT_PUBLIC_SOCKET_URL=https://sim.yourdomain.com
EOF
```

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

### Docker Compose: Start Ollama with GPU or CPU

Source: https://docs.sim.ai/self-hosting/docker

These snippets demonstrate how to start Ollama services using Docker Compose, with options for enabling GPU support or running CPU-only. The `--profile` flag is used to select the desired configuration.

```bash
# With GPU
docker compose -f docker-compose.ollama.yml --profile gpu --profile setup up -d

# CPU only
docker compose -f docker-compose.ollama.yml --profile cpu --profile setup up -d
```

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

### Docker Compose: External Ollama Setup (macOS/Windows/Linux)

Source: https://docs.sim.ai/self-hosting/docker

These snippets show how to configure Sim Studio to connect to an Ollama instance running on the host machine. It uses `host.docker.internal` for macOS/Windows or the host's IP address for Linux, setting the `OLLAMA_URL` environment variable.

```bash
# macOS/Windows
OLLAMA_URL=http://host.docker.internal:11434 docker compose -f docker-compose.prod.yml up -d

# Linux - use your host IP
OLLAMA_URL=http://192.168.1.100:11434 docker compose -f docker-compose.prod.yml up -d
```

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

### Docker Compose: Start Sim Studio Production Services

Source: https://docs.sim.ai/self-hosting/docker

This command starts the Sim Studio services using the production Docker Compose file. It assumes the environment variables in the .env file have been configured.

```bash
docker compose -f docker-compose.prod.yml up -d
```

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

### Install Docker on Linux VPS

Source: https://docs.sim.ai/self-hosting/platforms

Installs Docker using the official convenience script and adds the current user to the docker group for easier management. Requires a logout and reconnect to take effect.

```shell
# Install Docker (official method)
curl -fsSL https://get.docker.com | sudo sh
sudo usermod -aG docker $USER

# Logout and reconnect, then verify
docker --version
```

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

### Install Sim AI TypeScript SDK using npm, yarn, or bun

Source: https://docs.sim.ai/sdks/typescript

Instructions for installing the Sim AI TypeScript SDK using popular package managers like npm, yarn, and bun. Ensure you have Node.js or a compatible JavaScript runtime installed.

```bash
npm install simstudio-ts-sdk
```

```bash
yarn add simstudio-ts-sdk
```

```bash
bun add simstudio-ts-sdk
```

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

### Install Sim SDKs

Source: https://docs.sim.ai/execution

Install the official SDKs for programmatic workflow execution in TypeScript/JavaScript and Python. These packages provide the necessary tools to interact with the Sim Studio API.

```bash
# TypeScript/JavaScript
npm install simstudio-ts-sdk

# Python
pip install simstudio-sdk
```

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

### Install Sim AI Python SDK

Source: https://docs.sim.ai/sdks/python

Install the official Python SDK for Sim AI using pip. This command fetches and installs the necessary package to interact with Sim AI workflows from your Python applications.

```bash
pip install simstudio-sdk
```

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

### GET /api/v1/logs

Source: https://docs.sim.ai/execution/api

Poll for new logs, optionally filtering by workspace, start date, order, and limit. A cursor can be provided for pagination.

```APIDOC
## GET /api/v1/logs

### Description
Poll for new logs with optional filtering and pagination.

### Method
GET

### Endpoint
`/api/v1/logs`

### Query Parameters
- **workspaceId** (string) - Required - The ID of the workspace.
- **startDate** (string) - Required - The start date for fetching logs in ISO format.
- **order** (string) - Optional - The order of logs ('asc' or 'desc'). Defaults to 'asc'.
- **limit** (integer) - Optional - The maximum number of logs to return. Defaults to 100.
- **cursor** (string) - Optional - A cursor for fetching the next set of logs (pagination).

### Request Example
```javascript
let cursor = null;
const workspaceId = 'YOUR_WORKSPACE_ID';
const startDate = new Date().toISOString();

async function pollLogs() {
  const params = new URLSearchParams({
    workspaceId,
    startDate,
    order: 'asc',
    limit: '100'
  });
  
  if (cursor) {
    params.append('cursor', cursor);
  }
  
  const response = await fetch(
    `https://sim.ai/api/v1/logs?${params}`,
    {
      headers: {
        'x-api-key': 'YOUR_API_KEY'
      }
    }
  );
  
  if (response.ok) {
    const data = await response.json();
    
    // Process new logs
    for (const log of data.data) {
      console.log(`New execution: ${log.executionId}`);
    }
    
    // Update cursor for next poll
    if (data.nextCursor) {
      cursor = data.nextCursor;
    }
  }
}

// Poll every 30 seconds
setInterval(pollLogs, 30000);
```

### Response
#### Success Response (200)
- **data** (array) - An array of log objects.
  - **executionId** (string) - The ID of the execution.
- **nextCursor** (string) - A cursor for fetching the next page of logs, or null if this is the last page.
```

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

### Query Workflow Logs with GET Request

Source: https://docs.sim.ai/execution/api

This example shows the structure of a GET request to the /api/v1/logs endpoint for querying workflow execution logs. It highlights the required `workspaceId` parameter and lists various optional filters for refining the query, such as `workflowIds`, `triggers`, `level`, date ranges, and cost. Pagination parameters like `limit`, `cursor`, and `order` are also explained.

```http
GET /api/v1/logs

Required Parameters:
  * `workspaceId` - Your workspace ID

Optional Filters:
  * `workflowIds` - Comma-separated workflow IDs
  * `folderIds` - Comma-separated folder IDs
  * `triggers` - Comma-separated trigger types: `api`, `webhook`, `schedule`, `manual`, `chat`
  * `level` - Filter by level: `info`, `error`
  * `startDate` - ISO timestamp for date range start
  * `endDate` - ISO timestamp for date range end
  * `executionId` - Exact execution ID match
  * `minDurationMs` - Minimum execution duration in milliseconds
  * `maxDurationMs` - Maximum execution duration in milliseconds
  * `minCost` - Minimum execution cost
  * `maxCost` - Maximum execution cost
  * `model` - Filter by AI model used

Pagination:
  * `limit` - Results per page (default: 100)
  * `cursor` - Cursor for next page
  * `order` - Sort order: `desc`, `asc` (default: desc)

Detail Level:
  * `details` - Response detail level: `basic`, `full` (default: basic)
  * `includeTraceSpans` - Include trace spans (default: false)
  * `includeFinalOutput` - Include final output (default: false)
```

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

### Track Usage Limits Programmatically via API

Source: https://docs.sim.ai/execution/costs

This example demonstrates how to make a GET request to the /api/users/me/usage-limits endpoint to programmatically query current usage and limits. It requires an API key in the X-API-Key header for authentication.

```curl
curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" https://sim.ai/api/users/me/usage-limits
```

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

### Workflow Execution Example (Python)

Source: https://docs.sim.ai/sdks/python

Demonstrates a basic workflow execution using the SimStudioClient. It includes setting up the client, validating workflow readiness, executing the workflow with input data, and processing the results, including error handling.

```python
import os
from simstudio import SimStudioClient

client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))

def run_workflow():
    try:
        # Check if workflow is ready
        is_ready = client.validate_workflow("my-workflow-id")
        if not is_ready:
            raise Exception("Workflow is not deployed or ready")

        # Execute the workflow
        result = client.execute_workflow(
            "my-workflow-id",
            input_data={
                "message": "Process this data",
                "user_id": "12345"
            }
        )

        if result.success:
            print("Output:", result.output)
            print("Duration:", result.metadata.get("duration") if result.metadata else None)
        else:
            print("Workflow failed:", result.error)
            
    except Exception as error:
        print("Error:", error)

run_workflow()
```

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

### Kubernetes Management Commands for Sim Studio

Source: https://docs.sim.ai/self-hosting/kubernetes

Provides essential kubectl and helm commands for managing a Sim Studio deployment. Includes port-forwarding for local access, viewing logs, upgrading the deployment, and uninstalling the Helm release.

```bash
# Port forward for local access
kubectl port-forward deployment/sim-sim-app 3000:3000 -n simstudio

# View logs
kubectl logs -l app.kubernetes.io/component=app -n simstudio --tail=100

# Upgrade
helm upgrade sim ./helm/sim --namespace simstudio

# Uninstall
helm uninstall sim --namespace simstudio
```

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

### Initialize SimStudioClient in Python

Source: https://docs.sim.ai/sdks/python

Demonstrates how to initialize the SimStudioClient with your API key and an optional base URL. This client is the entry point for interacting with the Sim AI platform.

```python
from simstudio import SimStudioClient

# Initialize the client
client = SimStudioClient(
    api_key="your-api-key-here",
    base_url="https://sim.ai"  # optional, defaults to https://sim.ai
)
```

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

### Spotify Get Album Tracks API

Source: https://docs.sim.ai/tools/spotify

Get the tracks from an album.

```APIDOC
## spotify_get_album_tracks

### Description
Get the tracks from an album.

### Method
POST

### Endpoint
/spotify_get_album_tracks

### Parameters
#### Request Body
- **albumId** (string) - Yes - The Spotify album ID
- **limit** (number) - No - Number of tracks to return (1-50)
- **offset** (number) - No - Index of first track to return

### Response
#### Success Response (200)
- **tracks** (json) - List of tracks
- **total** (number) - Total number of tracks
- **next** (string) - URL for next page
```

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

### Mailchimp Start Automation

Source: https://docs.sim.ai/tools/mailchimp

Start all emails in a Mailchimp automation workflow.

```APIDOC
## POST /mailchimp_start_automation

### Description
Start all emails in a Mailchimp automation workflow.

### Method
POST

### Endpoint
/mailchimp_start_automation

### Parameters
#### Request Body
- **apiKey** (string) - Required - Mailchimp API key with server prefix
- **workflowId** (string) - Required - The unique ID for the automation workflow

### Response
#### Success Response (200)
- **success** (boolean) - Operation success status
- **output** (object) - Start confirmation
```

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

### Spotify Get Albums API

Source: https://docs.sim.ai/tools/spotify

Get details for multiple albums by their IDs.

```APIDOC
## spotify_get_albums

### Description
Get details for multiple albums by their IDs.

### Method
POST

### Endpoint
/spotify_get_albums

### Parameters
#### Request Body
- **albumIds** (string) - Yes - Comma-separated album IDs (max 20)
- **market** (string) - No - ISO country code for market

### Response
#### Success Response (200)
- **albums** (json) - List of albums
```

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

### Spotify Get Saved Albums API

Source: https://docs.sim.ai/tools/spotify

Get the user's saved albums.

```APIDOC
## spotify_get_saved_albums

### Description
Get the user's saved albums.

### Method
POST

### Endpoint
/spotify_get_saved_albums

### Parameters
#### Request Body
- **limit** (number) - No - Number of albums to return (1-50)
- **offset** (number) - No - Index of first album to return
- **market** (string) - No - ISO country code for market

### Response
#### Success Response (200)
- **albums** (json) - List of saved albums
- **total** (number) - Total saved albums
- **next** (string) - URL for next page
```

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

### Spotify Get Track API

Source: https://docs.sim.ai/tools/spotify

Get detailed information about a specific track on Spotify by its ID.

```APIDOC
## spotify_get_track

### Description
Get detailed information about a specific track on Spotify by its ID.

### Method
POST

### Endpoint
/spotify_get_track

### Parameters
#### Request Body
- **trackId** (string) - Yes - The Spotify ID of the track
- **market** (string) - No - ISO 3166-1 alpha-2 country code for track availability

### Response
#### Success Response (200)
- **id** (string) - Spotify track ID
- **name** (string) - Track name
- **artists** (array) - List of artists
- **album** (object) - Album information
- **duration_ms** (number) - Track duration in milliseconds
- **explicit** (boolean) - Whether the track has explicit content
- **popularity** (number) - Popularity score (0-100)
- **preview_url** (string) - URL to 30-second preview
- **external_url** (string) - Spotify URL
- **uri** (string) - Spotify URI for the track
```

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

### GET /persons/{personId}

Source: https://docs.sim.ai/tools/posthog

Gets detailed information about a specific person in PostHog by their ID or UUID.

```APIDOC
## GET /persons/{personId}

### Description
Gets detailed information about a specific person in PostHog by their ID or UUID.

### Method
GET

### Endpoint
/persons/{personId}

### Parameters
#### Path Parameters
- **personId** (string) - Yes - Person ID or UUID to retrieve

#### Query Parameters
- **personalApiKey** (string) - Yes - PostHog Personal API Key (for authenticated API access)
- **region** (string) - No - PostHog region: us (default) or eu
- **projectId** (string) - Yes - PostHog Project ID

### Request Example
```json
{
  "personalApiKey": "YOUR_API_KEY",
  "projectId": "YOUR_PROJECT_ID"
}
```

### Response
#### Success Response (200)
- **person** (object) - Person details including properties and identifiers

#### Response Example
```json
{
  "person": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "properties": {
      "email": "test@example.com",
      "name": "Test User"
    },
    "distinct_ids": ["user123"]
  }
}
```
```

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

### SimStudioClient Constructor

Source: https://docs.sim.ai/sdks/python

Initializes the SimStudioClient with your API key and an optional base URL.

```APIDOC
## SimStudioClient Constructor

### Description
Initializes the SimStudioClient with your API key and an optional base URL.

### Method
`SimStudioClient(api_key: str, base_url: str = "https://sim.ai")`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
from simstudio import SimStudioClient

client = SimStudioClient(api_key="your-api-key-here")
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Docker Compose: Sim Studio Management Commands

Source: https://docs.sim.ai/self-hosting/docker

This set of commands provides essential management operations for a Sim Studio Docker Compose deployment. It includes viewing logs, stopping services, updating the application, and backing up the database.

```bash
# View logs
docker compose -f docker-compose.prod.yml logs -f simstudio

# Stop
docker compose -f docker-compose.prod.yml down

# Update
docker compose -f docker-compose.prod.yml pull && docker compose -f docker-compose.prod.yml up -d

# Backup database
docker compose -f docker-compose.prod.yml exec db pg_dump -U postgres simstudio > backup.sql
```

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

### Spotify Get Tracks API

Source: https://docs.sim.ai/tools/spotify

Get detailed information about multiple tracks on Spotify by their IDs (up to 50).

```APIDOC
## spotify_get_tracks

### Description
Get detailed information about multiple tracks on Spotify by their IDs (up to 50).

### Method
POST

### Endpoint
/spotify_get_tracks

### Parameters
#### Request Body
- **trackIds** (string) - Yes - Comma-separated list of Spotify track IDs (max 50)
- **market** (string) - No - ISO 3166-1 alpha-2 country code for track availability

### Response
#### Success Response (200)
- **tracks** (array) - List of tracks
```

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

### GET /zoom/meetings/{meetingId}

Source: https://docs.sim.ai/tools/zoom

Get detailed information about a specific Zoom meeting, including details and invitations.

```APIDOC
## GET /zoom/meetings/{meetingId}

### Description
Get detailed information about a specific Zoom meeting, including details and invitations.

### Method
GET

### Endpoint
/zoom/meetings/{meetingId}

### Parameters
#### Path Parameters
- **meetingId** (string) - Required - The meeting ID
#### Query Parameters
- **occurrenceId** (string) - Optional - Occurrence ID for recurring meetings
- **showPreviousOccurrences** (boolean) - Optional - Show previous occurrences for recurring meetings

### Response
#### Success Response (200)
- **meeting** (object) - The meeting details

#### Response Example
```json
{
  "meeting": {
    "id": "1234567890",
    "topic": "Project Kickoff",
    "startTime": "2024-11-20T14:00:00Z",
    "joinUrl": "https://zoom.us/j/1234567890?pwd=...",
    "password": "123456"
  }
}
```
```

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

### Configure SimStudio Client with Environment Variables (Production)

Source: https://docs.sim.ai/sdks/typescript

Demonstrates setting up the SimStudioClient for production, emphasizing configuration via environment variables. It includes mandatory API key validation and provides a default `SIM_BASE_URL` if not explicitly set, ensuring a reliable connection to the SimStudio service.

```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';

// Production configuration with validation
const apiKey = process.env.SIM_API_KEY;
if (!apiKey) {
  throw new Error('SIM_API_KEY environment variable is required');
}

const client = new SimStudioClient({
  apiKey,
  baseUrl: process.env.SIM_BASE_URL || 'https://sim.ai'
});
```

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

### Example .env File Configuration - Environment Variables

Source: https://docs.sim.ai/self-hosting/environment-variables

An example of how to configure environment variables in a .env file for Sim Studio. This demonstrates the expected format for essential variables like database URLs, authentication secrets, API keys, and public URLs.

```dotenv
DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
BETTER_AUTH_SECRET=<openssl rand -hex 32>
BETTER_AUTH_URL=https://sim.yourdomain.com
ENCRYPTION_KEY=<openssl rand -hex 32>
INTERNAL_API_SECRET=<openssl rand -hex 32>
NEXT_PUBLIC_APP_URL=https://sim.yourdomain.com
NEXT_PUBLIC_SOCKET_URL=https://sim.yourdomain.com
OPENAI_API_KEY=sk-...
```

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

### Spotify Get Album API

Source: https://docs.sim.ai/tools/spotify

Get detailed information about an album on Spotify by its ID, including track listing.

```APIDOC
## spotify_get_album

### Description
Get detailed information about an album on Spotify by its ID, including track listing.

### Method
POST

### Endpoint
/spotify_get_album

### Parameters
#### Request Body
- **albumId** (string) - Yes - The Spotify ID of the album
- **market** (string) - No - ISO 3166-1 alpha-2 country code for track availability

### Response
#### Success Response (200)
- **id** (string) - Spotify album ID
- **name** (string) - Album name
- **artists** (array) - List of artists
- **album_type** (string) - Type of album (album, single, compilation)
- **total_tracks** (number) - Total number of tracks
- **release_date** (string) - Release date
- **label** (string) - Record label
- **popularity** (number) - Popularity score (0-100)
- **genres** (array) - List of genres
- **image_url** (string) - Album cover image URL
- **tracks** (array) - List of tracks on the album
- **external_url** (string) - Spotify URL
```

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

### API Headers Example

Source: https://docs.sim.ai/blocks/api

Illustrates the configuration of HTTP headers for an API request. Common headers like Content-Type and Authorization are shown, which are crucial for authentication and content negotiation.

```text
Key: Content-Type
Value: application/json

Key: Authorization
Value: Bearer your_token_here
```

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

### GET /insights/{insightId}

Source: https://docs.sim.ai/tools/posthog

Gets a specific insight by ID from PostHog. Returns detailed insight configuration, filters, and metadata.

```APIDOC
## GET /insights/{insightId}

### Description
Gets a specific insight by ID from PostHog. Returns detailed insight configuration, filters, and metadata.

### Method
GET

### Endpoint
/insights/{insightId}

### Parameters
#### Path Parameters
- **insightId** (string) - Yes - The insight ID to retrieve

#### Query Parameters
- **apiKey** (string) - Yes - PostHog Personal API Key
- **projectId** (string) - Yes - The PostHog project ID
- **region** (string) - No - PostHog cloud region: "us" or "eu" (default: "us")

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "projectId": "YOUR_PROJECT_ID"
}
```

### Response
#### Success Response (200)
- **insight** (object) - Detailed insight configuration, filters, and metadata

#### Response Example
```json
{
  "insight": {
    "id": "insight1",
    "name": "New Users Over Time",
    "filters": { ... },
    "dashboard": null
  }
}
```
```

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

### API Query Parameters Example

Source: https://docs.sim.ai/blocks/api

Demonstrates how to define key-value pairs for query parameters that will be appended to the API request URL. These parameters are essential for filtering or specifying data in the request.

```text
Key: apiKey
Value: your_api_key_here

Key: limit
Value: 10
```

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

### Deploy Sim Studio with Docker Compose

Source: https://docs.sim.ai/self-hosting/platforms

Clones the Sim Studio repository, creates a .env file with necessary secrets and environment variables, and starts the application using Docker Compose in production mode.

```shell
git clone https://github.com/simstudioai/sim.git && cd sim

# Create .env with secrets
cat > .env << EOF
DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
BETTER_AUTH_SECRET=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)
INTERNAL_API_SECRET=$(openssl rand -hex 32)
NEXT_PUBLIC_APP_URL=https://sim.yourdomain.com
BETTER_AUTH_URL=https://sim.yourdomain.com
NEXT_PUBLIC_SOCKET_URL=https://sim.yourdomain.com
EOF

# Start
docker compose -f docker-compose.prod.yml up -d
```
Tokens:
Raw