-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
11261 lines (11127 loc) · 432 KB
/
openapi.yaml
File metadata and controls
11261 lines (11127 loc) · 432 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.1.0
info:
title: Late API
version: "1.0.1"
description: |
API reference for Late. Authenticate with a Bearer API key.
Base URL: https://getlate.dev/api
termsOfService: https://getlate.dev/tos
contact:
name: Late Support
url: https://getlate.dev
email: support@getlate.dev
# RapidAPI extensions for Hub listing
x-logo:
url: https://getlate.dev/icon.png?v=3
x-long-description: |
Late is the social media API that replaces 13 integrations. Schedule posts, retrieve analytics,
manage DMs, comments, and reviews across Twitter/X, Instagram, TikTok, LinkedIn, Facebook,
YouTube, Threads, Reddit, Pinterest, Bluesky, Telegram, Google Business, and Snapchat, all
from a single REST API.
Key features: Unified posting to 13 platforms, aggregated analytics, unified inbox (DMs, comments, reviews), webhooks, OAuth connect, queue scheduling, and white-label support for agencies managing 5,000+ accounts.
Supported platforms: Twitter/X, Instagram, Facebook, LinkedIn, TikTok, YouTube, Pinterest, Reddit, Bluesky, Threads, Google Business, Telegram, Snapchat.
x-category: Social
x-website: https://getlate.dev
x-thumbnail: https://rapidapi-prod-apis.s3.amazonaws.com/b24d3df5-563c-4a50-9e1e-1ad3eb1fce69.png
x-version-lifecycle: ACTIVE
x-badges:
- name: "social media"
value: "social media"
- name: "scheduling"
value: "scheduling"
- name: "instagram"
value: "instagram"
- name: "tiktok"
value: "tiktok"
- name: "twitter"
value: "twitter"
- name: "linkedin"
value: "linkedin"
- name: "facebook"
value: "facebook"
- name: "youtube"
value: "youtube"
- name: "social media api"
value: "social media api"
- name: "posting"
value: "posting"
# RapidAPI Hub documentation tab (README)
x-documentation:
readme: |
# Late API
The social media API that replaces 13 integrations. Build social media features into your app in minutes, not months.
## Quick Start
**Base URL:** `https://getlate.dev/api/v1`
**Authentication:** All requests require a Bearer API key in the `Authorization` header.
```bash
curl https://getlate.dev/api/v1/user \
-H "Authorization: Bearer YOUR_API_KEY"
```
Get your API key at [getlate.dev/dashboard/api-keys](https://getlate.dev/dashboard/api-keys).
## Core Concepts
| Concept | Description |
|---------|-------------|
| **Profiles** | Containers that organize social accounts into brands or projects |
| **Accounts** | Connected social media accounts belonging to a profile |
| **Posts** | Content scheduled or published to one or more accounts |
| **Queue** | Recurring time slots for automatic post scheduling |
## Create a Post
```bash
curl -X POST https://getlate.dev/api/v1/post \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"profileId": "your-profile-id",
"text": "Hello from Late API!",
"socialAccountIds": ["account-1", "account-2"],
"scheduledAt": "2025-01-15T10:00:00Z"
}'
```
This single call publishes or schedules the post to all selected accounts across any platform.
## Supported Platforms
| Platform | Post | Stories/Reels | Analytics | Inbox |
|----------|------|---------------|-----------|-------|
| Twitter/X | Yes | - | Yes | Yes |
| Instagram | Yes | Yes | Yes | Yes |
| Facebook | Yes | Stories | Yes | Yes |
| LinkedIn | Yes | - | Yes | - |
| TikTok | Yes | - | Yes | - |
| YouTube | Yes | Shorts | Yes | Yes |
| Pinterest | Yes | - | Yes | - |
| Reddit | Yes | - | - | Yes |
| Bluesky | Yes | - | - | Yes |
| Threads | Yes | - | Yes | Yes |
| Google Business | Yes | - | - | Yes |
| Telegram | Yes | - | - | - |
| Snapchat | Yes | - | - | - |
## Rate Limits
| Plan | Requests/min | Posts/month |
|------|-------------|-------------|
| Free | 60 | 20 |
| Build | 120 | 120 |
| Accelerate | 600 | Unlimited |
| Unlimited | 1,200 | Unlimited |
All responses include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
## Webhooks
Receive real-time notifications for post status changes, account events, and incoming messages:
- `post.scheduled` - Post successfully scheduled
- `post.published` - Post successfully published
- `post.failed` - Post failed on all platforms
- `post.partial` - Post published to some platforms, failed on others
- `post.recycled` - A new scheduled copy was created from a recycling post
- `account.connected` - Social account connected
- `account.disconnected` - Social account disconnected (token expired)
- `message.received` - New DM received
- `comment.received` - New comment received on a post
Webhook payloads are signed with HMAC-SHA256 via the `X-Late-Signature` header.
## Full Documentation
For complete guides, platform-specific details, and SDK references, visit [docs.getlate.dev](https://docs.getlate.dev).
## SDKs
Official SDKs available for: [Node.js](https://www.npmjs.com/package/late), [Python](https://pypi.org/project/late), Go, Ruby, Java, PHP, .NET, and Rust.
servers:
- url: https://getlate.dev/api
description: Production
- url: http://localhost:3000/api
description: Local
tags:
- name: Posts
- name: Users
- name: Usage
- name: Profiles
- name: Accounts
- name: Account Groups
- name: API Keys
- name: Invites
- name: Connect
- name: Media
# - name: Video Clips # AI Clipping feature temporarily disabled
- name: Reddit Search
- name: Facebook
- name: GMB Reviews
- name: GMB Food Menus
- name: GMB Location Details
- name: GMB Media
- name: GMB Attributes
- name: GMB Place Actions
- name: LinkedIn Mentions
- name: Pinterest
- name: TikTok
- name: Queue
- name: Analytics
- name: Inbox Access
description: |
Check and manage inbox feature access.
- name: Messages
description: |
Unified inbox API for managing conversations and direct messages across all connected accounts.
All endpoints aggregate data from multiple social accounts in a single API call.
Requires Inbox addon.
- name: Comments
description: |
Unified inbox API for managing comments on posts across all connected accounts.
Supports commenting on third-party posts for platforms that allow it (YouTube, Twitter, Reddit, Bluesky, Threads).
All endpoints aggregate data from multiple social accounts in a single API call.
Requires Inbox addon.
- name: Reviews
description: |
Unified inbox API for managing reviews on Facebook Pages and Google Business accounts.
All endpoints aggregate data from multiple social accounts in a single API call.
Requires Inbox addon.
- name: Tools
description: |
Media download and utility tools. Available to paid plans only.
Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).
All responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.
- name: Validate
description: |
Pre-flight validation endpoints. Check post content, character limits, media URLs, and subreddit existence before publishing.
- name: Account Settings
description: |
Platform-specific account settings: Facebook persistent menu, Instagram ice breakers, and Telegram bot commands.
- name: Webhooks
description: |
Configure webhooks for real-time notifications. Events: post.scheduled, post.published, post.failed, post.partial, post.recycled, account.connected, account.disconnected, message.received, comment.received.
Security: optional HMAC-SHA256 signature in X-Late-Signature header. Configure a secret key to enable verification. Custom headers supported.
- name: Logs
description: |
Publishing logs for transparency and debugging. Each log includes the platform API endpoint, HTTP status code, request/response bodies, duration, and retry attempts. Logs are automatically deleted after 7 days.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: API key authentication - use your Late API key as a Bearer token
connectToken:
type: apiKey
in: header
name: X-Connect-Token
description: |
Short-lived connect token for API users during OAuth flows.
Automatically generated when initiating OAuth without a browser session.
Valid for 15 minutes. Used to authenticate Facebook page selection API calls.
parameters:
PageParam:
name: page
in: query
description: Page number (1-based)
schema: { type: integer, minimum: 1, default: 1 }
LimitParam:
name: limit
in: query
description: Page size
schema: { type: integer, minimum: 1, maximum: 100, default: 10 }
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
NotFound:
description: Resource not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Not found
schemas:
ErrorResponse:
type: object
properties:
error:
type: string
details:
type: object
additionalProperties: true
FoodMenuLabel:
type: object
required: [displayName]
properties:
displayName: { type: string, description: Display name of the item/section/menu }
description: { type: string, description: Optional description }
languageCode: { type: string, description: "BCP-47 language code (e.g. en, es)" }
Money:
type: object
required: [currencyCode, units]
properties:
currencyCode: { type: string, description: "ISO 4217 currency code (e.g. USD, EUR)" }
units: { type: string, description: Whole units of the amount }
nanos: { type: integer, description: Nano units (10^-9) of the amount }
FoodMenuItemAttributes:
type: object
properties:
price: { $ref: '#/components/schemas/Money' }
spiciness: { type: string, description: "Spiciness level (e.g. MILD, MEDIUM, HOT)" }
allergen:
type: array
items: { type: string }
description: "Allergens (e.g. DAIRY, GLUTEN, SHELLFISH)"
dietaryRestriction:
type: array
items: { type: string }
description: "Dietary labels (e.g. VEGETARIAN, VEGAN, GLUTEN_FREE)"
servesNumPeople: { type: integer, description: Number of people the item serves }
preparationMethods:
type: array
items: { type: string }
description: "Preparation methods (e.g. GRILLED, FRIED)"
mediaKeys:
type: array
items: { type: string }
description: Media references for item photos
FoodMenuItem:
type: object
required: [labels]
properties:
labels:
type: array
items: { $ref: '#/components/schemas/FoodMenuLabel' }
attributes: { $ref: '#/components/schemas/FoodMenuItemAttributes' }
options:
type: array
items:
type: object
properties:
labels:
type: array
items: { $ref: '#/components/schemas/FoodMenuLabel' }
attributes: { $ref: '#/components/schemas/FoodMenuItemAttributes' }
description: Item variants/options (e.g. sizes, preparations)
FoodMenuSection:
type: object
required: [labels]
properties:
labels:
type: array
items: { $ref: '#/components/schemas/FoodMenuLabel' }
items:
type: array
items: { $ref: '#/components/schemas/FoodMenuItem' }
FoodMenu:
type: object
required: [labels]
properties:
labels:
type: array
items: { $ref: '#/components/schemas/FoodMenuLabel' }
sections:
type: array
items: { $ref: '#/components/schemas/FoodMenuSection' }
cuisines:
type: array
items: { type: string }
description: "Cuisine types (e.g. AMERICAN, ITALIAN, JAPANESE)"
sourceUrl:
type: string
description: URL of the original menu source
YouTubeDailyViewsResponse:
type: object
properties:
success:
type: boolean
example: true
videoId:
type: string
description: The YouTube video ID
dateRange:
type: object
properties:
startDate:
type: string
format: date
endDate:
type: string
format: date
totalViews:
type: integer
description: Sum of views across all days in the range
dailyViews:
type: array
items:
type: object
properties:
date:
type: string
format: date
views:
type: integer
estimatedMinutesWatched:
type: number
averageViewDuration:
type: number
description: Average view duration in seconds
subscribersGained:
type: integer
subscribersLost:
type: integer
likes:
type: integer
comments:
type: integer
shares:
type: integer
lastSyncedAt:
type: string
format: date-time
nullable: true
description: When the data was last synced from YouTube
scopeStatus:
type: object
properties:
hasAnalyticsScope:
type: boolean
YouTubeScopeMissingResponse:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: "To access daily video analytics, please reconnect your YouTube account to grant the required permissions."
code:
type: string
example: youtube_analytics_scope_missing
scopeStatus:
type: object
properties:
hasAnalyticsScope:
type: boolean
example: false
requiresReauthorization:
type: boolean
example: true
reauthorizeUrl:
type: string
format: uri
description: URL to redirect user for reauthorization
Webhook:
type: object
description: Individual webhook configuration for receiving real-time notifications
properties:
_id:
type: string
description: Unique webhook identifier
name:
type: string
description: Webhook name (for identification)
maxLength: 50
url:
type: string
format: uri
description: Webhook endpoint URL
secret:
type: string
description: Secret key for HMAC-SHA256 signature (not returned in responses for security)
events:
type: array
items:
type: string
enum: [post.scheduled, post.published, post.failed, post.partial, post.recycled, account.connected, account.disconnected, message.received, comment.received]
description: Events subscribed to
isActive:
type: boolean
description: Whether webhook delivery is enabled
lastFiredAt:
type: string
format: date-time
description: Timestamp of last successful webhook delivery
failureCount:
type: integer
description: Consecutive delivery failures (resets on success, webhook disabled at 10)
customHeaders:
type: object
additionalProperties:
type: string
description: Custom headers included in webhook requests
WebhookLog:
type: object
description: Webhook delivery log entry
properties:
_id:
type: string
webhookId:
type: string
description: ID of the webhook that was triggered
webhookName:
type: string
description: Name of the webhook that was triggered
event:
type: string
enum: [post.scheduled, post.published, post.failed, post.partial, post.recycled, account.connected, account.disconnected, message.received, comment.received, webhook.test]
url:
type: string
format: uri
status:
type: string
enum: [success, failed]
statusCode:
type: integer
description: HTTP status code from webhook endpoint
requestPayload:
type: object
description: Payload sent to webhook endpoint
responseBody:
type: string
description: Response body from webhook endpoint (truncated to 10KB)
errorMessage:
type: string
description: Error message if delivery failed
attemptNumber:
type: integer
description: Delivery attempt number (max 3 retries)
responseTime:
type: integer
description: Response time in milliseconds
createdAt:
type: string
format: date-time
WebhookPayloadPost:
type: object
description: Webhook payload for post events
properties:
event:
type: string
enum: [post.scheduled, post.published, post.failed, post.partial, post.recycled]
post:
type: object
properties:
id:
type: string
content:
type: string
status:
type: string
scheduledFor:
type: string
format: date-time
publishedAt:
type: string
format: date-time
platforms:
type: array
items:
type: object
properties:
platform:
type: string
status:
type: string
publishedUrl:
type: string
error:
type: string
timestamp:
type: string
format: date-time
WebhookPayloadAccountConnected:
type: object
description: Webhook payload for account connected events
properties:
event:
type: string
enum: [account.connected]
account:
type: object
properties:
accountId:
type: string
description: The account's unique identifier (same as used in /v1/accounts/{accountId})
profileId:
type: string
description: The profile's unique identifier this account belongs to
platform:
type: string
username:
type: string
displayName:
type: string
timestamp:
type: string
format: date-time
WebhookPayloadAccountDisconnected:
type: object
description: Webhook payload for account disconnected events
properties:
event:
type: string
enum: [account.disconnected]
account:
type: object
properties:
accountId:
type: string
description: The account's unique identifier (same as used in /v1/accounts/{accountId})
profileId:
type: string
description: The profile's unique identifier this account belongs to
platform:
type: string
username:
type: string
displayName:
type: string
disconnectionType:
type: string
enum: [intentional, unintentional]
description: Whether the disconnection was intentional (user action) or unintentional (token expired/revoked)
reason:
type: string
description: Human-readable reason for the disconnection
timestamp:
type: string
format: date-time
WebhookPayloadComment:
type: object
description: Webhook payload for comment received events (Instagram, Facebook, Twitter/X, YouTube, LinkedIn, Bluesky, Reddit)
properties:
event:
type: string
enum: [comment.received]
comment:
type: object
properties:
id:
type: string
description: Platform comment ID
postId:
type: string
description: Internal post ID
platformPostId:
type: string
description: Platform's post ID
platform:
type: string
enum: [instagram, facebook, twitter, youtube, linkedin, bluesky, reddit]
text:
type: string
description: Comment text content
author:
type: object
properties:
id:
type: string
description: Author's platform ID
username:
type: string
name:
type: string
picture:
type: string
nullable: true
createdAt:
type: string
format: date-time
isReply:
type: boolean
description: Whether this is a reply to another comment
parentCommentId:
type: string
nullable: true
description: Parent comment ID if this is a reply
post:
type: object
properties:
id:
type: string
description: Internal post ID
platformPostId:
type: string
description: Platform's post ID
account:
type: object
properties:
id:
type: string
description: Social account ID
platform:
type: string
username:
type: string
timestamp:
type: string
format: date-time
WebhookPayloadMessage:
type: object
description: Webhook payload for message received events (DMs from Instagram, Facebook, Telegram, Bluesky, Reddit)
properties:
event:
type: string
enum: [message.received]
message:
type: object
properties:
id:
type: string
description: Internal message ID
conversationId:
type: string
description: Internal conversation ID
platform:
type: string
enum: [instagram, facebook, telegram, bluesky, reddit]
platformMessageId:
type: string
description: Platform's message ID
direction:
type: string
enum: [incoming]
text:
type: string
nullable: true
description: Message text content
attachments:
type: array
items:
type: object
properties:
type:
type: string
description: Attachment type (image, video, file, sticker, audio)
url:
type: string
description: Attachment URL (may expire for Meta platforms)
payload:
type: object
description: Additional attachment metadata
sender:
type: object
properties:
id:
type: string
name:
type: string
username:
type: string
picture:
type: string
instagramProfile:
type: object
nullable: true
description: Instagram profile data for the sender. Only present for Instagram conversations.
properties:
isFollower:
type: boolean
nullable: true
description: Whether the sender follows your Instagram business account
isFollowing:
type: boolean
nullable: true
description: Whether your Instagram business account follows the sender
followerCount:
type: integer
nullable: true
description: The sender's follower count on Instagram
isVerified:
type: boolean
nullable: true
description: Whether the sender is a verified Instagram user
sentAt:
type: string
format: date-time
isRead:
type: boolean
conversation:
type: object
properties:
id:
type: string
platformConversationId:
type: string
participantId:
type: string
participantName:
type: string
participantUsername:
type: string
participantPicture:
type: string
status:
type: string
enum: [active, archived]
account:
type: object
properties:
id:
type: string
description: Social account ID
platform:
type: string
username:
type: string
displayName:
type: string
metadata:
type: object
nullable: true
description: Interactive message metadata (present when message is a quick reply tap, postback button tap, or inline keyboard callback)
properties:
quickReplyPayload:
type: string
description: Payload from a quick reply tap (Meta platforms)
postbackPayload:
type: string
description: Payload from a postback button tap (Meta platforms)
postbackTitle:
type: string
description: Title of the tapped postback button (Meta platforms)
callbackData:
type: string
description: Callback data from an inline keyboard button tap (Telegram)
timestamp:
type: string
format: date-time
PostLog:
type: object
description: Publishing log entry showing details of a post publishing attempt
properties:
_id:
type: string
postId:
oneOf:
- type: string
- type: object
description: Populated post reference
properties:
_id:
type: string
content:
type: string
status:
type: string
userId:
type: string
profileId:
type: string
platform:
type: string
enum: [tiktok, instagram, facebook, youtube, linkedin, twitter, threads, pinterest, reddit, bluesky, googlebusiness, telegram, snapchat]
accountId:
type: string
accountUsername:
type: string
action:
type: string
enum: [publish, retry, media_upload, rate_limit_pause, token_refresh, cancelled]
description: "Type of action logged: publish (initial attempt), retry (after failure), media_upload, rate_limit_pause, token_refresh, cancelled"
status:
type: string
enum: [success, failed, pending, skipped]
statusCode:
type: integer
description: HTTP status code from platform API
endpoint:
type: string
description: Platform API endpoint called
request:
type: object
properties:
contentPreview:
type: string
description: First 200 chars of caption
mediaCount:
type: integer
mediaTypes:
type: array
items:
type: string
mediaUrls:
type: array
items:
type: string
description: URLs of media items sent to platform
scheduledFor:
type: string
format: date-time
rawBody:
type: string
description: Full request body JSON (max 5000 chars)
response:
type: object
properties:
platformPostId:
type: string
description: ID returned by platform on success
platformPostUrl:
type: string
description: URL of published post
errorMessage:
type: string
description: Error message on failure
errorCode:
type: string
description: Platform-specific error code
rawBody:
type: string
description: Full response body JSON (max 5000 chars)
durationMs:
type: integer
description: How long the operation took in milliseconds
attemptNumber:
type: integer
description: Attempt number (1 for first try, 2+ for retries)
createdAt:
type: string
format: date-time
ConnectionLog:
type: object
description: Connection event log showing account connection/disconnection history
properties:
_id:
type: string
userId:
type: string
description: User who owns the connection (may be null for early OAuth failures)
profileId:
type: string
accountId:
type: string
description: The social account ID (present on successful connections and disconnects)
platform:
type: string
enum: [tiktok, instagram, facebook, youtube, linkedin, twitter, threads, pinterest, reddit, bluesky, googlebusiness, telegram, snapchat]
eventType:
type: string
enum: [connect_success, connect_failed, disconnect, reconnect_success, reconnect_failed]
description: "Type of connection event: connect_success, connect_failed, disconnect, reconnect_success, reconnect_failed"
connectionMethod:
type: string
enum: [oauth, credentials, invitation]
description: How the connection was initiated
error:
type: object
description: Error details (present on failed events)
properties:
code:
type: string
description: Error code (e.g., oauth_denied, token_exchange_failed)
message:
type: string
description: Human-readable error message
rawResponse:
type: string
description: Raw error response (truncated to 2000 chars)
success:
type: object
description: Success details (present on successful events)
properties:
displayName:
type: string
username:
type: string
profilePicture:
type: string
permissions:
type: array
items:
type: string
description: OAuth scopes/permissions granted
tokenExpiresAt:
type: string
format: date-time
accountType:
type: string
description: Account type (personal, business, organization)
context:
type: object
description: Additional context about the connection attempt
properties:
isHeadlessMode:
type: boolean
hasCustomRedirectUrl:
type: boolean
isReconnection:
type: boolean
isBYOK:
type: boolean
description: Using bring-your-own-keys
invitationToken:
type: string
connectToken:
type: string
durationMs:
type: integer
description: How long the operation took in milliseconds
metadata:
type: object
description: Additional metadata
createdAt:
type: string
format: date-time
MediaItem:
type: object
description: Media referenced in posts. URLs must be publicly reachable over HTTPS. Use POST /v1/media/presign for uploads up to 5GB. Late auto-compresses images and videos that exceed platform limits (videos over 200 MB may not be compressed).
properties:
type:
type: string
enum: [image, video, gif, document]
url:
type: string
format: uri
title:
type: string
description: Optional title for the media item. Used as the document title for LinkedIn PDF/carousel posts. If omitted, falls back to the post title, then the filename.
filename: