🔌 APIs
APIs 섹션은 제품 사용법이 아니라 API 서비스 문서를 위한 영역입니다.
이 섹션의 초점은 다음과 같습니다.
- 인증과 토큰
- REST API 구조
- request / response 형식
- result bundle, session, job 모델
- 외부 연동 관점의 개발자 문서
왜 Service와 분리하는가
Service는 제품 사용법과 운영 개요를 설명합니다.
- Chorus 제품군
- 설치 / 운영 / 권한 / UI
- 사용자와 운영자 관점
반면 APIs는 계속 증가하는 레퍼런스 문서가 중심입니다.
- API 스펙
- 에러 코드
- 인증 방식
- 엔드포인트별 request / response
그래서 두 섹션은 같은 서비스군을 다루더라도 문서 목적이 다릅니다.
현재 포함 범위
| 서비스 | 성격 |
|---|---|
llm.apis.how | managed LLM gateway 예시 도메인 |
speech.apis.how | managed speech API 예시 도메인 |
pronunciation.apis.how | managed 발음 평가 + 세션 종합 평가 (Layer 2/3) |
chorus.apis.how | managed orchestration backend 예시 도메인 |
API Access Key Core
이 섹션의 주요 API 서비스는 공통 API Access Key Core 위에서 동작합니다.
즉 문서상 서비스가 달라도 다음 규칙은 공통으로 이해하면 됩니다.
- plain token 1회 표시
- DB hash 저장
Edit / Rotate / Revoke중심 운영- route / ability / origin / domain / IP / timeout / websocket 정책
- usage / cost 추적
관련 문서:
Managed vs Self-Hosted
이 섹션의 문서는 귀사 운영 도메인 예시를 사용하지만, multi-saas-kit는 self-hosted 배포도 함께 염두에 둡니다.
즉:
- managed 예시:
llm.apis.how,chorus.apis.how - self-hosted 예시:
llm.${ROOT_DOMAIN},chorus.${ROOT_DOMAIN}
엔드포인트 계약 자체는 동일하게 유지하는 것이 원칙입니다.