API 인증

Rivya API는 서버 간 접근에 API key를 사용합니다.

API key는 브라우저 로그인 세션과 같지 않습니다. cookie, Better Auth session 상태, 개인 브라우저 token을 공개 API 자격 증명으로 사용하지 마세요.

Header 형식

key를 Authorization header에 보내세요.

Authorization: Bearer rvya_sk_...

전체 key는 생성 시 한 번만 표시됩니다. Rivya는 전체 시크릿이 아니라 hash와 보이는 prefix를 저장합니다.

Key 만들기

1. Rivya에 로그인합니다.
2. API Keys 설정을 엽니다.
3. 필요한 scope로 key를 만듭니다.
4. 전체 key를 즉시 복사합니다.
5. 서버 측 secret manager나 환경 변수에 저장합니다.

key를 클라이언트 측 JavaScript, 모바일 앱 번들, 공개 저장소, analytics 이벤트, 로그에 넣지 마세요.

현재 Scope

첫 버전은 다음 scope를 문서화합니다.

• models:read
• generations:create
• generations:read
• files:create
• files:read
• credits:read
• webhooks:manage
• chat:create
• chat:read

Settings에서 새로 만든 key에는 문서화된 scope가 기본으로 포함됩니다. 더 오래된 key는 Files API, API Webhooks, Chat API를 사용하기 전에 다시 만들어야 할 수 있습니다.

폐기와 교체

key가 노출된 경우:

1. Settings에서 이전 key를 폐기합니다.
2. 새 key를 만듭니다.
3. 서버 측 secret을 업데이트합니다.
4. GET /api/v1/credits로 새 key가 작동하는지 확인합니다.
5. 빌드 시스템, 로그, 배포 변수에서 이전 key를 제거합니다.

폐기된 key는 api_key_revoked를 반환합니다.

인증 오류

일반적인 인증 오류는 다음과 같습니다.

• api_key_missing
• api_key_invalid
• api_key_revoked
• api_key_expired
• api_scope_denied
• public_api_disabled

전체 공개 오류 표는 API 오류와 제한을 참고하세요.

관련 페이지

• API 빠른 시작
• API 크레딧
• API 오류와 제한
• Rivya의 인증과 접근