Famulor AI Replies API
KI-generierte Antwortvorschläge für Konversationen.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/famulor-io:famulor-io-ai-replies-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Famulor AI Replies API
summary: REST API für AI-Assistenten, Anrufe, Konversationen, Leads und omnichannel Kundenkommunikation.
description: 'Die Famulor Produkt-API unter `https://app.famulor.de/api`. Damit steuerst du
AI-Assistenten, startest und liest Anrufe, verwaltest Leads und Kampagnen,
versendest SMS und WhatsApp-Nachrichten, pflegst Wissensdatenbanken und
automatisierst Prozesse.
## Authentifizierung
Alle Endpunkte erwarten einen API-Key als Bearer-Token:
```
Authorization: Bearer YOUR_API_KEY
```
Den Key erstellst du in deinem Account unter im
Bereich API-Keys. Der Key wird nur einmal angezeigt.
## Webhooks
Famulor sendet Ereignisse (Post-Call, Conversation Ended, Read Receipts) an
deine URL. Die Payloads stehen im Abschnitt `webhooks` dieser Spec.
Diese Datei wird aus der offiziellen Dokumentation generiert:'
version: 1.0.0
contact:
name: Famulor Support
email: sales@famulor.io
url: https://www.famulor.io/support
license:
name: Proprietary
url: https://www.famulor.io/terms
termsOfService: https://www.famulor.io/terms
servers:
- url: https://app.famulor.de/api
description: Production
security:
- BearerAuth: []
tags:
- name: AI Replies
description: KI-generierte Antwortvorschläge für Konversationen.
paths:
/user/ai/generate-reply:
post:
tags:
- AI Replies
summary: Generate AI Reply
operationId: generateAIReply
description: 'Generates an AI reply using an assistant based on a customer identifier
Docs'
externalDocs:
description: Generate AI Reply
url: https://docs.famulor.io/api-v1/ai-replies/generate-reply
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
assistant_id:
type: integer
description: The ID of the assistant to use for reply generation. Must belong to your account.
customer_identifier:
type: string
description: 'A unique identifier for the customer. This is used to maintain conversation context across multiple messages.
**Examples**: Phone number, email address, CRM contact ID, Facebook user ID.
**Maximum length**: 255 characters.
**Important**: Always use the same format for the same customer to ensure context is correctly mapped.'
message:
type: string
description: The customer's message to reply to.
variables:
type: object
description: 'Optional context variables to pass to the assistant. These are merged with existing conversation variables.
Useful for passing customer data, session context, or other metadata that can personalize the reply.'
properties:
customer_name:
type: string
description: Customer name for personalized addressing
source:
type: string
description: Message source (e.g. `whatsapp`, `facebook`, `sms`)
order_id:
type: string
description: Order number for support requests
required:
- assistant_id
- customer_identifier
- message
responses:
'200':
description: OK
content:
application/json:
examples:
success:
summary: Success
value:
success: true
conversation_id: 7c9e6679-7425-40de-944b-e07fc1f90ae7
customer_identifier: '+14155551234'
reply: Hi John! I'd be happy to help you schedule an appointment. What day and time work best for you?
function_calls: []
ai_disabled: false
success-with-function-calls:
summary: Success (With Function Calls)
value:
success: true
conversation_id: 7c9e6679-7425-40de-944b-e07fc1f90ae7
customer_identifier: '+14155551234'
reply: I've checked our calendar and we have availability tomorrow at 2 PM and Friday at 10 AM. Which works better for you?
function_calls:
- name: check_availability
arguments:
start_date: '2025-01-08'
days: 7
result:
slots:
- 2025-01-08 14:00
- 2025-01-10 10:00
ai_disabled: false
schema:
type: object
properties:
success:
type: boolean
description: Will be `false` when an error occurs
conversation_id:
type: string
description: The UUID of the conversation. Use this to track or reference the conversation later.
customer_identifier:
type: string
description: The customer identifier provided in the request
reply:
type: string
description: The AI-generated reply to the customer message
function_calls:
type: array
description: Array of function calls the assistant made while processing the message. Empty array if no functions were called.
items:
type: object
properties:
name:
type: string
description: The name of the function that was called
arguments:
type: object
description: The arguments passed to the function
additionalProperties: true
result:
type: object
description: The result of the function call
additionalProperties: true
additionalProperties: true
ai_disabled:
type: boolean
description: Indicates whether AI replies are disabled for this conversation (e.g. due to manual takeover)
error:
type: string
description: Error message describing what went wrong
error_code:
type: string
description: 'Machine-readable error code. Possible values:
- `ASSISTANT_NOT_FOUND` - The assistant ID is invalid or does not belong to your account
- `INSUFFICIENT_BALANCE` - Your account balance is too low to process the message'
additionalProperties: true
'401':
$ref: '#/components/responses/Unauthorized'
'402':
description: Insufficient Balance
content:
application/json:
example:
success: false
error: Insufficient balance. Please top up your account.
error_code: INSUFFICIENT_BALANCE
'404':
description: Assistant Not Found
content:
application/json:
example:
success: false
error: Assistant not found or does not belong to you
error_code: ASSISTANT_NOT_FOUND
'422':
description: Validation Error
content:
application/json:
example:
message: The assistant id field is required.
errors:
assistant_id:
- The assistant id field is required.
'429':
description: Rate Limited
content:
application/json:
example:
message: Too Many Attempts.
retry_after: 60
components:
responses:
Unauthorized:
description: Fehlender oder ungültiger API-Key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Unauthenticated.
schemas:
Error:
type: object
properties:
message:
type: string
description: Menschenlesbare Fehlermeldung.
error:
type: string
description: Fehlerkennung, sofern gesetzt.
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'API-Key als Bearer-Token: `Authorization: Bearer YOUR_API_KEY`. Key erstellen unter https://app.famulor.de.'
externalDocs:
description: Famulor API-Dokumentation
url: https://docs.famulor.io/api-v1/introduction