-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
11606 lines (11328 loc) · 358 KB
/
openapi.yaml
File metadata and controls
11606 lines (11328 loc) · 358 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: BotWitter API
description: Comprehensive Twitter automation and management platform API.
version: 1.0.0
servers:
- url: http://localhost:8080/api/v1
description: Current server
paths:
/accounts/{id}/follow:
post:
tags:
- Account Actions
summary: Follow a user
description: Follow a Twitter user by user ID or username
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will perform the follow action
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
user_id:
type: integer
format: int64
description: Target user ID to follow
username:
type: string
description: Target username to follow
oneOf:
- required:
- user_id
- required:
- username
examples:
byUserId:
value:
user_id: 123456789
byUsername:
value:
username: elonmusk
responses:
'200':
description: User followed successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
user_id:
type: integer
format: int64
username:
type: string
'400':
description: Invalid request or follow action failed
'404':
description: Account not found
'500':
description: Failed to follow user
/accounts/{id}/unfollow:
post:
tags:
- Account Actions
summary: Unfollow a user
description: Unfollow a Twitter user by user ID or username
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will perform the unfollow action
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
user_id:
type: integer
format: int64
description: Target user ID to unfollow
username:
type: string
description: Target username to unfollow
oneOf:
- required:
- user_id
- required:
- username
examples:
byUserId:
value:
user_id: 123456789
byUsername:
value:
username: elonmusk
responses:
'200':
description: User unfollowed successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
user_id:
type: integer
format: int64
username:
type: string
'400':
description: Invalid request or unfollow action failed
'404':
description: Account not found
'500':
description: Failed to unfollow user
/accounts/{id}/like:
post:
tags:
- Account Actions
summary: Like a tweet
description: Like a tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will like the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to like (as integer or string)
tweet_url:
type: string
description: Tweet URL to like
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'200':
description: Tweet liked successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or like action failed
'404':
description: Account not found
'500':
description: Failed to like tweet
/accounts/{id}/unlike:
post:
tags:
- Account Actions
summary: Unlike a tweet
description: Remove like from a tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will unlike the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to unlike (as integer or string)
tweet_url:
type: string
description: Tweet URL to unlike
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'200':
description: Tweet unliked successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or unlike action failed
'404':
description: Account not found
'500':
description: Failed to unlike tweet
/accounts/{id}/bookmark:
post:
tags:
- Account Actions
summary: Bookmark a tweet
description: Bookmark a tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will bookmark the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to bookmark (as integer or string)
tweet_url:
type: string
description: Tweet URL to bookmark
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'200':
description: Tweet bookmarked successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or bookmark action failed
'404':
description: Account not found
'500':
description: Failed to bookmark tweet
/accounts/{id}/tweet:
post:
tags:
- Account Actions
summary: Create a tweet
description: Post a new tweet with text content, optional media, and optional community
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will post the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
description: Tweet text content
minLength: 1
media:
type: array
description: Array of base64-encoded media (images/videos) to attach to the tweet (optional)
items:
type: object
required:
- data
properties:
data:
type: string
description: Base64-encoded media content
type:
type: string
description: 'MIME type of the media (optional).
If not provided, will be auto-detected from binary data using magic bytes.
Supported types: image/jpeg, image/png, image/gif, video/mp4
'
enum:
- image/jpeg
- image/png
- image/gif
- video/mp4
community_id:
type: string
description: Community ID to post tweet in (optional)
example: '1234567890123456789'
examples:
simple:
summary: Simple text tweet
value:
text: Hello World! This is my first tweet.
withImage:
summary: Tweet with image
value:
text: Check out this photo!
media:
- data: /9j/4AAQSkZJRgABAQEAYABgAAD...
type: image/jpeg
withVideo:
summary: Tweet with video
value:
text: Watch this video!
media:
- data: AAAAIGZ0eXBpc29tAAACAGlzb21...
type: video/mp4
withMultipleMedia:
summary: Tweet with multiple images
value:
text: Multiple photos!
media:
- data: /9j/4AAQSkZJRgABAQEAYABgAAD...
type: image/jpeg
- data: iVBORw0KGgoAAAANSUhEUgAAAAUA...
type: image/png
withCommunity:
summary: Tweet in community
value:
text: Sharing in our community!
community_id: '1234567890123456789'
full:
summary: Tweet with media and community
value:
text: Full featured tweet!
media:
- data: /9j/4AAQSkZJRgABAQEAYABgAAD...
type: image/jpeg
community_id: '1234567890123456789'
responses:
'201':
description: Tweet created successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
text:
type: string
media_count:
type: integer
description: Number of media items uploaded (if any)
community_id:
type: string
description: Community ID (if posted to community)
'400':
description: Invalid request or tweet creation failed
'404':
description: Account not found
'500':
description: Failed to create tweet
delete:
tags:
- Account Actions
summary: Delete a tweet
description: Delete a tweet owned by this account by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that owns the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to delete (as integer or string)
tweet_url:
type: string
description: Tweet URL to delete
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/username/status/1234567890123456789
responses:
'200':
description: Tweet deleted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or delete action failed
'404':
description: Account not found
'500':
description: Failed to delete tweet
/accounts/{id}/pin:
post:
tags:
- Account Actions
summary: Pin a tweet
description: Pin a tweet to your profile by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that owns the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to pin (as integer or string)
tweet_url:
type: string
description: Tweet URL to pin
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/username/status/1234567890123456789
responses:
'200':
description: Tweet pinned successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or pin action failed
'404':
description: Account not found
'500':
description: Failed to pin tweet
delete:
tags:
- Account Actions
summary: Unpin a tweet
description: Unpin the pinned tweet from your profile
parameters:
- name: id
in: path
required: true
description: Twitter account ID that owns the tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to unpin (as integer or string)
tweet_url:
type: string
description: Tweet URL to unpin
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/username/status/1234567890123456789
responses:
'200':
description: Tweet unpinned successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or unpin action failed
'404':
description: Account not found
'500':
description: Failed to unpin tweet
/accounts/{id}/retweet:
post:
tags:
- Account Actions
summary: Retweet a tweet
description: Retweet a tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will retweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to retweet (as integer or string)
tweet_url:
type: string
description: Tweet URL to retweet
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'201':
description: Tweet retweeted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or retweet action failed
'404':
description: Account not found
'500':
description: Failed to retweet
/accounts/{id}/unretweet:
post:
tags:
- Account Actions
summary: Remove a retweet
description: Remove a retweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will remove the retweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to unretweet (as integer or string)
tweet_url:
type: string
description: Tweet URL to unretweet
oneOf:
- required:
- tweet_id
- required:
- tweet_url
examples:
byTweetId:
value:
tweet_id: 1234567890123456789
byTweetUrl:
value:
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'200':
description: Retweet removed successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
'400':
description: Invalid request or unretweet action failed
'404':
description: Account not found
/accounts/{id}/report:
post:
tags:
- Account Actions
summary: Report a user
description: Report a Twitter user by user ID
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will perform the report action
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- user_id
properties:
user_id:
type: integer
format: int64
description: Target user ID to report
examples:
byUserId:
value:
user_id: 123456789
responses:
'200':
description: User reported successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
user_id:
type: integer
format: int64
'400':
description: Invalid request or report action failed
'404':
description: Account not found
'500':
description: Failed to report user
/accounts/{id}/reply:
post:
tags:
- Account Actions
summary: Reply to a tweet
description: Post a reply to a tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will post the reply
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
description: Reply text content
minLength: 1
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to reply to (as integer or string)
tweet_url:
type: string
description: Tweet URL to reply to
oneOf:
- required:
- text
- tweet_id
- required:
- text
- tweet_url
examples:
byTweetId:
value:
text: Great tweet! Thanks for sharing.
tweet_id: 1234567890123456789
byTweetUrl:
value:
text: Interesting perspective!
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'201':
description: Reply posted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
text:
type: string
'400':
description: Invalid request or reply action failed
'404':
description: Account not found
'500':
description: Failed to post reply
/accounts/{id}/quote:
post:
tags:
- Account Actions
summary: Quote tweet
description: Post a quote tweet by tweet ID or tweet URL
parameters:
- name: id
in: path
required: true
description: Twitter account ID that will post the quote tweet
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
description: Quote tweet text content
minLength: 1
tweet_id:
oneOf:
- type: integer
format: int64
- type: string
description: Tweet ID to quote (as integer or string)
tweet_username:
type: string
description: Username of the tweet author (Required if using tweet_id)
tweet_url:
type: string
description: Tweet URL to quote
oneOf:
- required:
- text
- tweet_id
- tweet_username
- required:
- text
- tweet_url
examples:
byTweetId:
value:
text: Adding my thoughts on this...
tweet_id: 1234567890123456789
tweet_username: elonmusk
byTweetUrl:
value:
text: This is important!
tweet_url: https://x.com/elonmusk/status/1234567890123456789
responses:
'201':
description: Quote tweet posted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
tweet_id:
type: string
text:
type: string
'400':
description: Invalid request or quote tweet action failed
'404':
description: Account not found
'500':
description: Failed to post quote tweet
/accounts/{id}/change-password:
post:
tags:
- Account Actions
summary: Change account password
description: 'Changes the password for a Twitter account.
**Password Source:**
- If `current_password` is provided in request, it will be used
- If not provided, the password stored in the account database will be used
- If neither is available, returns a 400 error
'
parameters:
- name: id
in: path
required: true
description: Twitter account ID
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- new_password
properties:
new_password:
type: string
description: New password to set for the account
minLength: 1
current_password:
type: string
description: Current password (optional if stored in database)
examples:
withCurrentPassword:
summary: Change password with current password provided
value:
current_password: oldPassword123
new_password: newSecurePassword456
withoutCurrentPassword:
summary: Change password using stored password
value:
new_password: newSecurePassword456
responses:
'200':
description: Password changed successfully
content:
application/json:
schema:
type: object
properties: