Repository navigation
Expand file tree
/
Copy paththreads.yaml
More file actions
1701 lines (1653 loc) · 49.8 KB
/
Copy paththreads.yaml
File metadata and controls
1701 lines (1653 loc) · 49.8 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: Meta Threads API
description: |
The Meta Threads API allows developers to manage Threads profiles, publish content,
and retrieve insights. This API enables businesses and creators to:
- **Publishing**: Create and publish text posts, media posts, and carousel posts
- **Media Management**: Upload and manage images and videos
- **Profile Management**: Access user profile information and settings
- **Content Retrieval**: Get user threads and media objects
- **Analytics & Insights**: Retrieve post performance metrics
- **Replies**: Manage replies and conversations
**Base URL:** https://graph.threads.net
**Rate Limiting:** 250 API-published posts within a 24-hour moving period per Threads profile.
**Authentication:** OAuth 2.0 with Facebook/Meta authentication system
version: "1.0"
contact:
name: Meta for Developers
url: https://developers.facebook.com/docs/threads
license:
name: Meta API Terms
url: https://developers.facebook.com/terms
servers:
- url: https://graph.threads.net
description: Threads Graph API
paths:
# Publishing Endpoints
/v1.0/me/threads:
post:
tags: [Publishing]
summary: Create thread
operationId: createThread
description: |
Create a new thread (post) on Threads. Supports text posts, single media posts,
and carousel posts with multiple images.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateThreadRequest'
examples:
text_post:
summary: Text-only post
value:
media_type: "TEXT"
text: "Hello from the Threads API! 🧵"
single_image:
summary: Single image post
value:
media_type: "IMAGE"
image_url: "https://example.com/image.jpg"
text: "Check out this image!"
single_video:
summary: Single video post
value:
media_type: "VIDEO"
video_url: "https://example.com/video.mp4"
text: "Watch this video!"
carousel_post:
summary: Carousel with multiple images
value:
media_type: "CAROUSEL"
children:
- media_type: "IMAGE"
image_url: "https://example.com/img1.jpg"
- media_type: "IMAGE"
image_url: "https://example.com/img2.jpg"
- media_type: "IMAGE"
image_url: "https://example.com/img3.jpg"
text: "Swipe through these images! 📸"
responses:
'200':
description: Thread created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Thread creation ID
example: "17841234567890123"
'400':
description: Bad request - invalid parameters
'401':
description: Unauthorized - invalid access token
'429':
description: Rate limit exceeded
security:
- AccessToken: [threads_basic, threads_content_publish]
# User Threads
get:
tags: [Content Management]
summary: Get user threads
operationId: getUserThreads
description: Retrieve threads (posts) published by the authenticated user
parameters:
- name: fields
in: query
description: Comma-separated list of fields to retrieve
schema:
type: string
default: "id,media_type,media_url,permalink,owner,username,text,timestamp,shortcode,thumbnail_url,children,is_quote_post"
example: "id,media_type,text,timestamp,permalink"
- name: limit
in: query
description: Number of threads to retrieve (max 25)
schema:
type: integer
default: 25
maximum: 25
- name: since
in: query
description: Unix timestamp - return threads created after this time
schema:
type: integer
- name: until
in: query
description: Unix timestamp - return threads created before this time
schema:
type: integer
- name: before
in: query
description: Cursor for pagination
schema:
type: string
- name: after
in: query
description: Cursor for pagination
schema:
type: string
responses:
'200':
description: Threads retrieved successfully
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Thread'
paging:
$ref: '#/components/schemas/Paging'
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic]
# Publishing - Publish Thread
/v1.0/{thread-id}/publish:
post:
tags: [Publishing]
summary: Publish thread
operationId: publishThread
description: |
Publish a previously created thread. This is a two-step process:
1. Create the thread using `/me/threads`
2. Publish it using this endpoint
parameters:
- name: thread-id
in: path
required: true
description: Thread creation ID returned from the create thread endpoint
schema:
type: string
example: "17841234567890123"
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
creation_id:
type: string
description: Thread creation ID
example: "17841234567890123"
required: [creation_id]
responses:
'200':
description: Thread published successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Published thread media ID
example: "18027947643429398"
'400':
description: Bad request
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic, threads_content_publish]
# User Profile
/v1.0/me:
get:
tags: [Profile]
summary: Get user profile
operationId: getUserProfile
description: Retrieve the authenticated user's Threads profile information
parameters:
- name: fields
in: query
description: Comma-separated list of fields to retrieve
schema:
type: string
default: "id,username,threads_profile_picture_url,threads_biography"
example: "id,username,threads_profile_picture_url,threads_biography"
responses:
'200':
description: Profile retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
example:
id: "123456789"
username: "example_user"
threads_profile_picture_url: "https://scontent.cdninstagram.com/profile.jpg"
threads_biography: "This is my Threads bio!"
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic]
# Thread Details
/v1.0/{thread-id}:
get:
tags: [Content Management]
summary: Get thread details
operationId: getThreadDetails
description: Retrieve details of a specific thread by ID
parameters:
- name: thread-id
in: path
required: true
description: Thread media ID
schema:
type: string
example: "18027947643429398"
- name: fields
in: query
description: Comma-separated list of fields to retrieve
schema:
type: string
default: "id,media_type,media_url,permalink,owner,username,text,timestamp,shortcode,thumbnail_url,children,is_quote_post"
responses:
'200':
description: Thread details retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Thread'
'404':
description: Thread not found
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic]
delete:
tags: [Content Management]
summary: Delete thread
operationId: deleteThread
description: Delete a thread created by the authenticated user
parameters:
- name: thread-id
in: path
required: true
description: Thread media ID
schema:
type: string
responses:
'200':
description: Thread deleted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'404':
description: Thread not found
'401':
description: Unauthorized
'403':
description: Forbidden - cannot delete another user's thread
security:
- AccessToken: [threads_basic, threads_content_publish]
# Thread Insights
/v1.0/{thread-id}/insights:
get:
tags: [Analytics]
summary: Get thread insights
operationId: getThreadInsights
description: Retrieve analytics and performance metrics for a specific thread
parameters:
- name: thread-id
in: path
required: true
description: Thread media ID
schema:
type: string
example: "18027947643429398"
- name: metric
in: query
required: true
description: Comma-separated list of metrics to retrieve
schema:
type: string
enum:
- views
- likes
- replies
- reposts
- quotes
- follows
- profile_visits
- profile_activity
example: "views,likes,replies,reposts,quotes"
- name: since
in: query
description: Unix timestamp - lower bound of date range
schema:
type: integer
- name: until
in: query
description: Unix timestamp - upper bound of date range
schema:
type: integer
- name: period
in: query
description: Time period for insights aggregation
schema:
type: string
enum: [day, week, days_28, month, lifetime]
default: lifetime
responses:
'200':
description: Thread insights retrieved successfully
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ThreadInsight'
example:
data:
- name: "views"
period: "lifetime"
values:
- value: 1234
end_time: "2026-02-02T15:00:00+0000"
- name: "likes"
period: "lifetime"
values:
- value: 45
end_time: "2026-02-02T15:00:00+0000"
'404':
description: Thread not found
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic, threads_manage_insights]
# User Insights
/v1.0/me/threads_insights:
get:
tags: [Analytics]
summary: Get user insights
operationId: getUserInsights
description: Retrieve analytics for the authenticated user's account
parameters:
- name: metric
in: query
required: true
description: Comma-separated list of metrics to retrieve
schema:
type: string
enum:
- views
- likes
- replies
- reposts
- quotes
- follows
- follower_count
- follower_demographic
example: "views,likes,follows,follower_count"
- name: since
in: query
description: Unix timestamp - lower bound of date range
schema:
type: integer
- name: until
in: query
description: Unix timestamp - upper bound of date range
schema:
type: integer
- name: period
in: query
description: Time period for insights aggregation
schema:
type: string
enum: [day, week, days_28, month, lifetime]
default: lifetime
responses:
'200':
description: User insights retrieved successfully
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/UserInsight'
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic, threads_manage_insights]
# Replies Management
/v1.0/{thread-id}/replies:
get:
tags: [Replies]
summary: Get thread replies
operationId: getThreadReplies
description: Retrieve replies to a specific thread
parameters:
- name: thread-id
in: path
required: true
description: Thread media ID
schema:
type: string
- name: fields
in: query
description: Comma-separated list of fields to retrieve
schema:
type: string
default: "id,text,username,timestamp,like_count,reply_count"
- name: limit
in: query
description: Number of replies to retrieve
schema:
type: integer
default: 25
maximum: 25
responses:
'200':
description: Replies retrieved successfully
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Reply'
paging:
$ref: '#/components/schemas/Paging'
'404':
description: Thread not found
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic]
post:
tags: [Replies]
summary: Create reply
operationId: createReply
description: Reply to a specific thread
parameters:
- name: thread-id
in: path
required: true
description: Thread media ID to reply to
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
text:
type: string
description: Reply text content
maxLength: 500
example: "Great post! Thanks for sharing."
media_type:
type: string
enum: [TEXT, IMAGE, VIDEO]
default: TEXT
description: Type of reply media
image_url:
type: string
format: uri
description: Image URL (if media_type is IMAGE)
video_url:
type: string
format: uri
description: Video URL (if media_type is VIDEO)
required: [text]
responses:
'200':
description: Reply created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Reply ID
'400':
description: Bad request
'401':
description: Unauthorized
'429':
description: Rate limit exceeded
security:
- AccessToken: [threads_basic, threads_content_publish]
# Manage Replies
/v1.0/{reply-id}:
delete:
tags: [Replies]
summary: Delete reply
operationId: deleteReply
description: Delete a reply created by the authenticated user
parameters:
- name: reply-id
in: path
required: true
description: Reply ID
schema:
type: string
responses:
'200':
description: Reply deleted successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'404':
description: Reply not found
'401':
description: Unauthorized
'403':
description: Forbidden - cannot delete another user's reply
security:
- AccessToken: [threads_basic, threads_content_publish]
# Media Upload
/v1.0/me/media:
post:
tags: [Media]
summary: Upload media
operationId: uploadMedia
description: Upload an image or video to use in threads
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: Media file to upload
media_type:
type: string
enum: [IMAGE, VIDEO]
description: Type of media being uploaded
caption:
type: string
description: Optional caption for the media
maxLength: 2200
required: [file, media_type]
responses:
'200':
description: Media uploaded successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Media ID that can be used in thread creation
status:
type: string
enum: [FINISHED, IN_PROGRESS, ERROR]
description: Upload processing status
'400':
description: Bad request - invalid file or parameters
'401':
description: Unauthorized
'413':
description: File too large
'429':
description: Rate limit exceeded
security:
- AccessToken: [threads_basic, threads_content_publish]
# Media Status
/v1.0/{media-id}:
get:
tags: [Media]
summary: Get media status
operationId: getMediaStatus
description: Check the processing status of uploaded media
parameters:
- name: media-id
in: path
required: true
description: Media ID from upload response
schema:
type: string
- name: fields
in: query
description: Comma-separated list of fields to retrieve
schema:
type: string
default: "id,status"
responses:
'200':
description: Media status retrieved successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Media ID
status:
type: string
enum: [FINISHED, IN_PROGRESS, ERROR]
description: Processing status
status_code:
type: string
description: Detailed status code
'404':
description: Media not found
'401':
description: Unauthorized
security:
- AccessToken: [threads_basic]
# User Management
/v1.0/me/accounts:
get:
tags: [User Management]
summary: Get user accounts
operationId: getUserAccounts
description: Get all Instagram Business accounts connected to the user
responses:
'200':
description: Connected accounts
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
username:
type: string
followers_count:
type: integer
security:
- AccessToken: [threads_basic]
# Content Management
/v1.0/me/threads/bulk_publish:
post:
tags: [Publishing]
summary: Bulk publish threads
operationId: bulkPublishThreads
description: Publish multiple threads in a batch operation
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
batch:
type: array
items:
$ref: '#/components/schemas/CreateThreadRequest'
maxItems: 20
description: Array of thread creation requests (max 20)
required: [batch]
responses:
'200':
description: Batch publish results
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
status:
type: string
enum: [SUCCESS, ERROR]
error:
type: object
nullable: true
security:
- AccessToken: [threads_basic, threads_content_publish]
# Thread Management
/v1.0/{thread-id}/hide:
post:
tags: [Content Management]
summary: Hide thread
operationId: hideThread
description: Hide a thread from the user's profile
parameters:
- name: thread-id
in: path
required: true
schema:
type: string
description: Thread ID
responses:
'200':
description: Thread hidden successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
security:
- AccessToken: [threads_basic, threads_content_publish]
/v1.0/{thread-id}/unhide:
post:
tags: [Content Management]
summary: Unhide thread
operationId: unhideThread
description: Unhide a previously hidden thread
parameters:
- name: thread-id
in: path
required: true
schema:
type: string
description: Thread ID
responses:
'200':
description: Thread unhidden successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
security:
- AccessToken: [threads_basic, threads_content_publish]
# Conversation Management
/v1.0/{thread-id}/conversation:
get:
tags: [Conversations]
summary: Get conversation thread
operationId: getConversationThread
description: Get the full conversation thread including all replies
parameters:
- name: thread-id
in: path
required: true
schema:
type: string
description: Thread ID
- name: fields
in: query
schema:
type: string
default: "id,text,username,timestamp,reply_count,like_count"
description: Comma-separated list of fields to return
responses:
'200':
description: Conversation thread
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ThreadResponse'
security:
- AccessToken: [threads_basic]
# Media Container Management
/v1.0/me/media_containers:
get:
tags: [Media Management]
summary: Get media containers
operationId: getMediaContainers
description: Get all media containers created by the user
parameters:
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 25
description: Number of containers to return
- name: before
in: query
schema:
type: string
description: Cursor for pagination
- name: after
in: query
schema:
type: string
description: Cursor for pagination
responses:
'200':
description: Media containers
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
status:
type: string
created_time:
type: string
format: date-time
paging:
$ref: '#/components/schemas/Paging'
security:
- AccessToken: [threads_basic]
# Advanced Insights
/v1.0/me/insights/demographic:
get:
tags: [Analytics]
summary: Get demographic insights
operationId: getDemographicInsights
description: Get demographic information about followers
parameters:
- name: metric
in: query
required: true
schema:
type: string
enum: [follower_demographics, audience_gender, audience_age, audience_country, audience_city]
description: Demographic metric to retrieve
- name: period
in: query
schema:
type: string
enum: [day, week, days_28, lifetime]
default: days_28
description: Time period for insights
- name: since
in: query
schema:
type: string
format: date
description: Start date (YYYY-MM-DD)
- name: until
in: query
schema:
type: string
format: date
description: End date (YYYY-MM-DD)
responses:
'200':
description: Demographic insights data
content:
application/json:
schema:
$ref: '#/components/schemas/InsightsResponse'
security:
- AccessToken: [threads_basic, threads_manage_insights]
/v1.0/me/insights/performance:
get:
tags: [Analytics]
summary: Get performance insights
operationId: getPerformanceInsights
description: Get detailed performance metrics for the account
parameters:
- name: metric
in: query
required: true
schema:
type: string
enum: [profile_views, follower_count, following_count, posts_count, engagement_rate, reach, impressions]
description: Performance metric to retrieve
- name: period
in: query
schema:
type: string
enum: [day, week, days_28]
default: week
description: Time period for insights
- name: since
in: query
schema:
type: string
format: date
description: Start date (YYYY-MM-DD)
- name: until
in: query
schema:
type: string
format: date
description: End date (YYYY-MM-DD)
responses:
'200':
description: Performance insights data
content:
application/json:
schema:
$ref: '#/components/schemas/InsightsResponse'
security:
- AccessToken: [threads_basic, threads_manage_insights]
# Content Discovery
/v1.0/me/threads/feed:
get:
tags: [Content Discovery]
summary: Get user feed
operationId: getUserFeed
description: Get threads from user's feed
parameters:
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 25
description: Number of threads to return
- name: before
in: query
schema: