Skip to main content
POST
https://app.famulor.de/api/
/
conversations
Create conversation
curl --request POST \
  --url https://app.famulor.de/api/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "<string>",
  "type": "<string>",
  "variables": {
    "customer_name": "<string>",
    "company": "<string>",
    "source": "<string>"
  }
}
'
{
  "status": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "history": [
    {
      "role": "assistant",
      "content": "Hello John Smith! Welcome to Acme Corp support. How can I help you today?"
    }
  ]
}
Create a new conversation with your Famulor AI assistant. Use this endpoint to start a widget or test conversation and receive the initial history.

​
Request Body

​
assistant_id
string
required
UUID of the assistant that should handle the conversation
​
type
string
default:"widget"
Conversation type. Options: widget (paid) or test (free for development)
​
variables
object
Custom variables injected into the assistant context (accessible via {{variable_name}})

​
Request Examples

curl -X POST "https://app.famulor.de/api/conversations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "assistant_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "widget",
    "variables": {
      "customer_name": "John Smith",
      "company": "Acme Corp",
      "source": "pricing_page"
    }
  }'

​
Response Fields

​
status
boolean
required
Indicates whether the request succeeded
​
conversation_id
string
required
UUID of the created conversation; use it for subsequent messages
​
history
array
Initial conversation history. Empty if the assistant has no initial message.

​
Response Examples

{
  "status": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "history": [
    {
      "role": "assistant",
      "content": "Hello John Smith! Welcome to Acme Corp support. How can I help you today?"
    }
  ]
}

​
Notes

  • type: "widget" conversations are billed; type: "test" is free for development.
  • Provide meaningful variables to personalize the assistant’s first reply.
  • Continue the chat with Send Message and fetch history with Get Conversation.