NAME

Bluesky - Bluesky Client Library in Perl

SYNOPSIS

use Bluesky;
my $bsky = Bluesky->new( );

# Recommended: log in once and reuse the saved session on later runs
$bsky->ensure_auth( handle => 'user.bsky.social' );

# Or drive the interactive OAuth flow directly:
$bsky->oauth_helper(
    handle     => 'user.bsky.social',
    listen     => 1, # Automatically catch the redirect
    on_success => sub { say 'Logged in!' }
);

# Or use an app password (not recommended)
$bsky->login( 'sanko', '1111-2222-3333-4444' );

# Posting
$bsky->createPost( text => 'Hello from Perl!' );

# Streaming
my $fh = $bsky->firehose(sub ( $header, $body, $err ) {
    return warn $err if $err;
    say 'New event: ' . $header->{t};
});
$fh->start();

DESCRIPTION

You shouldn't need to know the AT protocol in order to get things done so I'm including this sugary wrapper so that At can remain mostly technical.

Constructor and Session Management

Bluesky.pm is my attempt to make use of Perl's class syntax so this is obviously OO.

`new( [...] )`

my $bsky = Bluesky->new( );

Create a new Bluesky client object.

Expected parameters include:

service - optional: Bluesky PDS host. Defaults to https://bsky.social.
chat_service - optional: Chat (DM) service host. Defaults to https://api.bsky.chat.
at - optional: Underlying At object. If not provided, it defaults to At->new( host => $service ).

`ensure_auth( %args )`

$bsky->ensure_auth( handle => 'you.bsky.social' );

Convenience wrapper for applications that want to stay logged in across runs. When file exists it loads and resumes the saved session (re-saving it if the underlying tokens were rotated); otherwise it runs an interactive OAuth flow via oauth_helper and saves the resulting session.

Expected parameters include:

file: Path to the session file. Defaults to session.json.
handle: The user's handle or DID. Required when no saved session exists.
scope: Requested OAuth scopes. Defaults to atproto.
listen: Passed through to oauth_helper. Defaults to 1.
client_id, redirect: Optional OAuth overrides, passed through to oauth_helper.
on_success: Optional callback invoked after a successful first-time login. Receives the $bsky object.

`oauth_helper( %args )`

A high-level helper to manage the entire OAuth flow. This is the recommended way to authenticate for interactive applications.

$bsky->oauth_helper(
    handle     => 'user.bsky.social',
    listen     => 1,
    on_success => sub ($self) {
        say 'Authenticated as ' . $self->did;
    }
);

Expected parameters include:

handle - required

The user's handle or DID.

listen

Boolean. If true, attempts to start a local HTTP server (using Mojolicious) to automatically capture the code and state from the redirect.

redirect

The redirect URI. Defaults to http://127.0.0.1:8888/callback.

scope

The requested OAuth scopes. Defaults to atproto.

See https://atproto.com/guides/scope-builder to build your own scope strings.

on_success

A callback subroutine invoked after a successful login. Receives the $bsky object as an argument.

`oauth_start( $handle, $client_id, $redirect_uri, [ $scope ] )`

Initiates the OAuth 2.0 Authorization Code flow. Returns the authorization URL.

$scope defaults to atproto if omitted.

my $url = $bsky->oauth_start(
    'user.bsky.social',
    'http://localhost',
    'http://127.0.0.1:8888/callback'
);

The $scope here defaults to simply 'atproto'. See https://atproto.com/guides/scope-builder to build your own scope strings.

`oauth_callback( $code, $state )`

Exchanges the authorization code for tokens and completes the OAuth flow.

$bsky->oauth_callback( $code, $state );

`login( $identifier, $password )`

$bsky->login( 'sanko', '1111-2222-3333-4444' );

Expected parameters include:

identifier - required: Handle or other identifier supported by the server for the authenticating user.
password - required: This is the app password not the account's password. App passwords are generated at https://bsky.app/settings/app-passwords.

`resume( $accessJwt, $refreshJwt, [ $token_type, ... ] )`

$bsky->resume( $accessJwt, $refreshJwt );

Restores a session from existing tokens. Delegates to "resume" in At.

`session( )`

my $session = $bsky->session();

Returns the underlying At session data.

`did( )`

my $did = $bsky->did();

Returns the DID of the authenticated user, if any.

`save_session( [ $file ] )`

$bsky->save_session();    # writes session.json

Serializes the current session to $file (default session.json) so it can be restored later with load_session or ensure_auth. Does nothing, with a warning, when there is no active session.

`load_session( [ $file ] )`

$bsky->load_session();

Reads a previously saved session from $file (default session.json) and resumes it. Returns false when the file does not exist or cannot be parsed.

`firehose( $callback, [ $url ] )`

Returns a new At::Protocol::Firehose client for real-time streaming.

my $fh = $bsky->firehose(sub ($header, $body, $err) { ... });
$fh->start();

See At::Protocol::Firehose for more details.

Feed and Content

Methods in this category create, modify, access, and delete content.

`getTrendingTopics( [...] )`

$bsky->getTrendingTopics( );

Get a list of trending topics.

Expected parameters include:

viewer

DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.

limit

Integer.

Default: 10, Minimum: 1, Maximum: 25.

