### Example Enterprise Setup Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/microsoft-teams/enterprise-setup

This JSON object represents an example configuration for enterprise setup, specifying the name, environment, and status.

```json
{
  "name": "Enterprise Setup",
  "environment": "production",
  "status": "enabled"
}
```

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

### Example Advanced Setup Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/google-calendar/advanced-setup

This JSON object represents an example configuration for an advanced setup, likely used within an automation or assistant workflow. It specifies the name, environment, and status of the setup.

```json
{
  "name": "Advanced Setup",
  "environment": "production",
  "status": "enabled"
}
```

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

### Medical Practice Setup Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

Illustrates a ClickUp setup for medical practice management, covering patient follow-ups, equipment maintenance, and compliance audits.

```text
Medical Practice Setup:
├─ Patient follow-ups → HIPAA-compliant task management
├─ Equipment maintenance → Recurring task schedules
├─ Insurance claims → Document workflows with deadlines
├─ Staff training → Educational task assignments
└─ Compliance audits → Checklist-based task templates
```

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

### Famulor Slack App Installation Guide

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/slack

Provides step-by-step instructions for installing the Famulor Automation app in a Slack workspace, including required permissions and OAuth scopes.

```text
1. Slack Workspace → Apps & Integrations
2. Search and install "Famulor Automation"
3. Grant workspace permissions:
   ✅ Channels: Read, Write, Join
   ✅ Users: Read (for @mentions)
   ✅ Files: Upload (for call recordings)
   ✅ Workflows: Trigger (for automation)

OAuth Scopes:
├─ chat:write → Send messages
├─ channels:read → Access channel list
├─ users:read → Team member info
├─ files:write → File uploads
└─ workflow.steps:execute → Workflow triggers
```

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

### ClickUp Workspace Setup Guide

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

Details the initial setup steps for a ClickUp workspace to be used with voice integration, including creating spaces and defining custom fields.

```text
ClickUp Account Setup:
1. Create workspace for voice integration
2. Add team members with correct permissions
3. Define custom fields for call data:
   ├─ Call ID (Text)
   ├─ Call Duration (Number)
   ├─ Client Priority (Dropdown)
   ├─ Revenue Impact (Currency)
   └─ Follow-up Required (Checkbox)

Create template spaces:
📁 "Client Projects" (for new clients)
📁 "Internal Operations" (for internal tasks)
📁 "Support & Maintenance" (for service calls)
```

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

### Voice-to-ClickUp Campaign Setup Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

Demonstrates how a marketing agency can use voice commands to automatically set up a campaign in ClickUp, including spaces, goals, lists, and task distribution.

```text
Client Call: "Product launch campaign for Q1, budget €50k"

Automatic ClickUp Orchestration:
📁 Space: "Client XY - Q1 Launch"

📊 Goal: "Q1 product launch - generate 10,000 leads"
├─ Target: 10,000 qualified leads
├─ Budget: €50,000
├─ Timeline: 12 weeks
└─ Success Metrics: CTR, CPL, conversion rate

📋 Campaign Lists:
├─ "Strategy & Planning" (week 1-2)
├─ "Creative Development" (week 2-4)
├─ "Media Planning" (week 3-5)
├─ "Campaign Execution" (week 6-10)
└─ "Analysis & Optimization" (week 11-12)

Automatic Task Distribution:
👨‍💼 Strategist: Market research, persona development
🎨 Designer: Visual assets, landing pages
📊 Media Buyer: Channel strategy, budget allocation
📈 Analyst: Tracking setup, reporting dashboard
```

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

### Automate Trello Board Setup for Marketing Campaigns

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/trello

This example shows how to set up a Trello board for a marketing campaign, including lists for different stages and auto-generated tasks with assigned members and due dates. Useful for coordinating multi-channel campaigns.

```Trello Automation
Marketing Director Call: "Q2 campaign is launching, coordinate all channels"

Campaign Board Setup:
📋 Board: "Q2 Product Launch Campaign"
📊 Lists: Strategy → Creative → Production → Review → Launch → Analysis

🎯 Campaign Tasks (Auto-generated):
├─ Card: "Target Audience Research"
│   ├─ List: Strategy
│   ├─ Member: @market-researcher
│   ├─ Due: 1 week
│   └─ Checklist: Demographics, Psychographics, Competitor Analysis

├─ Card: "Creative Concept Development"
│   ├─ List: Creative
│   ├─ Member: @creative-director
│   ├─ Due: 2 weeks
│   └─ Checklist: Visual Identity, Copy Strategy, Brand Guidelines

├─ Card: "Social Media Content Creation"
│   ├─ List: Production
│   ├─ Member: @social-media-manager
│   ├─ Due: 3 weeks
│   └─ Checklist: Instagram Posts, Facebook Ads, LinkedIn Content

└─ Card: "Performance Tracking Setup"
    ├─ List: Launch
    ├─ Member: @analytics-specialist
    ├─ Due: 4 weeks
    └─ Checklist: KPI Definition, Dashboard Setup, Reporting Schedule

Cross-Board Dependencies:
🔗 Sales Board: Lead capture process update
🔗 Product Board: Feature highlight coordination
🔗 Support Board: FAQ update for campaign questions
```

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

### Healthcare Practice Notion Setup Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/notion

Provides a structure for setting up Notion for a medical practice, covering patient logs, knowledge bases, and compliance documentation.

```text
Medical Practice Notion Setup:
├─ Patient Interaction Logs (HIPAA-compliant)
├─ Medical Knowledge Base (Treatment protocols)
├─ Research Documentation (Clinical studies)
├─ Team Training Materials (Certification tracking)
└─ Compliance Documentation (Audit trails)
```

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

### Automate Trello Board Setup for Event Management

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/trello

This example demonstrates setting up a Trello board for event management, including lists for different phases and detailed task breakdowns with specific requirements. Useful for organizing corporate conferences.

```Trello Automation
Client Call: "Corporate conference for 500 participants, 3 months timeline"

Event Management Board:
📋 Board: "Corporate Conference 2024"
📊 Lists: Planning → Vendor Coordination → Marketing → Execution → Post-Event

🎪 Event Task Breakdown:
├─ Venue Selection (Planning)
│   ├─ Capacity: 500+ people
│   ├─ Location: Central, parking
│   ├─ Technical: A/V equipment, WiFi
│   ├─ Catering: Space for lunch/coffee breaks
│   └─ Budget: €15,000 maximum

├─ Speaker Coordination (Vendor Coordination)
│   ├─ Keynote speaker: Industry expert
│   ├─ Panel discussions: 3 sessions
│   ├─ Workshop leaders: 6 parallel sessions
│   ├─ Travel/accommodation: Arrangements
│   └─ Technical requirements: Presentation setup

├─ Marketing Campaign (Marketing)
│   ├─ Registration website: Custom landing page
│   ├─ Social media: LinkedIn, Twitter promotion
│   ├─ Email campaign: Target audience outreach
│   ├─ Print materials: Brochures, banners
│   └─ Press release: Industry publications

└─ Day of Execution (Execution)
    ├─ Setup crew: 6:00 AM start
    ├─ Registration desk: Check-in process
    ├─ Technical support: A/V monitoring
    ├─ Catering coordination: Meal service management
    └─ Cleanup crew: Post-event teardown

Timeline Management:
⏰ 12 weeks before event: Venue + speaker bookings  
⏰ 8 weeks before event: Marketing launch  
⏰ 4 weeks before event: Final confirmations  
⏰ 1 week before event: Final preparations  
⏰ Event day: Execution coordination  
⏰ 1 week after event: Post-event analysis
```

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

### Install Famulor Skill via OpenCode

Source: https://docs.famulor.io/en/mcp/famulor-skill

Fetch and follow installation instructions for the Famulor Skill from the specified URL for OpenCode.

```text
Fetch and follow instructions from https://raw.githubusercontent.com/bekservice/Famulor-Skill/refs/heads/main/.opencode/INSTALL.md
```

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

### Quick Start: Make Your First Call with Famulor CLI

Source: https://docs.famulor.io/en/developers/overview

A command-line guide to authenticate and make your first voice call using Famulor. This includes setting the API key, listing assistants, and initiating a call.

