API 개요 및 인증 방식

OneASR은 음성 인식, 미디어 파싱 및 파일 관리를 위한 표준화된 고성능 REST 및 WebSocket API 제품군을 제공합니다.

---

기본 엔드포인트 URL

• 로컬 배포 환경: http://localhost:8000
• OpenAI 호환 엔드포인트: http://localhost:8000/v1
• 실시간 WebSocket 엔드포인트: ws://localhost:8000/v1/realtime (또는 /v1/realtimeext)

---

인증 방식

OneASR 엔드포인트에 대한 모든 요청에는 config.yaml에 설정된 유효한 API 키(api_key: sk-oneasr-...)가 필요합니다.

다음 세 가지 방법 중 하나를 선택하여 API 키를 전달할 수 있습니다:

1. HTTP Bearer 토큰 (표준 OpenAI 형식)

Authorization: Bearer sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

2. 사용자 정의 헤더 (X-API-Key)

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

3. URL Query 매개변수 (WebSocket 핸드셰이크 권장)

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

---

기능별 API 그룹

그룹	엔드포인트	프로토콜	설명
OpenAI 오디오	/v1/audio/transcriptions, /v1/models	HTTP REST	OpenAI 음성 인식 및 모델 탐색 완벽 호환
실시간 스트리밍	/v1/realtime, /v1/realtimeext	WebSocket	VAD 기반 초저지연 양방향 실시간 오디오 스트리밍
파일 전사 작업	/v1/file-transcription/transcriptions	HTTP & SSE	대용량 미디어 파일(최대 2GB) 백그라운드 비동기 처리 및 진행률 스트리밍
파일 저장소	/v1/files/*, /v1/files/fetch-url	HTTP REST	파일 업로드, 저장소 관리 및 원격 URL 비동기 다운로드
미디어 및 엔진	/v1/media/parse, /v1/providers	HTTP REST	오디오 트랙 추출 및 ASR 엔진 프로바이더 상태 조회