Willkommen

Willkommen in der Welt von Raisetalk, einer Plattform, die Ihre Interaktionen in verwertbare Informationen verwandelt. Unsere API, verfügbar unter https://api.raisetalk.com, ermöglicht es Ihnen, unsere Funktionen einfach in Ihre bestehenden Tools zu integrieren, um:

• Audioanrufe zuverlässig in Text zu transkribieren.
• Gespräche zu analysieren, um wertvolle Erkenntnisse zu gewinnen.
• Prozesse zu automatisieren und die Effizienz Ihrer Teams zu verbessern.

Diese Dokumentation führt Sie Schritt für Schritt durch die Nutzung unserer REST-Endpoints.

Authentifizierung

Die Raisetalk-API verwendet ein auf Bearer-Tokens basierendes Authentifizierungssystem, um den Zugang zu ihren Endpoints zu sichern.

Erstanmeldung

Verwenden Sie Ihre E-Mail und Ihr Passwort, um sich über den Endpoint /login zu authentifizieren. Nach erfolgreicher Anmeldung wird Ihnen ein eindeutiger Bearer-Token zurückgegeben.

Beispielanfrage

POST {{host}}/login

{
  "password": "myC0mplicatedpass_ord",
  "email": "john.doe@company.com"
}

Beispielantwort bei Erfolg

Code http 200

{
  "result": "success",
  "accessToken": "5c06ec916af844faac30c822055d1f77b3abgb3f259477330750ce570f851324",
  "expiration": "2024-12-01 00:00:00+00:00",
  "user": {
    (einige Informationen über Sie)
  },
  "rights": [
	  (Liste Ihrer Rechte)
  ]
}

Beispielantwort bei Fehler

Code http 403

{
  "result": "error",
  "message": "Unexpected error #798a34a1",
  "error": {
    "user": {
      "rule": "Unexpected error #35b505bf"
    }
  }
}

Verwendung des Bearer-Tokens

Der erhaltene Token muss im Authorization-Header aller nachfolgenden Anfragen enthalten sein, um auf geschützte Endpoints zuzugreifen.

Header-Format:

Authorization: Bearer {{ ihr_token }}

Wichtige Hinweise

• Bearer-Tokens haben eine begrenzte Gültigkeitsdauer (siehe das Feld expiration in der Login-Antwort).
• Bevor Ihr Token abläuft, verwenden Sie den Endpoint /refreshToken, um einen neuen zu generieren.
• Stellen Sie sicher, dass Sie Ihren Token niemals an Dritte weitergeben.
• Bei Authentifizierungsproblemen wird eine Antwort mit dem Status 403 Forbidden zurückgegeben. Überprüfen Sie dann Ihre Anmeldedaten oder die Gültigkeit Ihres Tokens.

Token-Aktualisierung

Wenn Ihr Token sich seinem Ablaufdatum nähert, müssen Sie ihn aktualisieren.

Beispielanfrage

POST {{host}}/refreshToken

Beispielantwort bei Erfolg

Code http 200

{
  "result": "success",
  "accessToken": "b63066930a0b2a2e75194f8c1d1cb6a5bcPe04fb526da5035b0ad5d4f1b89dc4",
  "expiration": "2024-12-01 00:00:00+00:00"
}

Beispielantwort bei Fehler Code http 403

{
  "result": "error",
  "message": "Unexpected error #2d34957c",
  "error": "Invalid access token"
}

Zeitzone

Raisetalk verwendet IANA-Zeitzonen-Identifikatoren (TZDB, siehe Wikipedia), auch bekannt als "tz database names", die der anerkannte Standard für die Zeitzonenverwaltung in den meisten modernen Systemen sind.

Diese Identifikatoren können über den Header X-Timezone angegeben werden.

Diese Identifikatoren haben die Form:

• Kontinent/Stadt (Beispiele: Europe/Paris, America/New_York, Asia/Tokyo)
• Oder Aliase wie UTC, GMT, etc.

Gültige Beispiele

Ungültige Beispiele

Fallback

Wenn eine fehlerhafte Zeitzone angegeben wird oder keine Zeitzone definiert ist, werden die Aufrufe als GMT betrachtet.

Gespräche

Ein Gespräch zur Analyse senden

