Skip to main content
POST
API 키 발급

Authorizations

Authorization
string
header
required

워크스페이스 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

organization_id
string
required

API 키를 발급할 워크스페이스 ID입니다. 본인 워크스페이스 또는 직속 하위 워크스페이스를 지정합니다.

Body

application/json

API 키 발급 옵션입니다. key_name은 필수입니다.

워크스페이스 API 키 발급 요청입니다. type으로 secret(서버용 sk_)이나 publishable(클라이언트용 pk_)을 고릅니다. key_name은 필수입니다. 내부 키 ID를 응답에 노출하지 않으므로 폐기할 키는 key_name과 secret_key_suffix 쌍으로 식별합니다. 종류별 필드 규칙: 비어 있지 않은 allowed_ips는 secret에서만, 비어 있지 않은 allowed_domains는 publishable에서만 받습니다. 빈 배열은 두 종류 모두 받으며, 규칙을 어기면 400으로 거절합니다.

key_name
string
required

키를 식별할 이름입니다. 앞뒤 공백은 제거합니다. 공백만 입력하면 400을 반환합니다. secret_key_suffix와 함께 폐기할 키를 식별하므로 필수입니다. publishable 키는 최대 64자입니다.

Required string length: 1 - 255
type
enum<string>
default:secret

키 종류입니다. secret(기본값)은 서버용 sk_ 키를 발급하며 한 번만 보여 줍니다. publishable은 음성 세션 시작만 할 수 있는 클라이언트용 pk_ 키(대시보드의 클라이언트용 키)를 발급하며 목록에서 다시 읽을 수 있습니다.

Available options:
secret,
publishable
allowed_ips
string[]

이 키를 쓸 수 있는 IP 주소와 CIDR 범위 목록입니다. 선택 항목이며, 중복을 뺀 뒤 최대 20개까지 넣을 수 있습니다. 비어 있으면 제한이 없고, * 하나만 넣으면 모든 IP를 허용합니다. 예를 들어 203.0.113.10, 10.0.0.0/24, 2001:db8::/32처럼 넣습니다. 범위는 호스트 비트를 0으로 맞춰 저장합니다. 10.0.0.5/24는 10.0.0.0/24로 저장합니다. secret 키에만 쓸 수 있고, publishable 키에 비어 있지 않은 배열을 보내면 400을 반환합니다.

allowed_domains
string[]

이 키를 쓸 수 있는 브라우저 출처 목록이며 publishable 키에만 쓸 수 있습니다(최대 20개, 항목당 253자까지). 비어 있으면 제한이 없습니다. 대시보드와 같은 규칙으로 정리합니다. 스킴, 경로, 포트, 앞의 *.를 제거하고, * 하나만 넣으면 모든 출처를 허용하며, ASCII가 아닌 도메인은 punycode로 바꿉니다. 빈 항목과 중복은 제거합니다. secret 키에 비어 있지 않은 배열을 보내면 400을 반환합니다.

Response

성공 응답

API 키 발급 응답입니다. secret 평문 키는 이 응답에서 한 번만 제공하며 다시 조회할 수 없습니다. publishable 키는 목록에서 다시 읽을 수 있습니다.

type
enum<string>
required

키 종류입니다. secret(sk_) 또는 publishable(pk_, 대시보드의 클라이언트용 키)입니다.

Available options:
secret,
publishable
secret_key_suffix
string
required

키 평문의 끝 4자리입니다(종류와 관계없음). key_name과 함께 폐기할 키를 식별합니다.

created_at
integer
required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

allowed_domains
string[]
required

publishable 키를 쓸 수 있는 브라우저 출처 목록입니다. 빈 배열이면 제한이 없습니다. secret 키는 항상 빈 배열입니다.

api_key
string
required

평문 API 키입니다. secret 키는 다시 조회할 수 없으므로 즉시 안전한 곳에 저장하세요. publishable 키는 목록 조회에서 다시 읽을 수 있습니다.

key_name
string | null

secret_key_suffix와 함께 폐기할 키를 식별하는 이름입니다.

last_used_at
integer | null

이 키로 마지막으로 인증에 성공한 시각입니다. unix milliseconds 형식입니다. 한 번도 사용하지 않았다면 null입니다. 비동기로 기록하므로 최대 1분가량 지연될 수 있습니다.

allowed_ips
string[]

이 키를 쓸 수 있는 IP 주소와 CIDR 범위 목록입니다. 빈 배열이면 제한이 없고, *는 모든 IP를 허용합니다. publishable 키는 항상 빈 배열입니다.