-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathbluesky.yaml
More file actions
1871 lines (1801 loc) · 48.1 KB
/
bluesky.yaml
File metadata and controls
1871 lines (1801 loc) · 48.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Bluesky API
description: |
Comprehensive Bluesky (AT Protocol) API covering social media functionality including posts, feeds,
profiles, social graph, notifications, chat/DMs, and protocol-level operations.
This API includes both Bluesky application lexicons (app.bsky.*) and AT Protocol core lexicons (com.atproto.*).
Public endpoints can be accessed at: https://public.api.bsky.app
Authenticated requests are typically made to the user's PDS instance.
version: 1.0.0
contact:
name: Bluesky Documentation
url: https://docs.bsky.app
license:
name: MIT
servers:
- url: https://public.api.bsky.app
description: Public Bluesky AppView API
- url: https://bsky.social
description: Main Bluesky instance
paths:
# Actor (Profile/User) Management
/xrpc/app.bsky.actor.getPreferences:
get:
tags: [Actor]
summary: Get actor preferences
description: Get user preferences and settings
security:
- BearerAuth: []
responses:
'200':
description: User preferences retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ActorPreferences'
/xrpc/app.bsky.actor.putPreferences:
post:
tags: [Actor]
summary: Update actor preferences
description: Update user preferences and settings
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActorPreferences'
responses:
'200':
description: Preferences updated successfully
/xrpc/app.bsky.actor.getProfile:
get:
tags: [Actor]
summary: Get actor profile
description: Get detailed profile information for a user
parameters:
- name: actor
in: query
required: true
description: Actor identifier (handle or DID)
schema:
type: string
responses:
'200':
description: Profile retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ActorProfile'
/xrpc/app.bsky.actor.getProfiles:
get:
tags: [Actor]
summary: Get multiple actor profiles
description: Get profile information for multiple users
parameters:
- name: actors
in: query
required: true
description: List of actor identifiers
schema:
type: array
items:
type: string
responses:
'200':
description: Profiles retrieved successfully
content:
application/json:
schema:
type: object
properties:
profiles:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
/xrpc/app.bsky.actor.getSuggestions:
get:
tags: [Actor]
summary: Get suggested actors to follow
description: Get a list of suggested users to follow
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Suggestions retrieved successfully
content:
application/json:
schema:
type: object
properties:
actors:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.actor.searchActors:
get:
tags: [Actor]
summary: Search for actors
description: Search for users by handle or display name
parameters:
- name: q
in: query
required: true
description: Search query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 25
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Search results
content:
application/json:
schema:
type: object
properties:
actors:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.actor.searchActorsTypeahead:
get:
tags: [Actor]
summary: Typeahead search for actors
description: Fast typeahead search for users
parameters:
- name: q
in: query
required: true
description: Search query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 10
responses:
'200':
description: Typeahead results
content:
application/json:
schema:
type: object
properties:
actors:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
# Feed and Posts
/xrpc/app.bsky.feed.getTimeline:
get:
tags: [Feed]
summary: Get timeline feed
description: Get the user's timeline feed
security:
- BearerAuth: []
parameters:
- name: algorithm
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Timeline retrieved successfully
content:
application/json:
schema:
type: object
properties:
feed:
type: array
items:
$ref: '#/components/schemas/FeedViewPost'
cursor:
type: string
/xrpc/app.bsky.feed.getAuthorFeed:
get:
tags: [Feed]
summary: Get author's feed
description: Get posts from a specific author
parameters:
- name: actor
in: query
required: true
description: Actor identifier
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
- name: filter
in: query
description: Filter posts type
schema:
type: string
enum: [posts_with_replies, posts_no_replies, posts_with_media, posts_and_author_threads]
responses:
'200':
description: Author feed retrieved successfully
content:
application/json:
schema:
type: object
properties:
feed:
type: array
items:
$ref: '#/components/schemas/FeedViewPost'
cursor:
type: string
/xrpc/app.bsky.feed.getPosts:
get:
tags: [Feed]
summary: Get posts by URIs
description: Get posts by their AT-URIs
parameters:
- name: uris
in: query
required: true
description: List of post URIs
schema:
type: array
items:
type: string
responses:
'200':
description: Posts retrieved successfully
content:
application/json:
schema:
type: object
properties:
posts:
type: array
items:
$ref: '#/components/schemas/PostView'
/xrpc/app.bsky.feed.getPostThread:
get:
tags: [Feed]
summary: Get post thread
description: Get a post and its thread (replies)
parameters:
- name: uri
in: query
required: true
description: Post URI
schema:
type: string
- name: depth
in: query
description: How many levels of replies to fetch
schema:
type: integer
default: 6
- name: parentHeight
in: query
description: How many levels of parent posts to fetch
schema:
type: integer
default: 80
responses:
'200':
description: Post thread retrieved successfully
content:
application/json:
schema:
type: object
properties:
thread:
$ref: '#/components/schemas/ThreadViewPost'
/xrpc/app.bsky.feed.getLikes:
get:
tags: [Feed]
summary: Get post likes
description: Get users who liked a specific post
parameters:
- name: uri
in: query
required: true
description: Post URI
schema:
type: string
- name: cid
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Likes retrieved successfully
content:
application/json:
schema:
type: object
properties:
uri:
type: string
cid:
type: string
likes:
type: array
items:
type: object
properties:
actor:
$ref: '#/components/schemas/ActorProfile'
createdAt:
type: string
format: date-time
cursor:
type: string
/xrpc/app.bsky.feed.getRepostedBy:
get:
tags: [Feed]
summary: Get post reposts
description: Get users who reposted a specific post
parameters:
- name: uri
in: query
required: true
description: Post URI
schema:
type: string
- name: cid
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Reposts retrieved successfully
content:
application/json:
schema:
type: object
properties:
uri:
type: string
cid:
type: string
repostedBy:
type: array
items:
type: object
properties:
actor:
$ref: '#/components/schemas/ActorProfile'
createdAt:
type: string
format: date-time
cursor:
type: string
/xrpc/app.bsky.feed.searchPosts:
get:
tags: [Feed]
summary: Search posts
description: Search for posts by content
parameters:
- name: q
in: query
required: true
description: Search query
schema:
type: string
- name: sort
in: query
description: Sort order
schema:
type: string
enum: [top, latest]
- name: since
in: query
description: Filter posts after this date
schema:
type: string
format: date-time
- name: until
in: query
description: Filter posts before this date
schema:
type: string
format: date-time
- name: mentions
in: query
description: Filter by mentioned actor
schema:
type: string
- name: author
in: query
description: Filter by author
schema:
type: string
- name: lang
in: query
description: Filter by language
schema:
type: string
- name: domain
in: query
description: Filter by domain
schema:
type: string
- name: url
in: query
description: Filter by URL
schema:
type: string
- name: tag
in: query
description: Filter by hashtag
schema:
type: array
items:
type: string
- name: limit
in: query
schema:
type: integer
default: 25
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Search results
content:
application/json:
schema:
type: object
properties:
posts:
type: array
items:
$ref: '#/components/schemas/PostView'
hitsTotal:
type: integer
cursor:
type: string
# Video Management
/xrpc/app.bsky.video.uploadVideo:
post:
tags: [Video]
summary: Upload video
description: Upload a video file to Bluesky for use in posts
security:
- BearerAuth: []
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- video
properties:
video:
type: string
format: binary
description: Video file to upload (MP4, MOV, WEBM formats supported)
alt_text:
type: string
description: Alternative text description for accessibility
maxLength: 1000
caption:
type: string
description: Caption for the video
maxLength: 2200
responses:
'200':
description: Video uploaded successfully
content:
application/json:
schema:
type: object
properties:
blob:
$ref: '#/components/schemas/Blob'
video:
$ref: '#/components/schemas/VideoEmbed'
'400':
description: Invalid video format or size
'413':
description: Video file too large
/xrpc/app.bsky.video.getJobStatus:
get:
tags: [Video]
summary: Get video processing status
description: Check the processing status of an uploaded video
security:
- BearerAuth: []
parameters:
- name: jobId
in: query
required: true
schema:
type: string
description: Video processing job identifier
responses:
'200':
description: Video processing status
content:
application/json:
schema:
type: object
properties:
jobId:
type: string
state:
type: string
enum: [JOB_STATE_PROCESSING, JOB_STATE_COMPLETED, JOB_STATE_FAILED]
progress:
type: integer
minimum: 0
maximum: 100
blob:
$ref: '#/components/schemas/Blob'
error:
type: string
description: Error message if processing failed
/xrpc/app.bsky.video.defs:
get:
tags: [Video]
summary: Get video definitions
description: Get video-related type definitions and limits
responses:
'200':
description: Video definitions
content:
application/json:
schema:
type: object
properties:
maxFileSize:
type: integer
description: Maximum video file size in bytes
maxDuration:
type: integer
description: Maximum video duration in seconds
supportedFormats:
type: array
items:
type: string
description: Supported video file formats
# Social Graph
/xrpc/app.bsky.graph.getFollows:
get:
tags: [Graph]
summary: Get follows
description: Get users that an actor follows
parameters:
- name: actor
in: query
required: true
description: Actor identifier
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Follows retrieved successfully
content:
application/json:
schema:
type: object
properties:
subject:
$ref: '#/components/schemas/ActorProfile'
follows:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.graph.getFollowers:
get:
tags: [Graph]
summary: Get followers
description: Get users that follow an actor
parameters:
- name: actor
in: query
required: true
description: Actor identifier
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Followers retrieved successfully
content:
application/json:
schema:
type: object
properties:
subject:
$ref: '#/components/schemas/ActorProfile'
followers:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.graph.getBlocks:
get:
tags: [Graph]
summary: Get blocked users
description: Get users that the authenticated user has blocked
security:
- BearerAuth: []
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Blocked users retrieved successfully
content:
application/json:
schema:
type: object
properties:
blocks:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.graph.getMutes:
get:
tags: [Graph]
summary: Get muted users
description: Get users that the authenticated user has muted
security:
- BearerAuth: []
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Muted users retrieved successfully
content:
application/json:
schema:
type: object
properties:
mutes:
type: array
items:
$ref: '#/components/schemas/ActorProfile'
cursor:
type: string
/xrpc/app.bsky.graph.muteActor:
post:
tags: [Graph]
summary: Mute an actor
description: Mute a specific user
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
actor:
type: string
description: Actor identifier to mute
required: [actor]
responses:
'200':
description: Actor muted successfully
/xrpc/app.bsky.graph.unmuteActor:
post:
tags: [Graph]
summary: Unmute an actor
description: Unmute a previously muted user
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
actor:
type: string
description: Actor identifier to unmute
required: [actor]
responses:
'200':
description: Actor unmuted successfully
# Notifications
/xrpc/app.bsky.notification.listNotifications:
get:
tags: [Notifications]
summary: List notifications
description: Get the user's notifications
security:
- BearerAuth: []
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
- name: seenAt
in: query
description: Only return notifications after this timestamp
schema:
type: string
format: date-time
responses:
'200':
description: Notifications retrieved successfully
content:
application/json:
schema:
type: object
properties:
notifications:
type: array
items:
$ref: '#/components/schemas/Notification'
cursor:
type: string
seenAt:
type: string
format: date-time
/xrpc/app.bsky.notification.getUnreadCount:
get:
tags: [Notifications]
summary: Get unread count
description: Get count of unread notifications
security:
- BearerAuth: []
parameters:
- name: seenAt
in: query
description: Count notifications after this timestamp
schema:
type: string
format: date-time
responses:
'200':
description: Unread count retrieved successfully
content:
application/json:
schema:
type: object
properties:
count:
type: integer
/xrpc/app.bsky.notification.updateSeen:
post:
tags: [Notifications]
summary: Mark notifications as seen
description: Update the last-seen timestamp for notifications
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
seenAt:
type: string
format: date-time
description: Timestamp to mark as seen
required: [seenAt]
responses:
'200':
description: Notifications marked as seen successfully
# Chat/DM endpoints
/xrpc/chat.bsky.convo.listConvos:
get:
tags: [Chat]
summary: List conversations
description: Get the user's conversation list
security:
- BearerAuth: []
parameters:
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Conversations retrieved successfully
content:
application/json:
schema:
type: object
properties:
convos:
type: array
items:
$ref: '#/components/schemas/ConvoView'
cursor:
type: string
/xrpc/chat.bsky.convo.getConvo:
get:
tags: [Chat]
summary: Get conversation
description: Get a specific conversation
security:
- BearerAuth: []
parameters:
- name: convoId
in: query
required: true
description: Conversation ID
schema:
type: string
responses:
'200':
description: Conversation retrieved successfully
content:
application/json:
schema:
type: object
properties:
convo:
$ref: '#/components/schemas/ConvoView'
/xrpc/chat.bsky.convo.getMessages:
get:
tags: [Chat]
summary: Get conversation messages
description: Get messages from a specific conversation
security:
- BearerAuth: []
parameters:
- name: convoId
in: query
required: true
description: Conversation ID
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 50
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: Messages retrieved successfully
content:
application/json:
schema:
type: object
properties: