문서
대시보드
대시보드 API

프로필과 보안

Markdown

메서드, 요청 필드 및 응답입니다.

전체 가이드

이 섹션에는 메서드가 6개 있습니다. 메서드를 열어 접근 조건, 요청 필드 및 응답을 확인하세요.

메서드와 경로설명접근
PUT /api/v1/user프로필 수정대시보드 토큰
GET /api/v1/user/passkeys패스키 목록대시보드 토큰
PUT /api/v1/user/password비밀번호 변경대시보드 토큰
GET /api/v1/user/profile프로필, 잔액, 연결 정보대시보드 토큰
GET /api/v1/user/totp/status2FA 상태(TOTP)대시보드 토큰
GET /api/v1/user/totp/verification-methodTOTP 검증 방식대시보드 토큰
PUT /api/v1/user — 프로필 수정

접근: 대시보드 토큰

PUT/api/v1/user

JSON / 폼 필드

필드타입필수검증 / 설명
usernamestring아니요; null 가능
avatar_urlstring아니요; null 가능
balance_notify_enabledboolean아니요; null 가능
balance_notify_thresholdnumber아니요; null 가능
요청 본문 템플릿
{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}

PLACEHOLDER는 사용자의 입력과 그 타입을 나타냅니다. 값을 바꾸고 필요한 선택 필드만 남기세요. 숫자, boolean, 객체 또는 배열 대신 문자열 표식을 보내면 안 됩니다.

요청 스키마: UpdateProfileRequest

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: User, UserProfileResponse. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: 상태를 변경하거나 일회성 인증을 이어가는 작업입니다. 예제는 규약을 설명하며 실행되지 않습니다.

특이 사항: 키의 지출 한도(quota, quota_used)는 프로필이 아니라 키 응답에 포함됩니다. frozen_balance는 예약 금액이므로 가용 잔액으로 보면 안 됩니다.

GET /api/v1/user/passkeys — 패스키 목록

접근: 대시보드 토큰

GET/api/v1/user/passkeys
읽기 작업입니다. ID는 이전 응답에서 가져옵니다
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

요청 본문은 필요하지 않습니다. 위 매개변수를 URL에 전달하세요.

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: PasskeyCredentialSummary. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: credential은 navigator.credentials에서, session_token은 begin에서 가져옵니다. Finish 요청 본문 <=65536바이트. 등록과 삭제에는 비밀번호가 필요합니다.

PUT /api/v1/user/password — 비밀번호 변경

접근: 대시보드 토큰

PUT/api/v1/user/password

JSON / 폼 필드

필드타입필수검증 / 설명
old_passwordstring예required
new_passwordstring예required,min=6
요청 본문 템플릿
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER는 사용자의 입력과 그 타입을 나타냅니다. 값을 바꾸고 필요한 선택 필드만 남기세요. 숫자, boolean, 객체 또는 배열 대신 문자열 표식을 보내면 안 됩니다.

요청 스키마: ChangePasswordRequest

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: 상태를 변경하거나 일회성 인증을 이어가는 작업입니다. 예제는 규약을 설명하며 실행되지 않습니다.

GET /api/v1/user/profile — 프로필, 잔액, 연결 정보

접근: 대시보드 토큰

GET/api/v1/user/profile
읽기 작업입니다. ID는 이전 응답에서 가져옵니다
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

요청 본문은 필요하지 않습니다. 위 매개변수를 URL에 전달하세요.

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: User, UserProfileResponse. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: 키의 지출 한도(quota, quota_used)는 프로필이 아니라 키 응답에 포함됩니다. frozen_balance는 예약 금액이므로 가용 잔액으로 보면 안 됩니다.

GET /api/v1/user/totp/status — 2FA 상태(TOTP)

접근: 대시보드 토큰

GET/api/v1/user/totp/status
읽기 작업입니다. ID는 이전 응답에서 가져옵니다
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

요청 본문은 필요하지 않습니다. 위 매개변수를 URL에 전달하세요.

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: TotpStatusResponse. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: secret과 setup_token은 비밀 정보입니다. 검증은 TOTP 설정 및 사용자에 따라 다릅니다.

GET /api/v1/user/totp/verification-method — TOTP 검증 방식

접근: 대시보드 토큰

GET/api/v1/user/totp/verification-method
읽기 작업입니다. ID는 이전 응답에서 가져옵니다
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

요청 본문은 필요하지 않습니다. 위 매개변수를 URL에 전달하세요.

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 스키마, 예시 값
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: secret과 setup_token은 비밀 정보입니다. 검증은 TOTP 설정 및 사용자에 따라 다릅니다.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
궁금한 점이 남았나요? Request ID와 설명을 보내 주시면 해결을 도와드리겠습니다.지원팀에 문의
로그인회원가입대시보드
요금