```bash
# 1. Set API key (replace YOUR_API_KEY)
export FAMULOR_API_KEY="your_actual_api_key_here"

# 2. List assistants
curl -X GET "https://app.famulor.de/api/user/assistants" \
  -H "Authorization: Bearer $FAMULOR_API_KEY"

# 3. Make a call
curl -X POST "https://app.famulor.de/api/user/make_call" \
  -H "Authorization: Bearer $FAMULOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+4915123456789",
    "assistant_id": 123,
    "variables": {
      "customer_name": "Test Kunde"
    }
  }'
```

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

### Start Campaign Request

Source: https://docs.famulor.io/en/api-reference/campaigns/update-status

Send a POST request with the campaign ID and 'start' action to initiate a campaign.

```json
{
  "campaign_id": 2324,
  "action": "start"
}
```

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

### Install Mintlify CLI

Source: https://docs.famulor.io/en/development

Install the Mintlify command-line interface globally using npm. Ensure Node.js version 19 or higher is installed.

```bash
npm i -g mint
```

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

### ROI Calculator Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

This example details the potential cost savings and productivity gains from integrating ClickUp with other tools, calculating the monthly ROI.

```text
Tool Consolidation Savings (10-Person Team):
├─ Project Management: €100/month saved
├─ Time Tracking: €80/month saved
├─ Document Management: €60/month saved
├─ Goal Tracking: €40/month saved
├─ Team Communication: €120/month saved
Total Tool Savings: €400/month

Productivity Gains:
├─ Task Management Efficiency: 12h/week saved
├─ Communication Overhead: 8h/week reduced
├─ Status Update Meetings: 6h/week eliminated
Total Time Savings: 26h/week × €75/h = €1,950/week

Monthly ROI:
├─ Tool Savings: €400
├─ Productivity Gains: €7,800
├─ ClickUp + Integration Costs: €800
├─ Net Benefit: €7,400/month
└─ ROI: 925%
```

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

### Example Template Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/airtable/templates

This JSON structure represents an example configuration for a template, including its name, environment, and status.

```json
{
  "name": "Templates",
  "environment": "production",
  "status": "enabled"
}
```

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

### Example Sap Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/sap

This JSON object represents an example configuration for Sap, specifying its name, environment, and status.

```json
{
  "name": "Sap",
  "environment": "production",
  "status": "enabled"
}
```

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

### Install Famulor Skill via Codex

Source: https://docs.famulor.io/en/mcp/famulor-skill

Fetch and follow installation instructions for the Famulor Skill from the specified URL for Codex.

```text
Fetch and follow instructions from https://raw.githubusercontent.com/bekservice/Famulor-Skill/refs/heads/main/.codex/INSTALL.md
```

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

### Example Flow Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/activecampaign/best-practices

This JSON object represents an example flow configuration, specifying its name, environment, and status.

```json
{
  "name": "Best Practices",
  "environment": "production",
  "status": "enabled"
}
```

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

### Example Signal Configuration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/signal

This JSON structure represents an example configuration for the Signal integration, specifying its name, environment, and status.

```json
{
  "name": "Signal",
  "environment": "production",
  "status": "enabled"
}
```

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

### Step 1: Prepare Notion Workspace

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/notion

Details the initial setup required in a Notion workspace, including creating databases and page templates.

```text
Notion Workspace Setup:
1. Create workspace for voice integration
2. Define database templates:
   ├─ 📞 Call Notes (Meeting documentation)
   ├─ 👥 Contacts (CRM-style contact management)
   ├─ 📋 Projects (Project tracking)
   ├─ 💡 Ideas (Innovation capture)
   └─ 📚 Knowledge Base (Information repository)

3. Create page templates:
   ├─ Client Meeting Template
   ├─ Support Call Template
   ├─ Internal Meeting Template
   └─ Project Update Template
```

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

### REST API GET Example Query Parameters

Source: https://docs.famulor.io/en/automation-platform/mid-call-tools/integration-templates/api-vorlagen

Example of query parameters for a REST API GET request. This includes parameters to specify which data to include in the response.

```json
{
  "include": "profile,settings"
}
```

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

### Start Local Development Server

Source: https://docs.famulor.io/en/development

Navigate to your docs directory containing docs.json and run this command to start a local preview server. The preview will be available at http://localhost:3000.

```bash
mint dev
```

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

### Installment Payment Plan Setup

Source: https://docs.famulor.io/en/automation-platform/mid-call-tools/integration-templates/stripe-integration

Outlines a series of Payment Intents for an enterprise deal with installment payments, including details for each installment and automation steps for follow-ups and notifications.

```yaml
Enterprise Deal Context:
  Total: €50,000 enterprise license
  Payment plan: 3 installments of €16,667 each
  
Payment Intent series:
  Installment 1 (immediate): amount: 1666700, description: "Installment 1/3 Enterprise License"
  Installment 2 (+30 days): Scheduled Payment Intent
  Installment 3 (+60 days): Scheduled Payment Intent
  
Automation:
  - Successful installment 1 → Feature activation  
  - Scheduled installments → Automatic follow-up calls  
  - Payment failure → Account manager notification  
```

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

### REST API GET Example

Source: https://docs.famulor.io/en/automation-platform/mid-call-tools/integration-templates/api-vorlagen

Template for making a GET request to a REST API. It includes details on the function name, HTTP method, endpoint, and query parameters.

```APIDOC
## REST API GET Example

### Description
Template for making a GET request to a REST API. It includes details on the function name, HTTP method, endpoint, and query parameters.

### Method
GET

### Endpoint
https://api.example.com/users/{user_id}

### Parameters
#### Query Parameters
- **include** (string) - Optional - Specifies which user details to include in the response.

### Request Example
```json
{
  "include": "profile,settings"
}
```

### Response
#### Success Response (200)
- **name** (string) - The name of the user.
- **email** (string) - The email address of the user.
- **status** (string) - The status of the user.

### Success Template
"User {{name}} ({{email}}) has status {{status}}."
```

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

### Gather Information for PBX Extension Setup

Source: https://docs.famulor.io/en/provisioning/sip-ai/sip-integration

Lists the essential details required for setting up a PBX extension integration.

```text
Extension number: e.g., 1000
Server address: e.g., pbx.company.com
Username: Your extension username
Password: Your extension password
```

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

### Get Call Response Example

Source: https://docs.famulor.io/en/api-reference/user/calls/get

This is an example of a successful 200 response when retrieving call details. It includes all fields associated with a call, such as ID, assistant information, transcript, costs, and timestamps.

```json
{
  "id": 123,
  "assistant_name": "Sales Assistant",
  "campaign_name": "Q4 Outreach Campaign",
  "type": "outbound",
  "duration": 245,
  "assistant_phone_number": "+1234567890",
  "client_phone_number": "+1987654321",
  "status": "completed",
  "transcript": "Hello, this is Sarah from Famulor. How are you doing today?",
  "variables": {
    "customer_name": "John Smith",
    "interest_level": "high",
    "follow_up_date": "2025-08-15"
  },
  "evaluation": {
    "sentiment": "positive",
    "outcome": "qualified_lead",
    "score": 8.5
  },
  "webhook_response": {
    "status": "success",
    "data": {
      "crm_contact_id": "abc123"
    }
  },
  "carrier_cost": 0.02,
  "total_cost": 0.025,
  "answered_by": "human",
  "recording_url": "https://awsstorage.famulor.de/calls/123.mp3",
  "created_at": "2025-08-04 14:30:00",
  "updated_at": "2025-08-04 14:34:05"
}
```

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

### Create Conversation using JavaScript

Source: https://docs.famulor.io/en/api-reference/ai-chatbot/create-conversation

Start a new conversation with an AI assistant in JavaScript. This example uses the Fetch API to send the request.

```javascript
const response = await fetch("https://app.famulor.de/api/conversations", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer YOUR_API_KEY",
  },
  body: JSON.stringify({
    assistant_id: "550e8400-e29b-41d4-a716-446655440000",
    type: "widget",
    variables: {
      customer_name: "John Smith",
      company: "Acme Corp",
      source: "pricing_page",
    },
  }),
});

const data = await response.json();
```

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

### List Assistants

Source: https://docs.famulor.io/en/api-reference/assistants/list

This example demonstrates how to list all assistants. The response includes details such as initial message, system prompt, creation and update timestamps, and various configuration settings.

```json
{
  "data": [
    {
      "initial_message": "Good day! I'm calling from Famulor...",
      "system_prompt": "You are a friendly sales assistant...",
      "flows_platform_id": null,
      "timezone": "Europe/Berlin",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "max_silence_duration": 3,
      "reengagement_interval": 5,
      "deleted_at": null,
      "end_call_on_voicemail": 1,
      "llm_temperature": "0.7",
      "voice_stability": "0.8",
      "voice_similarity": "0.9",
      "allow_interruptions": true,
      "enable_noise_cancellation": true,
      "endpoint_sensitivity": 0.5,
      "speech_speed": "1.0",
      "endpoint_type": "vad",
      "wait_for_customer": false,
      "mode": "pipeline",
      "language_id": 1,
      "transcriber_provider_id": 1,
      "synthesizer_provider_id": 1,
      "llm_model_id": 1,
      "multimodal_model_id": null,
      "ambient_sound": "office",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "send_webhook_only_on_completed": true,
      "include_recording_in_webhook": false,
      "interrupt_sensitivity": 0.3,
      "filler_config": {
        "enabled": true,
        "phrases": ["Hmm...", "I understand..."]
      },
      "knowledgebase_id": 100,
      "knowledgebase_mode": "semantic",
      "min_interrupt_words": 2,
      "ambient_sound_volume": "0.3",
      "widget_settings": {
        "enabled": false
      }
    }
  ],
  "current_page": 1,
  "per_page": 10,
  "total": 1,
  "last_page": 1
}
```

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

### Get SIP Trunk - Not Found Response

Source: https://docs.famulor.io/en/api-reference/sip-trunks/get

This example illustrates the response when a SIP trunk with the specified ID does not exist. An error message is returned.

```json
{
  "error": "SIP trunk not found."
}
```

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

### Example Sales Prompt

Source: https://docs.famulor.io/en/outbound-calls/scripts-and-prompts

This prompt guides the AI to act as a sales bot, introducing a new product and offering a discount or scheduling a call.

```plaintext
"You are the Sales Bot for ACME Corp. Greet politely, mention the new product launch, and offer a 10% discount if the lead is interested. If they ask for more info, invite them to schedule a call with a human agent. If they refuse or express disinterest, politely end the call."
```

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

### Example: Product Team Feature Request Management

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/notion

Demonstrates a Notion setup for a product team to manage feature requests derived from customer calls.

```text
Customer call: "We need an API for mobile integration"

Notion Product Management:
📋 Feature Requests Database:
├─ 📱 Feature: "Mobile API Integration"
├─ 🏢 Requested by: [Customer link]
├─ 💼 Business Value: High (Enterprise client)
├─ 🔥 Urgency: Medium
├─ 👥 Stakeholders: [Customer contact], [Account manager]
├─ 📊 Impact Score: 85/100 (AI-calculated)
└─ 🛣️ Product Roadmap Position: Q2 2024

Automatic Cross-References:
🔗 Related Features: [[API Gateway]], [[Mobile SDK]]
📚 Technical Docs: [[API Architecture]], [[Mobile Guidelines]]
🎯 OKRs: [[Customer Satisfaction]], [[API Adoption]]
💡 Ideas Database: Similar requests from other clients

Development Workflow triggered:
✅ Epic created in [[Product Roadmap]]
✅ Technical research task assigned
✅ Customer interview scheduled for requirements
✅ Competitive analysis initiated
```

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

### Bash Script for OpenAI API Key Setup

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/openai

Provides step-by-step instructions in bash for setting up OpenAI API access, including account creation, key generation, and dashboard configuration.

```bash
# OpenAI API Key Setup
1. Create OpenAI account: https://platform.openai.com
2. Generate API key
3. Enter it in Famulor dashboard: Settings > Integrations > OpenAI
4. Select model (GPT-4 Turbo recommended)
```

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

### Construction Workflow Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

This example outlines a typical construction workflow using ClickUp, detailing how different aspects like site inspections and material orders can be managed.

```text
Construction Workflow:
├─ Site inspections → Photo tasks with GPS location
├─ Material orders → Procurement lists with budgets
├─ Safety issues → High-priority emergency tasks
├─ Client changes → Change order approval workflows
└─ Progress updates → Milestone tracking with photos
```

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

### Get SIP Trunk - Success Response

Source: https://docs.famulor.io/en/api-reference/sip-trunks/get

This example shows a successful retrieval of a SIP trunk's details. It includes all properties of the SIP trunk object.

```json
{
  "data": {
    "id": 42,
    "phone_number": "1000",
    "sip_username": "myuser",
    "sip_address": "sip.provider.com",
    "sip_calling_format": "+e164",
    "inbound_authorization_type": "auth",
    "allowed_inbound_ips": null,
    "outbound_proxy": false,
    "country_code": "US",
    "inbound_trunk_id": "ST_xxxxxxxxxxxx",
    "outbound_trunk_id": "ST_yyyyyyyyyyyy",
    "created_at": "2026-03-31T10:00:00.000000Z",
    "updated_at": "2026-03-31T10:00:00.000000Z"
  }
}
```

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

### Gmail API Setup Steps

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/gmail

This bash script outlines the essential steps for configuring the Gmail API within Google Cloud Console and the Famulor Dashboard. It includes enabling APIs, creating OAuth credentials, and setting necessary scopes.

```bash
# Gmail API configuration
1. Google Cloud Console → Enable APIs
   - Gmail API
   - Google Workspace Admin SDK
   
2. Create OAuth 2.0 credentials:
   - Client ID for Famulor app
   - Authorized redirect URIs
   - Scopes: gmail.send, gmail.modify, gmail.labels

3. Famulor Dashboard → Gmail Integration:
   - Complete OAuth flow
   - Grant permissions
   - Send test email
```

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

### Successful 200 Response for Get Tool

Source: https://docs.famulor.io/en/api-reference/mid-call-tools/get-tool

This example shows a successful response when retrieving details for a specific tool. It includes all properties of the tool, such as its ID, name, endpoint, schema, and timestamps.

```json
{
  "id": 1,
  "name": "get_weather",
  "description": "Use this tool to get the current weather in a specific city. Call this when the customer asks about weather conditions.",
  "endpoint": "https://api.openweathermap.org/data/2.5/weather",
  "method": "GET",
  "timeout": 10,
  "headers": [
    {
      "name": "Content-Type",
      "value": "application/json"
    },
    {
      "name": "Authorization",
      "value": "Bearer sk_..."
    }
  ],
  "schema": [
    {
      "name": "city",
      "type": "string",
      "description": "The city name to get weather for"
    },
    {
      "name": "temperature",
      "type": "number",
      "description": "Current temperature value"
    },
    {
      "name": "is_raining",
      "type": "boolean",
      "description": "Whether it is currently raining"
    }
  ],
  "created_at": "2025-10-10T12:00:00.000000Z",
  "updated_at": "2025-10-10T12:00:00.000000Z"
}
```

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

### Shopify App Installation Steps

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/shopify

Follow these steps to install the Famulor AI Phone Assistant from the Shopify App Store and grant necessary permissions.

```bash
1. Shopify Admin → Apps → App Store  
2. Search for "Famulor AI Phone Assistant"  
3. Install & grant permissions:  
   ✅ Read products  
   ✅ Create/edit orders  
   ✅ Read/edit customers  
   ✅ Manage inventory  
   ✅ Process payments  
   ✅ View analytics
```

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

### Monday.com Workspace Setup for Voice Integration

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/monday

Provides a step-by-step guide for setting up a Monday.com workspace to support voice integrations, including creating board templates and configuring custom columns.

```text
Monday.com Account Setup:
1. Create workspace for voice integration
2. Define board templates:
   ├─ 📋 Project Management Template
   ├─ 🎯 Sales Pipeline Template
   ├─ 🚀 Product Development Template
   ├─ 📊 Marketing Campaign Template
   └─ 🛠️ Support Ticketing Template

3. Configure custom column types:
   ├─ 📞 Call Reference (Text)
   ├─ ⭐ Call Priority (Status)
   ├─ 💰 Revenue Impact (Numbers)
   ├─ 📅 Follow-up Date (Date)
   └─ 🏷️ Call Tags (Tags)
```

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

### Get WhatsApp Templates in Python

Source: https://docs.famulor.io/en/api-reference/whatsapp/get-templates

This Python example shows how to retrieve WhatsApp message templates using the `requests` library. It iterates through the returned templates and prints their name, language, and body text.

```python
import requests

sender_id = 12

response = requests.get(
    f'https://app.famulor.de/api/user/whatsapp/senders/{sender_id}/templates',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

templates = response.json()['data']
for template in templates:
    print(f"{template['name']} ({template['language']}): {template['body_text']}")
```

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

### Unified Workflow Examples

Source: https://docs.famulor.io/en/automation-platform/integrations/communication-collaboration-hub

Illustrates common cross-platform workflows for lead qualification, incident response, and performance reviews.

```text
Unified Workflow Examples:
🔄 Lead Qualification Workflow:
   Call → Slack alert → Teams CRM update → Zoom demo → WhatsApp follow-up

⚠️ Incident Response Workflow:
   Crisis call → Multi-channel alert → Zoom war room → Teams documentation → Slack status updates

📊 Performance Review Workflow:
   Review call → Teams performance dashboard → Slack team update → Zoom 1:1 meetings → Email action plans
```

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

### API Request Example

Source: https://docs.famulor.io/en/api-reference/authentication

Sample cURL command demonstrating proper API request authentication. Remember to substitute YOUR_API_KEY with your real API key.

```bash
curl -X GET "https://app.famulor.de/api/user/campaigns" \
     -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Check WhatsApp Session Status with Python

Source: https://docs.famulor.io/en/api-reference/whatsapp/session-status

This Python example uses the requests library to check the WhatsApp session status. It sends a GET request with the necessary headers and parameters, then parses the JSON response to determine the session's state.

```python
import requests

response = requests.get(
    'https://app.famulor.de/api/user/whatsapp/session-status',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params={
        'sender_id': 12,
        'recipient_phone': '+1234567890'
    }
)

data = response.json()
session = data['session_status']

if session['can_send_freeform']:
    print('Session is active — freeform messages allowed')
else:
    print('Session expired — use a template message')
```

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

### System Prompt Example for Order Status Tool

Source: https://docs.famulor.io/en/ai-assistants/custom-mid-call-tools

Provides an example of how to instruct an AI assistant on when and how to use the 'check_order' tool within its system prompt.

```text
When to use the check_order tool:
1. Customer asks about order status
2. Mentions tracking or delivery
3. Wants to know where their package is

How to use it:
1. Ask for the order number if not provided
2. Verify format (ORD-XXXXX)
3. Use tool to retrieve status
4. Explain results in simple terms
```

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

### Visual Workflow Orchestration Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/monday

This example demonstrates how a call input is translated into a structured Monday.com board with groups, items, statuses, and custom columns, showcasing visual project flow.

```text
Call Input: "New Marketing Project - Product Launch Q2"

Automatic Monday.com Setup:
🎨 Board: "Q2 Product Launch - Marketing Campaign"

📊 Board Structure:
├─ 🎯 Group: "Strategy & Planning"
│   ├─ 📝 Item: "Market Research" [Status: Working on it 🟡]
│   ├─ 📝 Item: "Competitor Analysis" [Status: Stuck 🔴]
│   └─ 📝 Item: "Target Audience Definition" [Status: Done ✅]
├─ 🎨 Group: "Creative Development"
│   ├─ 📝 Item: "Brand Guidelines" [Status: Not started ⚪]
│   ├─ 📝 Item: "Visual Assets Creation" [Status: Working on it 🟡]
│   └─ 📝 Item: "Video Production" [Status: Not started ⚪]
└─ 🚀 Group: "Launch Execution"
    ├─ 📝 Item: "Campaign Setup" [Status: Not started ⚪]
    ├─ 📝 Item: "Performance Monitoring" [Status: Not started ⚪]
    └─ 📝 Item: "Results Analysis" [Status: Not started ⚪]

Custom Columns Automatically Created:
├─ 👤 Person: [Team assignment based on skills]
├─ 📅 Timeline: [Deadline calculated from launch date]
├─ 💰 Budget: [Budget allocation per phase]
├─ 🎯 Priority: [AI-assessed priority level]
├─ 🏷️ Tags: [Auto-tags: Marketing, Q2, Product Launch]
└─ 📊 Progress: [Percentage tracker]
```

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

### Install Famulor Skill via Gemini CLI

Source: https://docs.famulor.io/en/mcp/famulor-skill

Install the Famulor Skill extension using the Gemini CLI. Ensure you have the CLI installed.

```bash
gemini extensions install https://github.com/bekservice/Famulor-Skill
```

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

### Pipedrive Follow-up Activities Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/pipedrive

Shows examples of follow-up activities automatically scheduled after key sales events like demo scheduling or objection handling.

```text
After Demo Scheduling:
├─ Demo Activity: 03/20, 15:00 (planned)
├─ Demo Prep: 03/20, 14:00 (reminder for AE)
├─ Follow-up Call: 03/21, 10:00 (for feedback)
└─ Proposal Deadline: 03/25 (if demo successful)

After Objection Handling:
├─ Research Task: Competitive Analysis
├─ Internal Meeting: Pricing Strategy Discussion
├─ Follow-up Call: Objection Resolution
└─ Case Study Send: Relevant Success Story
```

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

### ClickUp Voice-Controlled Project Structure Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

Demonstrates how a voice command can automatically generate a hierarchical project structure within ClickUp, including spaces, folders, lists, and tasks.

```text
Call Input: "New project for Client ABC - Website Redesign"

Automatic ClickUp Structure:
📁 Space: "Client ABC"
  ├─ 📋 Folder: "Website Redesign Q4"
  │   ├─ 📝 List: "Design Phase"
  │   │   ├─ ✅ Task: "Create wireframes"
  │   │   ├─ ✅ Task: "Design mockups"
  │   │   └─ ✅ Task: "Incorporate client feedback"
  │   ├─ 📝 List: "Development Phase"
  │   └─ 📝 List: "Testing & Launch"
  └─ 📊 Goals: Website performance targets
```

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

### ROI Calculation Example

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/activecampaign

Demonstrates a sample ROI calculation for the ActiveCampaign integration. This example shows how to quantify the additional revenue and calculate the return on investment.

```text
Monthly calls: 500
Conversion uplift: +16% (from 12% to 28%)
Additional conversions: 80
Average deal value: €3,500
Additional revenue: €280,000/month

Integration cost: €2,000/month
ROI: 14,000% (or 140:1)
Break-even: Day 3
```

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

### Error Response Example

Source: https://docs.famulor.io/en/api-reference/whatsapp/send-freeform

This is an example of an error response when the sender is offline.

```APIDOC
## Error Responses

```json 503 Sender Offline theme={null} theme={null}
{
  "success": false,
  "error": "Sender is not online. Current status: Offline",
  "error_code": "SENDER_OFFLINE"
}
```
```

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

### Install Node.js Dependencies

Source: https://docs.famulor.io/en/mcp/client

Install the necessary Node.js dependencies for the Famulor MCP project after cloning the repository.

```bash
npm install
```

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

### Initial Audio Script Structure Example

Source: https://docs.famulor.io/en/ai-assistants/initial-message

An example script structure for an initial audio greeting, combining a greeting, company name, and purpose or question.

```text
"Hello! This is ABC Company calling about your recent inquiry. How are you today?"
```

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

### ClickUp API Integration Setup

Source: https://docs.famulor.io/en/automation-platform/integrations/einzelintegrations/clickup

Provides instructions for enabling API integration with ClickUp, including generating an API token and noting necessary IDs for subsequent configuration.

```text
ClickUp API Setup:
1. User Settings → Apps
2. Generate API Token:
   ✅ Full workspace access
   ✅ Read/write tasks
   ✅ Create spaces/lists
   ✅ Manage custom fields
   ✅ Time tracking access

3. Note team ID and space IDs
4. Perform permission testing
```

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

### PBX Extension Integration Example

Source: https://docs.famulor.io/en/provisioning/sip-ai/sip-integration

Illustrates a scenario for PBX extension integration where a specific extension is dedicated to the AI assistant.

```text
Your office uses extensions 1001-1010 for staff
You set up extension 1011 for the AI assistant
Calls to 1011 go to the AI
The AI can make calls appearing as extension 1011
```

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

### Example Structured Prompt Section: Available Tools

Source: https://docs.famulor.io/en/ai-assistants/example-prompts/general-prompt-engineering-guide

Lists the tools available to the AI assistant, along with a brief description of their purpose. Ensure tool names and descriptions are clear.

```text
## Available Tools

  - **kalender_buchen**: Use this tool to book appointments
  - **kundendaten_abrufen**: Use this tool to retrieve customer data
  - **anruf_weiterleiten**: Use this tool to forward calls
```