Skip to content

Visión General y Autenticación de la API ​

OneASR proporciona un conjunto de APIs REST y WebSocket estandarizadas y de alto rendimiento para reconocimiento de voz, análisis multimedia y gestión de archivos.


URLs Base ​

  • Despliegue Local: http://localhost:8000
  • Endpoint Compatible con OpenAI: http://localhost:8000/v1
  • Endpoint WebSocket en Tiempo Real: ws://localhost:8000/v1/realtime (o /v1/realtimeext)

Autenticación ​

Todas las solicitudes a los endpoints de OneASR requieren una clave API válida configurada en config.yaml (api_key: sk-oneasr-...).

Puede enviar la clave API utilizando cualquiera de los tres métodos siguientes:

1. Token Bearer HTTP (Formato estándar de OpenAI) ​

http
Authorization: Bearer sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

2. Encabezado Personalizado (X-API-Key) ​

http
X-API-Key: sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

3. Parámetro de Consulta URL (Recomendado para WebSockets) ​

text
ws://localhost:8000/v1/realtime?api_key=sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

Grupos Funcionales de la API ​

GrupoEndpointsProtocoloDescripción
Audio OpenAI/v1/audio/transcriptions, /v1/modelsHTTP RESTReemplazo directo de OpenAI para reconocimiento de voz y descubrimiento de modelos
Streaming en Tiempo Real/v1/realtime, /v1/realtimeextWebSocketTransmisión dúplex de audio en directo de baja latencia con soporte VAD
Transcripción de Archivos/v1/file-transcription/transcriptionsHTTP & SSEProcesamiento asíncrono en segundo plano para archivos grandes (hasta 2 GB)
Almacenamiento de Archivos/v1/files/*, /v1/files/fetch-urlHTTP RESTSubida de archivos, gestión de almacenamiento y descargas desde URLs remotas
Medios y Motores/v1/media/parse, /v1/providersHTTP RESTExtracción de pistas de audio y estado de los proveedores de motores ASR