Skip to content

BYOK (Bring Your Own Key)

본인의 프로바이더 API 키를 등록하면, PleumRouter가 그 키로 호출을 라우팅하고 토큰 마크업 대신 소액의 수수료만 청구합니다.

BYOK(Bring Your Own Key)는 OpenAI·Anthropic 같은 프로바이더의 API 키를 직접 보유한 경우, 그 키를 PleumRouter에 등록해 사용하는 기능입니다. 토큰 비용은 프로바이더에 직접 지불하고, PleumRouter는 라우팅·과금·관측 등 플랫폼 수수료만 청구합니다. 등록한 키는 저장 시 암호화되며, 평문은 다시 조회되지 않습니다.

BYOK는 기본값으로 비활성화되어 있습니다. 관리자가 켜기 전까지 키 관리 엔드포인트(GET/POST/DELETE /v1/byok/keys)는 403과 함께 BYOK가 현재 활성화되어 있지 않습니다. 메시지를 반환합니다. GET /v1/byok/statusGET /v1/byok/usage는 읽기 전용으로 항상 호출할 수 있습니다. 모든 BYOK 엔드포인트는 로그인 세션(JWT) 인증이 필요합니다.

상태와 사용량#

GET/v1/byok/status

GET /v1/byok/status는 현재 BYOK 활성화 여부(enabled), 수수료율(fee_percent, 퍼센트), 월 무료 토큰 한도 (free_monthly_tokens)를 반환합니다.

200 OK
{
  "enabled": true,
  "fee_percent": 1.5,
  "free_monthly_tokens": 10000000
}
GET/v1/byok/usage

GET /v1/byok/usage는 이번 달 BYOK 토큰 사용량, 남은 무료 토큰, 지금까지 청구된 수수료(원화), 그리고 프로바이더별 내역(by_provider)을 반환합니다.

200 OK
{
  "month_tokens": 1240000,
  "free_monthly_tokens": 10000000,
  "free_remaining_tokens": 8760000,
  "fee_charged_krw": 0,
  "by_provider": [
    {"provider": "openai", "tokens": 920000, "fee_krw": 0},
    {"provider": "anthropic", "tokens": 320000, "fee_krw": 0}
  ]
}

키 등록#

POST/v1/byok/keys

POST /v1/byok/keys로 키를 등록(또는 갱신)합니다. 같은 프로바이더에 대해 다시 등록하면 기존 키를 덮어씁니다(upsert). 전체 키 목록은 GET /v1/byok/keys, 삭제는 DELETE /v1/byok/keys/{id}를 사용합니다.

파라미터타입필수설명
providerstring필수키를 등록할 프로바이더 ID. 알려진 프로바이더 ID여야 합니다(예: openai, anthropic).
api_keystring필수프로바이더 API 키. 8~500자. 저장 시 암호화되며 평문은 다시 반환되지 않습니다.
request
curl -X POST https://router.pleum.ai/v1/byok/keys \
  -H "Authorization: Bearer <session_jwt>" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "openai",
    "api_key": "sk-..."
  }'

응답에는 키 자체가 아니라 마스킹된 힌트(key_hint, 예 ••••a1b2)만 포함됩니다. 평문 키는 어떤 응답에서도 반환되지 않습니다.

200 OK
{
  "id": "b1f2c3d4-...",
  "provider": "openai",
  "key_hint": "••••a1b2",
  "is_active": true,
  "created_at": "2026-06-27T09:00:00Z"
}

과금 방식#

BYOK 호출에서는 토큰 마크업이 0입니다. 토큰 요금은 등록한 키로 프로바이더에 직접 청구되고, PleumRouter는 정가 환산 원화 비용의 fee_percent만큼만 수수료를 원화 크레딧으로 청구합니다(기본 1.5%).

수수료는 매월 free_monthly_tokens까지 무료입니다(기본 1,000만 토큰). 무료 한도를 넘어선 사용분부터 위 수수료가 적용됩니다. 한도와 수수료율의 현재 값은 GET /v1/byok/status에서 확인하세요.

등록한 키의 잔액·요금은 PleumRouter가 관리하지 않습니다. 프로바이더 측 결제 수단과 사용 한도는 직접 관리해야 합니다.