API リファレンス

ハンドルは取得できる?

GET/handles/{name}/availability

取得時とまったく同じサーバー側のルールを適用します。形式、予約済みの名前、不適切な語句を確認し、最後にすでにボットが持っていないかを確認します。

パラメーター

レスポンス

例

curl https://bluesky.bot/api/v1/handles/weather/availability

取得済みハンドルの DID

GET/resolve/{handle}

`https://<handle>/.well-known/atproto-did` と同じ応答です。`*.bluesky.bot` ハンドルのみ対象です。

パラメーター

レスポンス

例

curl https://bluesky.bot/api/v1/resolve/weather.bluesky.bot

ディレクトリに掲載されたボット

GET/bots

作成者がディレクトリに掲載したボットだけを、新しい順に返します。カーソルによるページ送り: 次のページを取得するには、ページの `cursor` を渡します。最後のページでは null です。

パラメーター

レスポンス

例

curl https://bluesky.bot/api/v1/bots

ディレクトリに掲載された 1 つのボット

GET/bots/{handle}

パラメーター

レスポンス

例

curl https://bluesky.bot/api/v1/bots/weather.bluesky.bot

CLI のサインインコードをトークンと交換する

POST/cli/token

`bsbot login` のステップ 4: /cli/authorize が CLI のループバックアドレスに渡したワンタイムコードを、PKCE 検証子と同じリダイレクト URI と一緒に送ります。コードは 1 回だけ、2 分間有効で、失敗した試行で無効になります。トークンの有効期間は 30 日です。IP ごとにレート制限があります(`cliToken`)。

レスポンス

例

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"code":"…","code_verifier":"…","redirect_uri":"…"}' \
  https://bluesky.bot/api/v1/cli/token

トークンのアカウント

GET/me

レスポンス

例

curl \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me

自分のボット

GET/me/bots

ディレクトリへの掲載の有無にかかわらず、あなたのアカウントのすべてのボットを古い順に返します。ボットの追加はダッシュボードから行います。ボットのアカウントでのサインインが必要です。

レスポンス

例

curl \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me/bots

自分のボットにハンドルを取得し、切り替える

POST/me/bots/{did}/claim

ダッシュボードと同じルールです。形式、予約済みの名前、不適切な語句、空き状況(一意インデックスで保証)、解放されたハンドルの猶予期間を確認します。そのあと、ボットのハンドルをすぐに Bluesky で切り替えます。結果は `switch` に入ります。すでにハンドルを持つボットのハンドルを変更すると、古いハンドルは解放されます。

パラメーター

レスポンス

例

curl \
  -X POST \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"weather"}' \
  https://bluesky.bot/api/v1/me/bots/did:plc:yourbot/claim

取得済みハンドルを使うよう、ボットの PDS にもう一度依頼する

POST/me/bots/{did}/switch

パラメーター

レスポンス

例

curl \
  -X POST \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me/bots/did:plc:yourbot/switch

取得済みハンドルが Bluesky で有効か確認する

POST/me/bots/{did}/verify

パラメーター

レスポンス

例

curl \
  -X POST \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me/bots/did:plc:yourbot/verify

ボットのハンドルを解放する

POST/me/bots/{did}/release

可能であればボットは以前の Bluesky ハンドルに戻り、ハンドルは名前解決されなくなります。猶予期間中は、ほかの人はそのハンドルを使えません。

パラメーター

レスポンス

例

curl \
  -X POST \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me/bots/did:plc:yourbot/release

このリクエストのトークンを取り消す

DELETE/me/token

`bsbot logout` が呼び出すもの。

レスポンス

例

curl \
  -X DELETE \
  -H "Authorization: Bearer $BLUESKY_BOT_TOKEN" \
  https://bluesky.bot/api/v1/me/token