Referência da API

Um handle está livre?

GET/handles/{name}/availability

Aplica exatamente as regras do servidor para uma reivindicação: formato, nomes reservados, palavras ofensivas e, por fim, se algum bot já o tem.

Parâmetros

Respostas

Exemplo

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

O DID por trás de um handle reivindicado

GET/resolve/{handle}

A mesma resposta que `https://<handle>/.well-known/atproto-did`. Apenas handles `*.bluesky.bot`.

Parâmetros

Respostas

Exemplo

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

Bots listados no diretório

GET/bots

Apenas os bots que o criador colocou no diretório, do mais recente para o mais antigo. Paginação por cursor: passe o `cursor` de uma página para obter a seguinte; é null na última página.

Parâmetros

Respostas

Exemplo

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

Um bot listado no diretório

GET/bots/{handle}

Parâmetros

Respostas

Exemplo

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

Trocar um código de início de sessão da CLI por um token

POST/cli/token

Passo 4 do `bsbot login`: o código de utilização única que /cli/authorize entregou ao endereço de loopback da CLI, com o verificador PKCE e o mesmo URI de redirecionamento. Um código serve uma vez e durante dois minutos; uma tentativa falhada inutiliza-o. O token é válido 30 dias. Limite de utilização por IP (`cliToken`).

Respostas

Exemplo

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

A conta por trás do token

GET/me

Respostas

Exemplo

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

Os seus bots

GET/me/bots

Todos os bots da sua conta, no diretório ou não, do mais antigo para o mais recente. Adicione um bot a partir do painel: é preciso entrar na conta do bot.

Respostas

Exemplo

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

Reivindicar um handle para um dos seus bots e aplicá-lo

POST/me/bots/{did}/claim

As próprias regras do painel: formato, nomes reservados, palavras ofensivas, disponibilidade (garantida por um índice único) e período de carência dos handles libertados. Depois, o handle do bot é mudado no Bluesky de imediato; `switch` diz como correu. Mudar o handle de um bot que já tem um liberta o antigo.

Parâmetros

Respostas

Exemplo

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

Pedir novamente ao PDS do bot que use o handle reivindicado

POST/me/bots/{did}/switch

Parâmetros

Respostas

Exemplo

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

Verificar se o handle reivindicado está ativo no Bluesky

POST/me/bots/{did}/verify

Parâmetros

Respostas

Exemplo

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

Libertar o handle de um bot

POST/me/bots/{did}/release

O bot volta ao handle anterior do Bluesky quando possível, o handle deixa de ser resolvido e fica bloqueado para os outros durante o período de carência.

Parâmetros

Respostas

Exemplo

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

Revogar o token deste pedido

DELETE/me/token

O que o `bsbot logout` chama.

Respostas

Exemplo

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