Onboarding
Starten, verfolgen und vervollständigen Sie den Talkturo-Onboarding-Assistenten über die API — erstellen Sie Workspaces, speichern Sie Assistenten-Konfigurationen, generieren Sie KI-Prompts und stellen Sie Assistenten mit Telefonnummern und Tool-Integrationen bereit.
curl -X POST "https://app.talkturo.com/api/onboarding/start" \
-H "Content-Type: application/json" \
-H "Cookie: sb-access-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example" \
-d '{
"companyName": "Meyer Dental Group",
"website": "https://meyerdental.de",
"assistantName": "Praxisassistent",
"purpose": "Terminvereinbarung und telefonische Erstaufnahme",
"clientToken": "d2a6e2c4-59d2-4f63-a9aa-4d8693d9c2cb"
}'
{
"accountId": "acc_7f3c2d91-6a8e-4b64-a5a8-9b4f3f90d8b1",
"slug": "meyer-dental-group"
}
curl -X POST "https://app.talkturo.com/api/onboarding/progress" \
-H "Content-Type: application/json" \
-H "Cookie: sb-access-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example" \
-d '{
"step": "assistant",
"patch": {
"assistantName": "Praxisassistent",
"website": "https://meyerdental.de",
"purpose": "Terminvereinbarung und telefonische Erstaufnahme",
"language": "de",
"llmProvider": "openai",
"model": "gpt-4.1-mini"
}
}'
{
"ok": true
}
curl "https://app.talkturo.com/api/onboarding/progress" \
-H "Cookie: sb-access-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example"
{
"step": "review",
"generatedPrompt": {
"prompt": "Sie sind der telefonische Assistent von Meyer Dental Group. Sie helfen Anrufern bei Terminvereinbarungen und der telefonischen Erstaufnahme.",
"firstMessage": "Guten Tag, Sie sprechen mit dem Praxisassistenten der Meyer Dental Group. Wie kann ich Ihnen helfen?"
}
}
curl -X POST "https://app.talkturo.com/api/onboarding/complete" \
-H "Content-Type: application/json" \
-H "Cookie: sb-access-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example" \
-d '{
"prompt": "Sie sind der telefonische Assistent von Meyer Dental Group. Sie helfen Anrufern bei Terminvereinbarungen und der telefonischen Erstaufnahme.",
"firstMessage": "Guten Tag, Sie sprechen mit dem Praxisassistenten der Meyer Dental Group. Wie kann ich Ihnen helfen?",
"business": {
"name": "Meyer Dental Group",
"website": "https://meyerdental.de",
"phone": "+49 30 12345678",
"industry": "Zahnarztpraxis",
"city": "Berlin",
"state": "Berlin",
"country": "DE"
}
}'
{
"assistantId": "asst_2f18d7c4-6c07-4de2-9bf3-43b5d3d44c11",
"slug": "meyer-dental-group"
}
Onboarding-API
Verwalten Sie den Talkturo-Onboarding-Assistenten vollständig über die API. Sie können einen Workspace erstellen oder übernehmen, Entwürfe für einzelne Schritte speichern, den generierten Prompt abrufen und das Onboarding mit der Bereitstellung eines Assistenten abschließen.
Basis-URL: https://app.talkturo.com
Authentifizierung: Session-Cookie (Supabase)
Endpunkte
POST /api/onboarding/start
Starten Sie einen neuen Onboarding-Ablauf und erstellen Sie den zugehörigen Workspace-Entwurf. Wenn Sie accountSlug angeben, übernimmt der Endpunkt einen vorhandenen Workspace statt einen neuen anzulegen.
Request-Body
Name des Unternehmens. Muss zwischen 1 und 100 Zeichen lang sein.
Website des Unternehmens. Optional, maximal 500 Zeichen.
Anzeigename für den Assistenten. Optional, maximal 100 Zeichen.
Freitext zur Beschreibung des Einsatzzwecks des Assistenten.
UUID-basierter Idempotenz-Schlüssel. Verwenden Sie denselben Wert erneut, um doppelte Startanfragen sicher zu vermeiden.
Übernimmt einen vorhandenen Workspace anhand seines Slugs, statt einen neuen Workspace zu erstellen.
Response-Felder
ID des Workspaces, der für das Onboarding verwendet wird.
Slug des erstellten oder übernommenen Workspaces.
POST /api/onboarding/progress
Speichern Sie den Fortschritt eines einzelnen Onboarding-Schritts. Der Endpunkt akzeptiert den aktuellen Schritt und ein partielles patch-Objekt mit den Feldern, die Sie aktualisieren möchten.
Request-Body
Aktueller Onboarding-Schritt. Erlaubte Werte sind company, assistant, voice, conversation, tools, number und review.
companyassistantvoiceconversationtoolsnumberreviewPartielle Aktualisierung für den angegebenen Schritt. Senden Sie nur die Felder, die Sie speichern oder überschreiben möchten.
Patch-Felder
Name des Assistenten.
Website des Unternehmens oder der Marke.
Beschreibung, welche Aufgaben der Assistent übernehmen soll.
Sprache des Assistenten.
LLM-Anbieter für die Prompt- und Gesprächsgenerierung.
Modellname innerhalb des gewählten LLM-Anbieters.
Anbieter für die Sprachsynthese.
Interne oder provider-spezifische ID der ausgewählten Stimme.
Lesbarer Name der ausgewählten Stimme.
Sprachcode oder Sprachbezeichnung der Stimme.
Steuert, ob der Tonfall automatisch an Unternehmen und Einsatzzweck angepasst wird.
Aktiviert Zusammenfassungen nach Anrufen.
E-Mail-Adresse für den Versand von Anrufzusammenfassungen.
Manuelle Überschreibung des generierten Prompts. Maximal 20000 Zeichen.
Manuelle Überschreibung der ersten Nachricht. Maximal 2000 Zeichen.
Kennzeichnet, dass während des Onboardings eine Telefonnummer gekauft wurde.
ID einer bereits ausgewählten Telefonnummer.
Kennzeichnet, dass der Telefonnummern-Schritt übersprungen wurde.
Liste der ausgewählten Plugin- oder Tool-Konfigurationen.
Liste ausgewählter Flow-Vorlagen, die dem Assistenten hinzugefügt werden sollen.
IDs der Wissensdatenbank-Dateien, die mit dem Assistenten verknüpft werden sollen.
Manuelle Überschreibung der Unternehmensdaten, die im Onboarding verwendet werden.
Response-Felder
Gibt bei erfolgreichem Speichern des Schritts true zurück.
GET /api/onboarding/progress
Rufen Sie den aktuellen Onboarding-Entwurf zusammen mit dem zuletzt generierten Prompt ab. Dieser Endpunkt eignet sich, um einen bestehenden Entwurf im Frontend wiederherzustellen oder den aktuellen Stand vor dem Abschluss zu prüfen.
Response-Felder
Zuletzt gespeicherter Onboarding-Schritt.
Enthält den zuletzt generierten Prompt und die erste Nachricht oder null, wenn noch keine Generierung verfügbar ist.
Vollständiger generierter System-Prompt für den Assistenten.
Generierte erste Nachricht, mit der der Assistent Gespräche beginnt.
POST /api/onboarding/complete
Schließen Sie das Onboarding ab und stellen Sie den Assistenten bereit. Sie können dabei den generierten Prompt und die erste Nachricht überschreiben oder Unternehmensdaten für die endgültige Bereitstellung ergänzen.
Request-Body
Finaler Prompt für den Assistenten. Optional, maximal 20000 Zeichen.
Finale erste Nachricht des Assistenten. Optional, maximal 2000 Zeichen.
Optionale Unternehmensdaten für die endgültige Bereitstellung des Assistenten.
Business-Felder
Name des Unternehmens.
Website des Unternehmens.
Telefonnummer des Unternehmens.
Branche des Unternehmens.
Stadt des Unternehmens.
Bundesland, Region oder Staat des Unternehmens.
Land des Unternehmens.
Response-Felder
ID des bereitgestellten Assistenten.
Slug des Workspaces, in dem der Assistent bereitgestellt wurde.
Hinweise zur Verwendung
Speichern Sie den Fortschritt schrittweise über POST /api/onboarding/progress, statt alle Daten erst am Ende zu senden. So können Sie Entwürfe wiederherstellen, den generierten Prompt prüfen und den Onboarding-Ablauf unterbrechen, ohne Eingaben zu verlieren.
Wenn Sie denselben Onboarding-Start wegen eines Netzwerkfehlers erneut senden müssen, verwenden Sie denselben clientToken. Das hilft, doppelte Workspaces oder doppelte Entwürfe zu vermeiden.