Bienvenida

Bienvenido al universo de Raisetalk, una plataforma diseñada para transformar sus interacciones en información procesable. Nuestra API, disponible en https://api.raisetalk.com, le permite integrar fácilmente nuestras funcionalidades en sus herramientas existentes para:

• Transcribir llamadas de audio a texto de manera fiable.
• Analizar conversaciones para extraer información valiosa.
• Automatizar procesos y mejorar la eficiencia de sus equipos.

Esta documentación le guiará paso a paso en el uso de nuestros endpoints REST.

Autenticación

La API de Raisetalk utiliza un sistema de autenticación basado en tokens Bearer para asegurar el acceso a sus endpoints.

Inicio de sesión

Utilice su email y contraseña para autenticarse a través del endpoint /login. Una vez validado el inicio de sesión, se le devolverá un token Bearer único.

Solicitud tipo

POST {{host}}/login

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

Respuesta tipo en caso de éxito

Código http 200

{
  "result": "success",
  "accessToken": "5c06ec916af844faac30c822055d1f77b3abgb3f259477330750ce570f851324",
  "expiration": "2024-12-01 00:00:00+00:00",
  "user": {
    (alguna información sobre usted)
  },
  "rights": [
	  (lista de sus permisos)
  ]
}

Respuesta tipo en caso de error

Código http 403

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

Uso del token Bearer

El token obtenido debe incluirse en el encabezado Authorization de todas las solicitudes posteriores para acceder a los endpoints protegidos.

Formato del encabezado:

Authorization: Bearer {{ su_token }}

Notas importantes

• Los tokens Bearer tienen un período de validez limitado (consulte el campo expiration en la respuesta del login).
• Antes de que su token expire, utilice el endpoint /refreshToken para generar uno nuevo.
• Asegúrese de nunca compartir su token con terceros.
• En caso de problema de autenticación, se devolverá una respuesta con el estado 403 Forbidden. Verifique entonces sus credenciales o la validez de su token.

Actualización de token

Cuando su token se acerca a su fecha de expiración, debe actualizarlo.

Solicitud tipo

POST {{host}}/refreshToken

Respuesta tipo en caso de éxito

Código http 200

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

Respuesta tipo en caso de error Código http 403

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

Zona horaria

Raisetalk utiliza los identificadores de zonas horarias IANA (TZDB, ver Wikipedia), también conocidos como "tz database names", que son el estándar reconocido para la gestión de zonas horarias en la mayoría de los sistemas modernos.

Estos identificadores se pueden proporcionar a través del header X-Timezone.

Estos identificadores tienen la forma:

• Continente/Ciudad (ejemplos: Europe/Paris, America/New_York, Asia/Tokyo)
• O alias como UTC, GMT, etc.

Ejemplos válidos

Ejemplos no válidos

Fallback

Si se proporciona una zona horaria errónea, o no se define ninguna zona horaria, las llamadas se consideran en GMT.

Conversaciones

Enviar una conversación para análisis

Las conversaciones a analizar se transmiten a Raisetalk a través de un formulario de tipo multipart/form-data e incluyen

• el archivo a enviar
• la información de contexto de la conversación, llamadas "Etiquetas"

Solicitud tipo mínima

POST /upload/create

Datos del formulario:

• file: el archivo a subir
• language: el idioma utilizado en la conversación, entre: fr, en, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi
• model_id: el identificador de la grilla de análisis a utilizar. Consultar la lista de grillas en la interfaz de Raisetalk.
• analysis_region: región donde los datos deben ser procesados, entre: eu, us
• transcription_model: el modelo de transcripción Speech to Text a utilizar

  Ver la lista de modelos de transcripción.

• summaries_model: el modelo de LLM a utilizar para la generación del resumen, sentimientos y actitudes.

  Ver la lista de modelos de análisis.

• questions_model: el modelo de LLM a utilizar para el análisis de criterios.

  Ver la lista de modelos de análisis.

• callback: la URL de callback opcional a la que Raisetalk debe enviar los resultados del procesamiento
• anonymization: array de Datos de Carácter Personal (DCP) a intentar anonimizar, entre los siguientes valores: 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: define el rol de los interlocutores de la conversación. Valor entre: salesperson_prospect, advisor_customer

Análisis en un idioma diferente

Cuando utiliza modelos de transcripción Speech to Text compatibles, puede exigir que el análisis se proporcione en un idioma objetivo, a través del parámetro analysis_language que acepta los siguientes valores: fr, en, en_US, en_AU, en_UK, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi.

Traducción de la transcripción

Cuando utiliza modelos de transcripción compatibles, puede exigir que la transcripción se proporcione en un idioma objetivo, a través del parámetro transcription_language que acepta los siguientes valores: fr, en, en_US, en_AU, en_UK, es, de, it, pt, nl, hi, ja, zh, fi, ko, pl, ru, tr, uk, vi.

Respuesta tipo en caso de éxito

Código 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"
  ],
}

Respuesta tipo en caso de error

Código 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"
  }
}

Modelos de transcripción

Lea nuestro artículo sobre los modelos de transcripción: https://www.raisetalk.com/es/blog/raisetalk-modelos-speech-to-text-para-analisis-conversacional

Modelos de análisis

Artículo de blog próximamente.