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.

Esta primera versión de la referencia cubre la superficie de Transcripción de extremo a extremo. Más grupos de endpoints (proyectos, 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.
Transcripción — Subir audio, consultar estado, listar y obtener transcripciones, y descargar el resultado en SRT o DOCX.
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.
Los ejemplos usan curl con el encabezado Authorization: Api-Key …. Sustituye tu propio host y clave.

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