-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathopenapi.json
More file actions
15489 lines (15489 loc) · 470 KB
/
openapi.json
File metadata and controls
15489 lines (15489 loc) · 470 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": "Recoup API",
"description": "API documentation for the Recoup platform - an AI agent platform for the music industry",
"license": {
"name": "MIT"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://recoup-api.vercel.app"
}
],
"security": [
{
"apiKeyAuth": []
}
],
"paths": {
"/api/tasks": {
"get": {
"description": "Retrieve scheduled tasks. The response includes recent_runs (last 5 runs) and upcoming (next scheduled run times) sourced directly from the Trigger.dev API. Supports filtering by id, account_id, or artist_account_id.",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Filter by task ID (UUID). Returns a single task matching the provided ID.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "account_id",
"in": "query",
"description": "Filter tasks to only include those for the specified account.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "artist_account_id",
"in": "query",
"description": "Filter tasks to only include those for the specified artist account.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Tasks retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"description": "Create a new scheduled task. All fields are required. The response shape matches the GET endpoint (an array containing the created task).",
"requestBody": {
"description": "Task to create",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "Task created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"patch": {
"description": "Update an existing scheduled task. Only the id field is required; any additional fields you include will be updated on the task. The response shape matches the GET endpoint (an array containing the updated task).",
"requestBody": {
"description": "Task fields to update",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "Task updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"delete": {
"description": "Delete an existing scheduled task by its ID. Returns the status of the delete operation.",
"requestBody": {
"description": "Task to delete",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "Task deleted successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaskResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/api/tasks/runs": {
"get": {
"description": "Returns an array of task runs. When runId is provided, the array contains that single run. When omitted, returns recent runs for the authenticated account. Use account_id to query runs for a specific account within your organizations.",
"parameters": [
{
"name": "runId",
"in": "query",
"description": "The unique identifier of a specific task run to retrieve. If omitted, returns a list of recent runs for the authenticated account.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of runs to return when listing (ignored when runId is provided). Default 20, max 100.",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"minimum": 1,
"maximum": 100
}
},
{
"name": "account_id",
"in": "query",
"description": "Filter runs by account ID. When provided, returns runs tagged with account:<account_id>. Only applicable when the authenticated account has access to multiple accounts via organization membership.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Task runs retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRunListResponse"
}
}
}
},
"400": {
"description": "Bad request - invalid parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Forbidden - account_id is not accessible with the provided credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Task run not found (only when runId is provided)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/api/accounts/{id}": {
"get": {
"description": "Retrieve detailed account information by ID. Returns the account with associated profile info, emails, and wallet addresses.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier (UUID) of the account",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Account retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountResponse"
}
}
}
},
"404": {
"description": "Account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}
},
"/api/accounts/id": {
"get": {
"description": "Retrieve the ID of the authenticated account associated with the provided credentials. This is useful when you have an API key or access token but do not yet know the corresponding accountId.",
"parameters": [],
"security": [
{
"apiKeyAuth": []
},
{
"bearerAuth": []
}
],
"responses": {
"200": {
"description": "Account ID retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountIdResponse"
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}
},
"/api/accounts": {
"post": {
"description": "Create a new account or retrieve an existing account by email or wallet address. If an account with the provided email or wallet already exists, returns that account. Otherwise creates a new account and initializes credits.",
"requestBody": {
"description": "Account credentials to create or lookup",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountRequest"
}
}
}
},
"responses": {
"200": {
"description": "Account created or retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountDataResponse"
}
}
}
},
"400": {
"description": "Bad request - failed to create account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
},
"patch": {
"description": "Update an existing account's profile information including name, organization, image, instruction, job title, role type, company name, and knowledges.",
"requestBody": {
"description": "Account fields to update",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountRequest"
}
}
}
},
"responses": {
"200": {
"description": "Account updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountDataResponse"
}
}
}
},
"400": {
"description": "Bad request - account not found or update failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}
},
"/api/accounts/artists": {
"post": {
"description": "Add an artist to an account's list of associated artists. If the artist is already associated with the account, returns success without modification.",
"requestBody": {
"description": "Account and artist identifiers",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddArtistToAccountRequest"
}
}
}
},
"responses": {
"200": {
"description": "Artist added to account successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddArtistSuccessResponse"
}
}
}
},
"400": {
"description": "Bad request - account not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}
},
"/api/artists": {
"get": {
"description": "Retrieve artists. Artists can have socials. Artists can create songs and content.",
"parameters": [
{
"name": "account_id",
"in": "query",
"description": "Filter to a specific account's artists. Only applicable when the authenticated account has access to multiple accounts via organization membership.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "org_id",
"in": "query",
"description": "Filter to artists in a specific organization. When omitted, returns only personal (non-organization) artists.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Artists retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistsResponse"
}
}
}
},
"400": {
"description": "Bad request - invalid parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid authentication"
},
"403": {
"description": "Forbidden - account_id is not accessible with the provided credentials"
}
}
},
"post": {
"description": "Create a new artist account. The artist can optionally be linked to an organization.",
"requestBody": {
"description": "Artist creation parameters",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateArtistRequest"
}
}
}
},
"responses": {
"201": {
"description": "Artist created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateArtistResponse"
}
}
}
},
"400": {
"description": "Bad request - validation error or invalid JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateArtistError"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/api/artist/segments": {
"get": {
"description": "Retrieve all segments associated with an artist. This endpoint should be called before using the Segment Fans endpoint to obtain the necessary segment IDs. Supports pagination.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch segments for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Segments retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsErrorResponse"
}
}
}
}
}
}
},
"/api/artist/socials": {
"get": {
"description": "Retrieve all social media profiles associated with an artist. This endpoint should be called before using the Social Posts endpoint to obtain the necessary social IDs.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch social profiles for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Social profiles retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSocialsResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSocialsErrorResponse"
}
}
}
}
}
}
},
"/api/artist/socials/scrape": {
"post": {
"description": "Trigger scrape jobs for all social profiles linked to an artist. Provide an artist_account_id, and the API will look up the artist's socials and invoke a scraping job for each social profile. Each scrape returns Apify run metadata so you can poll for status and retrieve results.",
"requestBody": {
"description": "Artist to scrape socials for",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSocialsScrapeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Scrape jobs triggered successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSocialsScrapeResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSocialsErrorResponse"
}
}
}
}
}
}
},
"/api/artist-profile": {
"get": {
"description": "Retrieve comprehensive profile information for an artist across all connected social media platforms, including profile details and post metrics.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch profile data for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Artist profile retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistProfileResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistProfileErrorResponse"
}
}
}
}
}
}
},
"/api/segment/fans": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve all social profiles from fans within a specific segment. This endpoint should be called after obtaining segment IDs from the Artist Segments endpoint. Supports pagination for large fan lists.",
"parameters": [
{
"name": "segment_id",
"in": "query",
"description": "The unique identifier of the segment to fetch fans for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Segment fans retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentFansResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentFansErrorResponse"
}
}
}
}
}
}
},
"/api/fans": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve all social profiles from fans of an artist across all platforms. This endpoint aggregates fan data from all connected social media platforms. Supports pagination for large fan lists.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch fans for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Artist fans retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistFansResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistFansErrorResponse"
}
}
}
}
}
}
},
"/api/posts": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve all social media posts from an artist across all platforms. This endpoint aggregates posts from all connected social media profiles for the specified artist. Supports pagination for large post collections.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch posts for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Artist posts retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistPostsResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistPostsErrorResponse"
}
}
}
}
}
}
},
"/api/comments": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve comments associated with an artist or a specific post, with support for pagination. This endpoint returns raw comment data including the comment text, associated post, and commenter's social profile reference.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch comments for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "post_id",
"in": "query",
"description": "Filter comments by specific post",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for pagination (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "Number of comments per page (default: 10)",
"required": false,
"schema": {
"type": "integer",
"default": 10
}
}
],
"responses": {
"200": {
"description": "Comments retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentsResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentsErrorResponse"
}
}
}
}
}
}