`getTimeline( [...] )`

$bsky->getTimeline();

Get a view of the requesting account's home timeline. This is expected to some form of reverse-chronological feed.

Expected parameters include:

algorithm

Variant 'algorithm' for timeline. Implementation-specific.

NOTE: most feed flexibility has been moved to feed generator mechanism.

limit

Integer.

Default: 50, Minimum: 1, Maximum: 100.

cursor

`getFeed( $feed, [...] )`

$bsky->getFeed( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/3l6oveex3ii2l' );

Get a hydrated feed from a feed generator. $feed is the feed generator AT-URI. Returns the feed arrayref.

`getFeedSkeleton( $feed, [...] )`

$bsky->getFeedSkeleton( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/3l6oveex3ii2l' );

Get a feed skeleton (list of URIs) from a feed generator. $feed is the feed generator AT-URI. Returns the feed arrayref.

`getListFeed( $list, [...] )`

$bsky->getListFeed( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3l6oveex3ii2l' );

Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth. Returns the feed arrayref.

`sendInteractions( [...] )`

$bsky->sendInteractions( interactions => [ { item => $uri, event => 'app.bsky.feed.defs#interactionSeen' } ] );

Send information about interactions with feed items back to the feed generator that served them. Accepts interactions (required) and an optional feed AT-URI.

`getAuthorFeed( ... )`

$bsky->getAuthorFeed( actor => 'sankorobinson.com' );

Get a view of an actor's 'author feed' (post and reposts by the author).

Expected parameters include:

actor - required

AT-identifier for the author.

limit

Integer.

Default: 50, Minimum: 1, Maximum: 100.

cursor

filter

Combinations of post/repost types to include in response.

Known values:

posts_with_replies - default
posts_no_replies
posts_with_media
posts_and_author_threads
posts_with_video

includePins

Boolean value (false is default).

An error is returned if the client is blocked by the actor.

`getPostThread( ... )`

$bsky->getPostThread( uri => 'at://bsky.app/app.bsky.feed.post/3l6oveex3ii2l' );

Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.

Expected parameters include:

uri - required

Reference (AT-URI) to post record.

depth

How many levels of reply depth should be included in response.

Default: 6, Minimum: 0, Maximum: 1000.

parentHeight

How many levels of parent (and grandparent, etc) post to include.

Default: 80, Minimum: 0, Maximum: 1000.

Returns an error if the thread cannot be found.

`getPost( ... )`

$bsky->getPost('at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2');

Gets a single post view for a specified post (by AT-URI).

Expected parameters include:

uri - required: AT-URI.

`getPosts( ... )`

$bsky->getPosts(
    'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l',
    'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3lbvgvbvcf22c'
);

Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.

Expected parameters include:

uris - required: List of (up to 25) post AT-URIs to return hydrated views for.

`getLikes( ... )`

$bsky->getLikes( uri => 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Get like records which reference a subject (by AT-URI and CID).

Expected parameters include:

uri - required

AT-URI of the subject (eg, a post record).

cid

CID of the subject record (aka, specific version of record), to filter likes.

limit

Integer.

Default: 50, Minimum: 1, Maximum: 100.

cursor

`getBookmarks( ... )`

$bsky->getBookmarks();

Get private bookmarks for the authorized account.

`createBookmark( ... )`

$bsky->createBookmark( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Create a private bookmark for a post.

`deleteBookmark( ... )`

$bsky->deleteBookmark( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Delete a private bookmark.

`getQuotes( ... )`

$bsky->getQuotes( uri => 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Get quotes of a post.

`getActorLikes( ... )`

$bsky->getActorLikes( actor => 'sankorobinson.com' );

Get a list of posts liked by an actor.

`searchPosts( ... )`

$bsky->searchPosts( q => 'perl' );

Find posts matching search criteria.

`getSuggestedFeeds( ... )`

$bsky->getSuggestedFeeds();

Get suggested feed generators.

`describeFeedGenerator( )`

$bsky->describeFeedGenerator();

Get information about a feed generator.

`getFeedGenerator( ... )`

$bsky->getFeedGenerator( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.generator/3l6oveex3ii2l' );

Get information about a feed generator.

`getFeedGenerators( ... )`

$bsky->getFeedGenerators( feeds => [ ... ] );

Get information about multiple feed generators.

`getActorFeeds( ... )`

$bsky->getActorFeeds( actor => 'sankorobinson.com' );

Get a list of feed generators created by an actor.

`getRepostedBy( ... )`

$bsky->getRepostedBy( uri => 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Get repost records which reference a subject (by AT-URI and CID).

`createPost( ... )`

$bsky->createPost( text => 'Test. Test. Test.' );

Create a new post.

Expected parameters include:

text - required

The primary post content. May be an empty string, if there are embeds.

The lexicon limits text to 300 graphemes (3000 bytes).

Annotations of text (mentions, URLs, hashtags, etc) are automatically parsed. These include:

mentions

Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.

This is an example. Here, I am mentioning @atproto.bsky.social and it links to their profile.

links

Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.

This is an example that would link to Google here: https://google.com/.

tags

Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags').

This is an example that would link to a few hashtags. #perl #atproto

timestamp

Client-declared timestamp (ISO 8601 in UTC) when this post was originally created.

A timezone is required and a trailing Z is preferred over +00:00, per https://atproto.com/specs/lexicon#string-formats. Clients may supply any value (useful for imports and migration), but far-future values sort first everywhere.

Defaults to the current time.

lang

Indicates human language of post primary text content. Up to 3 language codes.

$bsky->createPost(
    lang     => [ 'en', 'ja' ],
    reply_to => 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lbvllq2kul27',
    text     => 'こんにちは, World!'
);

This is expected to be a comma separated string of language codes (e.g. en-US,en;q=0.9,fr).

Bluesky recommends sending the Accept-Language header to get posts in the user's preferred language. See https://www.w3.org/International/questions/qa-lang-priorities.en and https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry.

reply_to

AT-URL of a post to reply to.

$bsky->createPost( reply_to => 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lbvllq2kul27', text => 'Exactly!' );

reply_gate

Arrayref of rules to restrict who can reply to this post (thread gate). At most 5 rules.

An empty arrayref means nobody can reply; omitting reply_gate means anybody can reply.

Supported rules:

mention - Only users mentioned in the post can reply.
follower - Only users following the author can reply.
following - Only users the author follows can reply.
list - Only users in a specific moderation list can reply (requires reply_gate_list).

Example:

$bsky->createPost( text => 'Private post', reply_gate => ['following'] );

reply_gate_list

The AT-URI of a moderation list to use with the list rule in reply_gate.

post_gate

Arrayref of rules to restrict embedding or quoting of this post.

Currently supports:

disable - Disable all quotes and embeds of this post.

Example:

$bsky->createPost( text => 'No quoting allowed', post_gate => ['disable'] );

embed

Bluesky allows for posts to contain embedded data.

Known embed types:

images

Up to 4 images (path name or raw data), each limited to 1,000,000 bytes.

Set alt text by passing a hash.

$bsky->createPost(
    embed    => { images => ['path/to/my.jpg'] },
    lang     => 'en',
    reply_to => 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lbvllq2kul27',
    text     => 'I found this image on https://google.com/'
);

$bsky->createPost(
    embed    => { images => [{ alt => 'Might be a picture of a frog.', image => 'path/to/my.jpg' }] },
    lang     => 'en',
    reply_to => 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lbvllq2kul27',
    text     => 'I found this image on https://google.com/'
);

Each image may also carry an aspectRatio ({ width => 4, height => 3 }).

$bsky->createPost(
    embed => { images => [ { image => 'path/to/my.jpg', alt => 'A frog.', aspectRatio => { width => 4, height => 3 } } ] },
    text  => 'Look at this!'
);

gallery

A gallery embed (app.bsky.embed.gallery). The schema allows up to 20 items, though clients currently soft-limit authoring UIs to 10. Each item is a hash with image and alt, plus an optional aspectRatio.

$bsky->createPost(
    embed => { gallery => [
        { image => 'one.jpg', alt => 'First',  aspectRatio => { width => 4, height => 3 } },
        { image => 'two.jpg', alt => 'Second', aspectRatio => { width => 1, height => 1 } },
    ] },
    text => 'A little gallery.'
);

url

A card (including the URL, the page title, and a description) will be presented in a GUI.

$bsky->createPost( embed => { url => 'https://en.wikipedia.org/wiki/Main_Page' }, text => <<'END');
This is the link to wikipedia, @atproto.bsky.social. You should check it out.
END

ref

An AT-URL to link from this post.

video

A video to be embedded in a Bluesky record (eg, a post).

$bsky->createPost( embed => { video => 'path/to/cat.mpeg' }, text => 'Loot at this little guy!' );

This might be a single path, raw data, or a hash reference (if you're really into what and how the video is presented).

If passed a hash, the following are expected:

video - required

The path name.

alt

Alt text description of the video, for accessibility.

mime

Mime type.

We try to figure this out internally if undefined.

aspectRatio

Represents an aspect ratio.

It may be approximate, and may not correspond to absolute dimensions in any given unit.

...
aspectRatio =>{ width => 100, height => 120 },
...

captions

This is a hash reference of up to 20 WebVTT files organized by language.

...
captions => {
    en => 'english.vtt',
    ja => 'japanese.vtt'
},
...

presentation

A hint to clients about how to present the video. Known values are default and gif.

...
presentation => 'gif',
...

You may also pass your own valid embed: any hashref carrying a $type key is used verbatim. This is how the video service flow is embedded, using "videoEmbed( $blob, %opts )" to wrap the processed blob returned by "getVideoJobStatus( $jobId )".

labels

Self-label values for this post. Effectively content warnings. Up to 10 values.

tags

Additional hashtags, in addition to any included in post text and facets. Up to 8 tags.

These are not visible in the current Bluesky interface but do cause posts to return as results to to search (such as https://bsky.app/hashtag/perl.

Note that a post may only contain one of the following embeds: images, gallery, video, embed_url, or embed_ref.

`deletePost( ... )`

$bsky->deletePost( 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lcdwvquo7y25' );

my $post = $bsky->createPost( ... );
...
$bsky->deletePost( $post->{uri} );

Delete a post or ensures it doesn't exist.

Expected parameters include:

uri - required

`like( ... )`

$bsky->like( 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lcdwvquo7y25' );

$bsky->like( 'at://did:plc:totallymadeupgarbagehere/app.bsky.feed.post/randomexample', 'fu82qrfrf829crw89rfpuwcfiosdfcu8239wcrusiofcv2epcuy8r9jkfsl' );

Like a post publically.

Expected parameters include:

uri - required: The AT-URI of the post.
cid: If undefined, the post is fetched to gather this for you.

On success, a record is returned.

`deleteLike( ... )`

$bsky->deleteLike( 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lcdwvquo7y25' );

$bsky->deleteLike( 'at://did:plc:totallymadeupgarbagehere/app.bsky.feed.like/randomexample' );

Remove a like record.

Expected parameters include:

uri - required: The AT-URI of the post or the like record itself.

On success, commit info is returned.

`repost( ... )`

$bsky->repost( 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.post/3lcdwvquo7y25' );

Repost a post.

Expected parameters include:

uri - required: The AT-URI of the post.
cid: If undefined, the post is fetched to gather this for you.

`deleteRepost( ... )`

$bsky->deleteRepost( 'at://did:plc:pwqewimhd3rxc4hg6ztwrcyj/app.bsky.feed.repost/3lcdwvquo7y25' );

Remove a repost record.

`uploadBlob( $data, [...] )`

$bsky->uploadBlob( $data, mime_type => 'image/png' );

Upload a blob (file/data) to the PDS. See also "uploadFile( $bytes_or_path, [ $mime_type ] )"; it delegates to $bsky->at->upload_blob.

Methods documented in this section deal with relationships between the authorized user and other members of the social network.

`block( $actor )`

$bsky->block( 'sankorobinson.com' );

Blocks a user. $actor is the handle or DID of the person you'd like to block.

`getBlocks( [...] )`

$bsky->getBlocks( );

Enumerates which accounts the requesting account is currently blocking.

Requires auth.

Expected parameters include:

limit

Integer.

Default: 50, Minimum: 1, Maximum: 100.

cursor

Returns a list of actor profile views on success.

`deleteBlock( ... )`

$bsky->deleteBlock( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.block/3l6oveex3ii2l' );

Unblocks a user by removing the block record.

`follow( ... )`

$bsky->follow( 'sankorobinson.com' );

Follows a user.

`deleteFollow( ... )`

$bsky->deleteFollow( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.follow/3l6oveex3ii2l' );

Unfollows a user by removing the follow record.

`getFollows( ... )`

$bsky->getFollows( 'sankorobinson.com' );

Enumerates who an account is following.

`getFollowers( ... )`

$bsky->getFollowers( 'sankorobinson.com' );

Enumerates who is following an account.

`getKnownFollowers( ... )`

$bsky->getKnownFollowers( 'sankorobinson.com' );

Enumerates followers of an account that the authorized user also follows (mutuals).

`getRelationships( [...] )`

$bsky->getRelationships( actors => ['sankorobinson.com', 'bsky.app'] );

Enumerates relationships between the authorized user and other actors. actors is accepted as an alias for others; actor defaults to the authenticated DID if omitted.

`getMutes( ... )`

$bsky->getMutes();

Enumerate actors that the authorized user has muted.

`getListBlocks( [...] )`

$bsky->getListBlocks();

Get mod lists that the requesting account is blocking. Requires auth. Returns the lists arrayref.

`getListMutes( [...] )`

$bsky->getListMutes();

Enumerate mod lists that the requesting account currently has muted. Requires auth. Returns the lists arrayref.

`muteThread( ... )`

$bsky->muteThread( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Mute a thread.

`unmuteThread( ... )`

$bsky->unmuteThread( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.feed.post/3l6oveex3ii2l' );

Unmute a thread.

`getLists( ... )`

$bsky->getLists( 'sankorobinson.com' );

Enumerate moderation lists created by an actor.

`getList( ... )`

$bsky->getList( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3l6oveex3ii2l' );

Get detailed view of a moderation list.

`getListsWithMembership( $actor, [...] )`

$bsky->getListsWithMembership( 'sankorobinson.com' );

Enumerate the lists created by the session user, including membership information about $actor in those lists. Requires auth. Returns the listsWithMembership arrayref.

`getStarterPack( ... )`

$bsky->getStarterPack( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.starterpack/3l6oveex3ii2l' );

Get a detailed view of a starter pack.

`getStarterPacks( @uris )`

$bsky->getStarterPacks(
    'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.starterpack/3l6oveex3ii2l',
    'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.starterpack/3l6oveex3ii2m'
);

Get views for a list of starter packs.

`getActorStarterPacks( ... )`

$bsky->getActorStarterPacks( 'sankorobinson.com' );

Get starter packs created by an actor.

`getStarterPacksWithMembership( $actor, [...] )`

$bsky->getStarterPacksWithMembership( 'sankorobinson.com' );

Enumerate the starter packs created by the session user, including membership information about $actor in those starter packs. Requires auth.

`getSuggestedFollowsByActor( $actor )`

$bsky->getSuggestedFollowsByActor( 'sankorobinson.com' );

Enumerate follows similar to a given account. Expected use is recommending additional accounts immediately after following one account. Returns the suggestions arrayref.

`searchStarterPacks( ... )`

$bsky->searchStarterPacks( q => 'perl' );

Find starter packs matching search criteria. Requires auth. Returns the starterPacks arrayref.

Actors

Methods in this section deal with profile information and actor discovery.

`getProfile( ... )`

$bsky->getProfile( 'sankorobinson.com' );

Get detailed profile view of an actor.

`getPreferences( )`

$bsky->getPreferences();

Get private preferences for the authorized account.

`putPreferences( ... )`

$bsky->putPreferences( [ ... ] );

Update private preferences for the authorized account.

`upsertProfile( &callback )`

$bsky->upsertProfile( sub (%existing) {
    return { %existing, displayName => 'New Name' };
});

Retrieve the current profile, allow a callback to modify it, and then update it.

`getProfiles( ... )`

$bsky->getProfiles( actors => ['sankorobinson.com', 'bsky.app'] );

Get detailed profile views of multiple actors.

`getSuggestions( )`

$bsky->getSuggestions();

Get a list of suggested actors.

`searchActors( ... )`

$bsky->searchActors( q => 'perl' );

Search for actors.

`searchActorsTypeahead( ... )`

$bsky->searchActorsTypeahead( q => 'san' );

Find actor suggestions for a partial search term.

`mute( ... )`

$bsky->mute( 'sankorobinson.com' );

Mutes an actor.

`unmute( ... )`

$bsky->unmute( 'sankorobinson.com' );

Unmutes an actor.

`muteModList( ... )`

$bsky->muteModList( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3l6oveex3ii2l' );

Mutes all actors in a moderation list.

`unmuteModList( ... )`

$bsky->unmuteModList( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3l6oveex3ii2l' );

Unmutes all actors in a moderation list.

`blockModList( ... )`

$bsky->blockModList( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3l6oveex3ii2l' );

Blocks all actors in a moderation list.

`unblockModList( ... )`

$bsky->unblockModList( 'at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.listblock/3l6oveex3ii2l' );

Unblocks a moderation list.

Moderation

Submits reports and manages moderation artifacts. For muting/blocking actors and lists, see "Actors".

`report( $subject, $reason_type, [ $reason ] )`

Submits a moderation report.

Expected parameters:

$subject - The AT-URI or DID being reported.
$reason_type - Lexicon-defined reason (e.g., com.atproto.moderation.defs#reasonSpam).
$reason - Optional free-text description.

Notifications

Methods in this section deal with notifications.

`listNotifications( ... )`

$bsky->listNotifications();

Enumerate notifications for the authorized user.

`countUnreadNotifications( )`

$bsky->countUnreadNotifications();

Count unread notifications.

`updateSeenNotifications( [ $seenAt ] )`

$bsky->updateSeenNotifications();

Update when notifications were last seen.

`getNotificationPreferences( )`

$bsky->getNotificationPreferences();

Get notification-related preferences for the account. Requires auth.

`putNotificationPreferences( ... )`

$bsky->putNotificationPreferences( priority => 1 );

Set notification-related preferences for the account. Requires auth.

`putNotificationPreferencesV2( ... )`

$bsky->putNotificationPreferencesV2( like => { list => 1, push => 1, include => 'follows' } );

Set granular notification preferences (chat, like, quote, reply, follow, repost, mention, etc). Requires auth. Returns the updated preferences.

`listActivitySubscriptions( [...] )`

$bsky->listActivitySubscriptions();

Enumerate all accounts to which the requesting account is subscribed to receive notifications for. Requires auth. Returns the subscriptions arrayref.

`putActivitySubscription( $subject, $activitySubscription )`

$bsky->putActivitySubscription( 'did:plc:...', { post => 1, reply => 1 } );

Subscribe (or update a subscription) to activity notifications for $subject. Requires auth.

`registerPush( ... )`

$bsky->registerPush( serviceDid => 'did:web:...', token => '...', platform => 'ios', appId => '...' );

`unregisterPush( ... )`

$bsky->unregisterPush( serviceDid => 'did:web:...', token => '...', platform => 'ios', appId => '...' );

Stop push notifications for the given token. Requires auth.

Identity

Methods in this section deal with handle and DID resolution.

`resolveHandle( ... )`

$bsky->resolveHandle( 'sankorobinson.com' );

Resolves a handle to a DID.

`updateHandle( ... )`

$bsky->updateHandle( 'new-handle.bsky.social' );

Updates the handle for the authorized user.

`describeServer( )`

$bsky->describeServer();

Describes the server's account creation requirements and capabilities.

`listRecords( ... )`

$bsky->listRecords( repo => 'sankorobinson.com', collection => 'app.bsky.feed.post' );

List records in a repository collection.

`getLabelerServices( ... )`

$bsky->getLabelerServices( dids => [ ... ] );

Get views of labeler services.

`queryLabels( ... )`

$bsky->queryLabels( uriPatterns => [ 'at://did:plc:.../*' ] );

Find labels relevant to the provided AT-URI patterns. Accepts uriPatterns (required), sources, limit, and cursor. Returns the labels arrayref.

Chat

Methods in this section deal with direct messaging and conversations.

`listConvos( [...] )`

$bsky->listConvos();

Enumerates conversations for the authorized user.

`getConvo( $convoId )`

$bsky->getConvo( $convoId );

Get a detailed view of a conversation.

`getConvoForMembers( members => [ ... ] )`

$bsky->getConvoForMembers( members => [ 'did:plc:...' ] );

Get or create a conversation for a list of members.

`getMessages( convoId => ..., [...] )`

$bsky->getMessages( convoId => $convoId );

Get messages in a conversation.

`sendMessage( $convoId, { text => ... } )`

$bsky->sendMessage( $convoId, { text => 'Hello!' } );

Send a message to a conversation.

`acceptConvo( $convoId )`

$bsky->acceptConvo( $convoId );

Accept a conversation request.

`leaveConvo( $convoId )`

$bsky->leaveConvo( $convoId );

Leave a conversation.

`updateRead( $convoId, [ $messageId ] )`

$bsky->updateRead( $convoId );

Update the read status of a conversation.

`muteConvo( $convoId )`

$bsky->muteConvo( $convoId );

Mute a conversation.

`unmuteConvo( $convoId )`

$bsky->unmuteConvo( $convoId );

Unmute a conversation.

`addReaction( $convoId, $messageId, $reaction )`

$bsky->addReaction( $convoId, $messageId, '👍' );

Add a reaction to a message.

`removeReaction( $convoId, $messageId, $reaction )`

$bsky->removeReaction( $convoId, $messageId, '👍' );

Remove a reaction from a message.

`deleteMessageForSelf( $convoId, $messageId )`

$bsky->deleteMessageForSelf( $convoId, $messageId );

Delete a message for the local user.

`getConvoAvailability( [...] )`

$bsky->getConvoAvailability();

Check if the authorized user can join conversations.

`getLog( [...] )`

$bsky->getLog();

Get a log of chat events.

Video Services

Methods in this section deal with the video upload service.

`getVideoUploadLimits( )`

$bsky->getVideoUploadLimits();

Get video upload limits for the authenticated user (whether uploads are allowed, remaining daily bytes/videos).

`getVideoJobStatus( $jobId )`

$bsky->getVideoJobStatus( $jobId );

Get status details for a video processing job. Returns the jobStatus.

`uploadVideoJob( $bytes_or_path, [ $mime_type, %opts ] )`

$bsky->uploadVideoJob( 'path/to/clip.mp4', 'video/mp4', did => $bsky->did, name => 'clip.mp4' );

Upload a video to the video service (app.bsky.video.uploadVideo) for processing. Returns the jobStatus; poll "getVideoJobStatus( $jobId )" until blob is present, then use that blob in a post.

Optional %opts:

did and name - Identifying query params accepted by the video service. did defaults to the authenticated user.
host - Service host. Defaults to https://video.bsky.app.
token - Pre-minted service token to send as a Bearer token. By default one is fetched from the PDS with com.atproto.server.getServiceAuth.
aud and exp - Override the audience (defaults to the user's PDS DID) and expiry of the minted service token.

The video service cannot be reached through the PDS: uploadVideo posts the bytes to https://video.bsky.app/xrpc/app.bsky.video.uploadVideo with an Authorization: Bearer service token (not the session's DPoP token). The token is minted by the user's PDS via com.atproto.server.getServiceAuth with the PDS DID as the audience and com.atproto.repo.uploadBlob as the lexicon, because the service deposits the processed blob into your PDS on your behalf. "getVideoUploadLimits( )" and "getVideoJobStatus( $jobId )" use the video service host too.

Unlike "uploadVideo( $video )", which uploads a finished blob for embedding, this starts a server-side processing job. The recommended flow from https://bsky.network/docs/about-bluesky-content/video is: create a service token for com.atproto.repo.uploadBlob, upload to the video service, poll the job for its blob, then post. The uploadVideo reply is the job status: if it already carries a blob use it directly, otherwise poll "getVideoJobStatus( $jobId )" until blob is present. If the video was already processed the service reports an already_exists error (HTTP 409), and the returned job may need to be polled to obtain its blob. Note that Bluesky-hosted accounts must verify their email before uploading video, and daily video limits apply (see "getVideoUploadLimits( )").

Drafts

Methods in this section manage private post drafts (stored server-side, requiring auth).

`getDrafts( [...] )`

$bsky->getDrafts();

Get views of the user's drafts. Returns the drafts arrayref.

`createDraft( $draft )`

$bsky->createDraft( { posts => [ { text => 'Unfinished thought...' } ] } );

Insert a draft. Returns the creation response, including the draft id.

`updateDraft( $draft )`

$bsky->updateDraft( { id => $id, draft => { posts => [ ... ] } } );

Update a draft. Updates to unknown IDs are silently ignored.

`deleteDraft( $id )`

$bsky->deleteDraft( $id );

Delete a draft by ID.

Contacts

Methods in this section deal with secure contact-import matching (all require auth).

`getContactMatches( [...] )`

$bsky->getContactMatches();

Return matched contacts (mutually imported, excluding dismissed matches). Returns the matches arrayref.

`getContactSyncStatus( )`

$bsky->getContactSyncStatus();

Get the user's current contact import status.

`importContacts( ... )`

$bsky->importContacts( token => $token, contacts => [ '+12125550123' ] );

Import contacts for secure matching. $token comes from "verifyPhone( $phone, $code )". Returns matched contacts with their input indexes. See https://docs.bsky.app/blog/contact-import-rfc.

`dismissContactMatch( $subject )`

$bsky->dismissContactMatch( 'did:plc:...' );

Dismiss a contact match so it no longer appears, even on re-import.

`removeContactData( )`

$bsky->removeContactData();

Remove all stored contact-matching hashes, matches, and sync status.

`startPhoneVerification( $phone )`

$bsky->startPhoneVerification( '+12125550123' );

Start a phone verification flow; the phone receives an SMS code for "verifyPhone( $phone, $code )".

`verifyPhone( $phone, $code )`

my $token = $bsky->verifyPhone( '+12125550123', '123456' );

Verify control over a phone number and start a contact import session. Returns a single-use token for "importContacts( ... )".

Age Assurance

Methods in this section deal with Age Assurance.

`beginAgeAssurance( ... )`

$bsky->beginAgeAssurance( email => 'me@example.com', language => 'en', countryCode => 'US' );

Initiate Age Assurance for the account. Requires email, language, and countryCode.

`getAgeAssuranceConfig( )`

$bsky->getAgeAssuranceConfig();

Return Age Assurance configuration for use on the client.

`getAgeAssuranceState( ... )`

$bsky->getAgeAssuranceState( countryCode => 'US' );

Return the server-computed Age Assurance state. countryCode is required.

Utilities and Upload Helpers

Helper methods used internally by "createPost( ... )" and available for advanced use.

`parse_mentions( $text )`

Returns a list of { start => ..., end => ..., handle => ... } spans for @-mentions in $text.

`parse_urls( $text )`

Returns a list of { start => ..., end => ..., url => ... } spans for URLs in $text.

`parse_tags( $text )`

Returns a list of { start => ..., end => ..., tag => ... } spans for #-tags in $text.

`parse_facets( $text )`

Resolves mentions, URLs, and tags in $text into an array of app.bsky.richtext.facet structures.

Facet indexes are byte offsets into the UTF-8 encoding (inclusive start, exclusive end), not character offsets; this module enables bytes internally so the offsets come out correctly. Facets must not overlap. See https://bsky.network/docs/about-bluesky-content/post-richtext.

`parse_uri( $uri )`

my $parts = $bsky->parse_uri( 'at://did:plc:.../app.bsky.feed.post/3l6oveex3ii2l' );

Returns { repo => ..., collection => ..., rkey => ... } for an AT-URI.

`getReplyRefs( $parent_uri )`

Fetches parent (and root, if the parent is itself a reply) records and returns { root => ..., parent => ... } strong refs suitable for app.bsky.feed.post replies.

`uploadFile( $bytes_or_path, [ $mime_type ] )`

Reads a file, Path::Tiny object, or raw bytes and uploads it via com.atproto.repo.uploadBlob using HTTP::Tiny directly. Returns the blob on success.

`uploadImages( @images )`

Uploads up to 4 images (paths, raw bytes, Path::Tiny objects, or { image => ..., alt => ..., mime => ..., aspectRatio => { width => ..., height => ... } } hashrefs) and returns an app.bsky.embed.images structure.

`uploadGallery( @items )`

Uploads gallery items (same accepted forms as "uploadImages( @images )") and returns an app.bsky.embed.gallery structure. Each item becomes an app.bsky.embed.gallery#image and may carry an aspectRatio.

`uploadVideoCaption( $lang, $caption )`

Uploads a WebVTT caption file and returns an app.bsky.embed.video#caption structure.

`uploadVideo( $video )`

Uploads a video blob (path, raw bytes, Path::Tiny object, or hashref with video, alt, mime, aspectRatio, presentation, and captions) and returns an app.bsky.embed.video structure.

This uploads a finished video blob straight to the PDS. To run the video service's server-side processing job instead, use "uploadVideoJob( $bytes_or_path, [ $mime_type, %opts ] )" and then "videoEmbed( $blob, %opts )".

`videoEmbed( $blob, %opts )`

Builds an app.bsky.embed.video structure from an already-uploaded blob, typically the processed blob returned by "getVideoJobStatus( $jobId )" after "uploadVideoJob( $bytes_or_path, [ $mime_type, %opts ] )". Recognized %opts are alt, aspectRatio, presentation (default or gif), and captions (either { lang => file } or [ { lang => ..., file => ... } ]). Caption files are uploaded for you.

my $job    = $bsky->uploadVideoJob( 'clip.mp4', 'video/mp4', did => $bsky->did, name => 'clip.mp4' );
my $status = $bsky->getVideoJobStatus( $job->{jobId} );
my $embed  = $bsky->videoEmbed( $status->{blob},
    alt          => 'A cat playing a piano',
    aspectRatio  => { width => 1280, height => 720 },
    presentation => 'default',
    captions     => { en => 'captions.en.vtt' },
);
$bsky->createPost( text => 'Music!', embed => $embed );

`getEmbedRef( $uri )`

Fetches a record and returns an app.bsky.embed.record structure linking to it.

`fetch_embed_url_card( $url )`

Fetches $url, extracts title/description/thumbnail, and returns an app.bsky.embed.external structure.

Perl Starter Pack

I've created a starter pack of Perl folks on Bluesky.

Follow it at https://bsky.app/starter-pack/sankorobinson.com/3lk3xd5utq52s and get in touch to have yourself added.

LICENSE

This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module.

AUTHOR

Sanko Robinson - https://github.com/sanko

To install Bluesky, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Bluesky

CPAN shell

perl -MCPAN -e shell
install Bluesky

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

Constructor and Session Management

new( [...] )

ensure_auth( %args )

oauth_helper( %args )

oauth_start( $handle, $client_id, $redirect_uri, [ $scope ] )

oauth_callback( $code, $state )

login( $identifier, $password )

resume( $accessJwt, $refreshJwt, [ $token_type, ... ] )

session( )

did( )

save_session( [ $file ] )

load_session( [ $file ] )

firehose( $callback, [ $url ] )

Feed and Content

getTrendingTopics( [...] )

getTimeline( [...] )

getFeed( $feed, [...] )

getFeedSkeleton( $feed, [...] )

getListFeed( $list, [...] )

sendInteractions( [...] )

getAuthorFeed( ... )

getPostThread( ... )

getPost( ... )

getPosts( ... )

getLikes( ... )

getBookmarks( ... )

createBookmark( ... )

deleteBookmark( ... )

getQuotes( ... )

getActorLikes( ... )

searchPosts( ... )

getSuggestedFeeds( ... )

describeFeedGenerator( )

getFeedGenerator( ... )

getFeedGenerators( ... )

getActorFeeds( ... )

getRepostedBy( ... )

createPost( ... )

deletePost( ... )

like( ... )

deleteLike( ... )

repost( ... )

deleteRepost( ... )

uploadBlob( $data, [...] )

Social Graph

block( $actor )

getBlocks( [...] )

deleteBlock( ... )

follow( ... )

deleteFollow( ... )

getFollows( ... )

getFollowers( ... )

getKnownFollowers( ... )

getRelationships( [...] )

getMutes( ... )

getListBlocks( [...] )

getListMutes( [...] )

muteThread( ... )

unmuteThread( ... )

getLists( ... )

getList( ... )

getListsWithMembership( $actor, [...] )

getStarterPack( ... )

getStarterPacks( @uris )

getActorStarterPacks( ... )

getStarterPacksWithMembership( $actor, [...] )

getSuggestedFollowsByActor( $actor )

searchStarterPacks( ... )

Actors

getProfile( ... )

getPreferences( )

putPreferences( ... )

upsertProfile( &callback )

getProfiles( ... )

getSuggestions( )

searchActors( ... )

searchActorsTypeahead( ... )

`new( [...] )`

`ensure_auth( %args )`

`oauth_helper( %args )`

`oauth_start( $handle, $client_id, $redirect_uri, [ $scope ] )`

`oauth_callback( $code, $state )`

`login( $identifier, $password )`

`resume( $accessJwt, $refreshJwt, [ $token_type, ... ] )`

`session( )`

`did( )`

`save_session( [ $file ] )`

`load_session( [ $file ] )`

`firehose( $callback, [ $url ] )`

`getTrendingTopics( [...] )`

`getTimeline( [...] )`

`getFeed( $feed, [...] )`

`getFeedSkeleton( $feed, [...] )`

`getListFeed( $list, [...] )`

`sendInteractions( [...] )`

`getAuthorFeed( ... )`

`getPostThread( ... )`

`getPost( ... )`

`getPosts( ... )`

`getLikes( ... )`

`getBookmarks( ... )`

`createBookmark( ... )`

`deleteBookmark( ... )`

`getQuotes( ... )`

`getActorLikes( ... )`

`searchPosts( ... )`

`getSuggestedFeeds( ... )`

`describeFeedGenerator( )`

`getFeedGenerator( ... )`

`getFeedGenerators( ... )`

`getActorFeeds( ... )`

`getRepostedBy( ... )`

`createPost( ... )`

`deletePost( ... )`

`like( ... )`

`deleteLike( ... )`

`repost( ... )`

`deleteRepost( ... )`

`uploadBlob( $data, [...] )`

`block( $actor )`

`getBlocks( [...] )`

`deleteBlock( ... )`

`follow( ... )`

`deleteFollow( ... )`

`getFollows( ... )`

`getFollowers( ... )`

`getKnownFollowers( ... )`

`getRelationships( [...] )`

`getMutes( ... )`

`getListBlocks( [...] )`

`getListMutes( [...] )`

`muteThread( ... )`

`unmuteThread( ... )`

`getLists( ... )`

`getList( ... )`

`getListsWithMembership( $actor, [...] )`

`getStarterPack( ... )`

`getStarterPacks( @uris )`

`getActorStarterPacks( ... )`

`getStarterPacksWithMembership( $actor, [...] )`

`getSuggestedFollowsByActor( $actor )`

`searchStarterPacks( ... )`

`getProfile( ... )`

`getPreferences( )`

`putPreferences( ... )`

`upsertProfile( &callback )`

`getProfiles( ... )`

`getSuggestions( )`

`searchActors( ... )`

`searchActorsTypeahead( ... )`

`mute( ... )`

`unmute( ... )`

`muteModList( ... )`

`unmuteModList( ... )`

`blockModList( ... )`

`unblockModList( ... )`

`report( $subject, $reason_type, [ $reason ] )`