設定

アカウント設定の読み取り・更新と API キー管理を行うエンドポイントです。

GET/api/v1/settings

認証済みユーザーの現在の設定を取得します。

認証

settings:read

レスポンス

{
  "isAcceptingQuestions": true,
  "target": "anyone",
  "allowAnonymous": true,
  "notifyOnMisskey": true,
  "primaryColor": "#7c3aed",
  "textColor": "#1f2937",
  "frameStyle": "default",
  "autoModeration": true,
  "moderationThresholds": null,
  "ngWords": [],
  "driveFolderPath": "mewk",
  "scheduledPostEnabled": false,
  "scheduledPostHours": [],
  "scheduledPostTimezone": "Asia/Tokyo",
  "scheduledPostVisibility": "public",
  ...
}

PUT/api/v1/settings

設定フィールドを 1 つ以上更新します。指定したフィールドのみ更新されます。

認証

settings:write

リクエストボディ

{
  "isAcceptingQuestions": true,
  "target": "anyone",
  "allowAnonymous": true,
  "notifyOnMisskey": true,
  "frameStyle": "default",
  "primaryColor": "#7c3aed",
  "textColor": "#1f2937",
  "autoModeration": true,
  "moderationThresholds": null,  // null = システムデフォルト, or { "sexual": 0.8, "violence": 0.7, ... }
  "scheduledPostEnabled": false,
  "scheduledPostHours": [9, 18],
  "scheduledPostTimezone": "Asia/Tokyo",
  "scheduledPostVisibility": "public"
}

リクエストボディに含まれないフィールドは変更されません。

GET/api/v1/settings/api-keys

認証済みユーザーのすべての API キーを一覧表示します(シークレット値は返されません)。

認証

認証必須(任意の有効な API キー)

POST/api/v1/settings/api-keys

新しい API キーを作成します。シークレットキーは一度だけ返されます。

認証

settings:write

リクエストボディ

{
  "name": "My Bot",
  "permissions": ["questions:read"],
  "expiry": "never"  // never, 1d, 7d, 30d, 90d, 180d, 1y
}

DELETE/api/v1/settings/api-keys/:id

API キーを無効化して完全に削除します。

認証

settings:write