Getting Started

Comenzando

Requisitos previos

Para usar la API de TranscribeMe, necesitarás:

  • Un entorno de desarrollo compatible con RESTful APIs. Esto puede ser cualquier lenguaje de programación moderno que soporte solicitudes HTTP (como Python, JavaScript, Ruby, etc.).
  • Un cliente HTTP para probar las solicitudes API, como Postman o cURL.
  • Un archivo de audio para transcribir en uno de los formatos soportados. En caso de estar en otro formato, deberas convertirlo.

Para empezar a usar la API de TranscribeMe, debes seguir estos pasos:

  1. Configura tu entorno de desarrollo para poder hacer solicitudes HTTP a la API. Esto variará dependiendo del lenguaje de programación que estés utilizando.
  2. Asegúrate de tener a mano un archivo de audio para transcribir.

Primeros pasos

Este ejemplo muestra cómo puedes transcribir un audio utilizando nuestra API en JavaScript (Node.js). Para este ejemplo, necesitarás instalar los módulos node-fetch y form-data usando npm.

const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');
 
// URL del endpoint de la API
const url = 'https://api.transcribeme.app/sync-transcription';
 
// Tus credenciales de la API
const apiKey = 'tu_api_key';
 
// Path al archivo de audio
const audioFile = 'path_a_tu_archivo_de_audio';
 
// Define el mimeType de tu archivo de audio
const mimeType = 'audio/wav';
 
// Crea una instancia de FormData
const formData = new FormData();
 
// Agrega el archivo de audio al FormData
formData.append('audio', fs.createReadStream(audioFile), { contentType: mimeType });
 
// Crea los headers de la solicitud
const headers = {
    'x-api-key': apiKey,
    ...formData.getHeaders()
};
 
// Realiza la solicitud POST a la API
fetch(url, { method: 'POST', headers: headers, body: formData })
    .then(response => response.text())
    .then(text => {
        // Imprime la transcripción
        console.log(text);
    })
    .catch(error => console.error('Error:', error));

Características extra

Lang

El parámetro lang te permite especificar el idioma del audio que deseas transcribir. Esto es útil si estás trabajando con audios en diferentes idiomas. Deberás proporcionar el código del idioma de acuerdo con los estándares ISO 639-1. Por ejemplo, en para inglés, es para español, de para alemán, etc.

Para utilizar esta característica, simplemente agrega el parámetro lang como un parámetro de consulta en la URL de tu solicitud:

const lang = 'es'; // Código del idioma que deseas usar
const url = `https://api.transcribeme.app/sync-transcription?lang=${lang}`;

Diarization

La diarización es el proceso de diferenciar entre distintos hablantes en un audio. Esto puede ser muy útil si estás transcribiendo una conversación entre varias personas y quieres saber quién dijo qué.

Para utilizar esta característica, simplemente agrega el parámetro diarization como un parámetro de consulta en la URL de tu solicitud:

const diarization = true; // Habilita la diarización
const url = `https://api.transcribeme.app/sync-transcription?diarization=${diarization}`;

Raw

El parámetro raw te permite solicitar una transcripción sin procesar en un formato más primitivo. Esto proporciona la transcripción palabra por palabra en formato JSON, e incluye datos adicionales para cada palabra, como el timestamp y la confidencia de la transcripción. Esta opción puede ser útil si necesitas un mayor control sobre la información obtenida en la transcripción.

Para utilizar esta característica, simplemente agrega el parámetro raw como un parámetro de consulta en la URL de tu solicitud:

const raw = true;
const url = `https://api.transcribeme.app/sync-transcription?raw=${raw}`;

Es importante tener en cuenta que el formato de salida cuando se habilita el parámetro raw será diferente al formato de salida estándar. Necesitarás procesar adicionalmente los datos para interpretar la transcripción.

Timestamps

El parámetro raw te permite solicitar una transcripción diarizada con campos adicionales, marcando segundos de comienzo y finalizacion de las frases. Esto proporciona la transcripción por frases en formato JSON.

Para utilizar esta característica, agrega el parámetro 'timestamp' como un parámetro de consulta en la URL de tu solicitud, junto al parametro diarization:

const timestamps = true;
const diarization = true; // Habilita la diarización para que funcionen los timestamps
const url = `https://api.transcribeme.app/sync-transcription?timestamps=${timestamps}&diarization=${diarization}`;

Nota:

  • Cuando utilizas la diarización con transcripción, la respuesta de la API será un arreglo que alterna entre los distintos hablantes. Por ejemplo:
"transcription": [
    {
        "speaker": 0,
        "text": ".. "
    },
    {
        "speaker": 1,
        "text": "..."
    }
]

Cada objeto en el arreglo representa un fragmento de la transcripción atribuido a un hablante particular.

  • Puedes encontrar más información sobre los formatos de respuesta y los formatos que debes utilizar para enviar datos en la referencia de la API.
IntroductionData Processing