Referencia de la API

🔌 Referencia de la API

Uspeech Analytics expone una API REST para que puedas controlar la plataforma desde tus propios scripts, servicios e integraciones. Todo lo que puedes hacer desde la aplicación web — subir audio, transcribir, listar y descargar transcripciones — tiene su equivalente en la API.

La referencia cubre la superficie de Transcripción de extremo a extremo, además de la superficie de call center: adjuntar metadatos a las grabaciones y consultar los resultados analizados, además de los endpoints de Proyectos que necesitas para localizar un ID de proyecto. Más grupos de endpoints (configuración de análisis, procesamiento de encuestas) se irán añadiendo aquí a medida que se estabilicen.

URL base

Todos los endpoints están montados bajo /api/ en tu host de Uspeech:

https://app.uspeech.io/api/

Si haces auto-hosting, reemplaza el host con la URL de tu despliegue.

Autenticación

Cada endpoint requiere una sesión de navegador iniciada o una clave API asociada a un usuario. Para acceso programático, usa una clave API — consulta Autenticación.

Qué se documenta aquí

Autenticación — Cómo crear claves API, el formato del encabezado y cómo las claves heredan los permisos del usuario.
Proyectos — Listar los proyectos visibles para una clave y encontrar el ID de proyecto que necesitan todos los demás endpoints.
Transcripción — Subir audio, consultar estado, listar y obtener transcripciones, y descargar el resultado en SRT o DOCX.
Subir Llamadas para Análisis — Subir grabaciones a un proyecto con análisis automático activado, seguir el progreso de los lotes y consultar los resultados.
Metadatos de llamadas — Adjuntar, actualizar y consultar fecha y hora, agente, dirección y campaña — por archivo o mediante un manifiesto CSV.
Informes de llamadas — Consultar los resultados del call center: métricas agregadas del informe, el explorador de llamadas, el progreso del análisis y la exportación en PDF.
Códigos de estado y errores — Los códigos HTTP que debes esperar, la estructura de las respuestas de error y los motivos de fallo específicos de transcripción.

Esquema interactivo

Cada despliegue cuenta con un esquema OpenAPI 3 autogenerado en vivo:

Documento OpenAPI — GET /api/schema/
Swagger UI — /api/schema/swagger-ui/
ReDoc — /api/schema/redoc/

Estas páginas reflejan los endpoints, parámetros y estructuras de respuesta exactos de tu versión instalada. Usa esta referencia escrita para el “cómo hago X de principio a fin” y el esquema para la lista precisa de campos de cada endpoint individual.

Convenciones de esta referencia

Los cuerpos de petición y respuesta son JSON salvo que se indique lo contrario. Las subidas de archivo usan multipart/form-data.
Los encabezados de endpoint se escriben como ## MÉTODO /ruta.
Todos los ejemplos están disponibles en cURL, Python y JavaScript — elige el lenguaje con las pestañas que hay sobre cada ejemplo. Tu elección se recuerda y se aplica a todos los ejemplos de todas las páginas.
Los ejemplos leen la clave de la variable de entorno USPEECH_KEY y la envían como Authorization: Api-Key …. Sustituye tu propio host y clave.
Los ejemplos de Python usan requests; los de JavaScript usan el fetch integrado y funcionan en Node 18 o superior.

💡 Consejo: cada ejemplo asume que ya has creado una clave API — empieza por Autenticación si aún no lo has hecho.