Die zu analysierenden Gespräche werden über ein Formular vom Typ multipart/form-data an Raisetalk übermittelt und umfassen

• die zu sendende Datei
• die Kontextinformationen des Gesprächs, genannt "Etiketten"

Minimale Beispielanfrage

POST /upload/create

Formulardaten:

• file: die hochzuladende Datei
• language: die im Gespräch verwendete Sprache, aus: fr, en, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi
• model_id: die Kennung des zu verwendenden Analyserasters. Beziehen Sie sich dazu auf die Liste der Raster in der Raisetalk-Oberfläche.
• analysis_region: Region, in der die Daten verarbeitet werden sollen, aus: eu, us
• transcription_model: das zu verwendende Speech-to-Text-Transkriptionsmodell

  Siehe die Liste der Transkriptionsmodelle.

• summaries_model: das LLM-Modell für die Zusammenfassungsgenerierung, Stimmungen und Einstellungen.

  Siehe die Liste der Analysemodelle.

• questions_model: das LLM-Modell für die Kriterienanalyse.

  Siehe die Liste der Analysemodelle.

• callback: die optionale Callback-URL, an die Raisetalk die Verarbeitungsergebnisse senden soll
• anonymization: Array personenbezogener Daten (PBD), die anonymisiert werden sollen, unter folgenden Werten: account_number, banking_information, blood_type, credit_card_cvv, credit_card_expiration, credit_card_number, date, date_of_birth, drivers_license, drug, email_address, event, gender_sexuality, healthcare_number, injury, ip_address, language, location, medical_condition, medical_process, money_amount, nationality, number_sequence, occupation, organization, passport_number, password, person_age, person_name, phone_number, political_affiliation, religion, url, us_social_security_number, username, vehicle_id.
• speakers: definiert die Rolle der Gesprächsteilnehmer. Wert aus: salesperson_prospect, advisor_customer

Analyse in einer anderen Sprache

Wenn Sie kompatible Speech-to-Text-Transkriptionsmodelle verwenden, können Sie verlangen, dass die Analyse in einer Zielsprache bereitgestellt wird, über den Parameter analysis_language, der folgende Werte akzeptiert: fr, en, en_US, en_AU, en_UK, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi.

Transkriptionsübersetzung

Wenn Sie kompatible Transkriptionsmodelle verwenden, können Sie verlangen, dass die Transkription in einer Zielsprache bereitgestellt wird, über den Parameter transcription_language, der folgende Werte akzeptiert: fr, en, en_US, en_AU, en_UK, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi.

Beispielantwort bei Erfolg

Code http 200

{
  "result": "success",
  "upload": {
    "id": 215,
    "analysis_region": "eu",
    "model_id": 41,
    "transcription_model": "best",
    "summaries_model": "gemini-2.0-flash-001",
    "questions_model": "gemini-2.0-flash-001",
    "originalFilename": "sample_audio_recording.mp3",
    "storedFilename": "6e200fd8102fe6b3.mp3",
    "mediaType": "audio/mp3",
    "size": 8800586,
    "length": 1057.3474166666667,
    "speakers": "salesperson_prospect",
    "language": "fr",
    "analysis_language":"en",
    "transcription_language":"es"
    "callback": null
  },
  "setAttributes": [],
  "uptodateAttributes": [],
  "attachedUser": "User not set.",
  "anonymization": [
    "email_address",
    "ip_address",
    "person_age"
  ],
}

Beispielantwort bei Fehler

Code http 403

{
  "result": "error",
  "message": "Unexpected error #2d34957c",
  "error": "Invalid access token"
}

{
  "result": "error",
  "message": "Unexpected error #36cb15b4",
  "error": {
    "body": "You must provide minimum information about your upload."
  }
}

{
  "result": "error",
  "message": "Unexpected error #36cb15b4",
  "error": {
    "summaries_model": "Models allow in `us` region are: anthropic/claude-3-5-sonnet, anthropic/claude-3-haiku"
  }
}

Transkriptionsmodelle

Lesen Sie unseren Artikel über Transkriptionsmodelle: https://www.raisetalk.com/de/blog/raisetalk-speech-to-text-modelle-fuer-gespraechsanalyse

Analysemodelle

Blogartikel in Kürze.