This repository has been archived by the owner on Jul 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
composio.yaml
1398 lines (1380 loc) · 59.5 KB
/
composio.yaml
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:
version: 1.0.0
title: Composio API Collection
summary: ''
description: Composio API OpenAPI Spec.
contact:
name: soham
url: composio.dev
email: hello@composio.dev
license:
url: 'https://composio.dev/terms-of-service'
name: Proprietary
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
paths:
/v1/apps:
get:
tags:
- apps
summary: List All Apps
description: |-
Retrieves a list of all available apps in the Composio platform.
This endpoint allows clients to explore and discover the supported apps. It returns an array of app objects, each containing essential details such as the app's key, name, description, logo, categories, and unique identifier.
Use this endpoint to build a catalog of available apps and provide your users with an overview of the apps they can integrate with.
operationId: list-all-apps
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
description: An array of app objects.
items:
type: object
properties:
key:
type: string
description: A unique identifier for the app.
name:
type: string
description: The name of the app.
description:
type: string
description: A brief description of the app's functionality.
logo:
type: string
description: The URL of the app's logo image.
categories:
type: array
description: An array of categories the app belongs to.
items:
type: string
appId:
type: string
description: The unique ID of the app.
examples:
List All Apps:
value:
items:
- key: asana
name: Asana
description: 'Tool to help teams organize, track, and manage their work.'
logo: 'https://assets.asana.biz/m/7342a96f034ee491/original/trademark-logo-lockup-horizontal.png'
categories:
- productivity
- ticketing
appId: 36a0705d-7e93-42ba-9288-436ee6201d7c
- key: calendly
name: Calendly
description: 'A business communication platform used for teams to schedule, prepare and follow up on external meetings.'
logo: 'https://upload.wikimedia.org/wikipedia/en/thumb/7/7f/Calendly_company_logo.png/330px-Calendly_company_logo.png'
categories:
- productivity
appId: fb9b4a59-8eda-4032-84d7-638e1df4ffef
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
/v1/connectedAccounts:
get:
tags:
- connectedAccounts
summary: List All Connected Accounts
description: |-
Retrieves a list of all connected accounts in the Composio platform.
It supports pagination and filtering based on various parameters such as app ID, integration ID, and connected ID. The response includes an array of connection objects, each containing details like the connector ID, connection parameters, status, creation/update timestamps, and associated app information.
Use this endpoint to manage and monitor all active connections.
operationId: list-all-connections
parameters:
- name: page
in: query
description: Page number to fetch
schema:
type: integer
examples:
- 1
examples:
default:
value: 1
- name: pageSize
in: query
description: Page size to assume
schema:
type: integer
examples:
- 10
examples:
default:
value: 10
- name: integrationId
in: query
description: Filter by using specific Integration
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
connectorId:
type: string
description: The unique identifier of the connector associated with the connection.
connectionParams:
type: object
description: An object containing the parameters specific to the connection.
properties:
base_url:
type: string
description: The base URL for making API requests to the connected app.
client_id:
type: string
description: The client ID used for authentication with the connected app.
client_secret:
type: string
description: The client secret used for authentication with the connected app.
owner:
description: 'The owner of the connection, which can be an object or a string.'
oneOf:
- type: object
properties:
type:
type: string
description: 'The type of the owner (e.g., "user").'
user:
type: object
description: An object representing the user owner of the connection.
properties:
id:
type: string
name:
type: string
type:
type: string
object:
type: string
description: 'The object type of the user (e.g., "user").'
person:
type: object
properties:
email:
type: string
avatar_url:
type: string
- type: string
bot_id:
type: string
description: The ID of the bot associated with the connection.
request_id:
type: string
description: The ID of the request associated with the connection.
token_type:
type: string
description: 'The type of token used for authentication (e.g., "bearer").'
access_token:
type: string
description: The access token used for authentication with the connected app.
workspace_id:
type: string
description: The ID of the workspace associated with the connection.
workspace_icon:
type: string
description: The URL of the workspace icon.
workspace_name:
type: string
description: The name of the workspace.
duplicated_template_id:
type: string
description: The ID of the duplicated template associated with the connection.
scope:
type: string
description: The scope of permissions granted to the connection
created_at:
type: integer
description: The timestamp indicating when the connection was created.
expires_in:
type: integer
description: |
The expiration time (in seconds) of the access token.
organization:
type: string
description: The organization associated with the connection.
refresh_token:
type: string
description: The refresh token used to obtain a new access token when it expires.
id:
type: string
description: The unique identifier of the connection.
status:
type: string
enum:
- FAILED
- INITIATED
- ACTIVE
description: 'The status of the connection (e.g., "INITIATED", "SUCCESS").'
createdAt:
type: string
description: The timestamp indicating when the connection was created.
updatedAt:
type: string
description: The timestamp indicating when the connection was last updated.
appName:
type: string
description: The name of the app associated with the connection.
logo:
type: string
description: The URL of the logo of the app associated with the connection.
totalPages:
type: integer
page:
type: integer
examples:
Get List of connections:
value:
items:
- connectorId: c9da705a-774c-46e8-9b55-cc0eb0d85508
connectionParams:
base_url: 'https://api.github.com'
client_id: 37beeaa7
client_secret: 8c6d25f889a4e74
id: 57fa7084-1188-4cbc-ae3b-e26c5bcccb7b
status: INITIATED
createdAt: '2024-03-11T07:41:34.827Z'
updatedAt: '2024-03-11T07:41:34.827Z'
appName: Github
logo: 'https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png'
- connectorId: 31a23bf7-8df4-4e76-9860-
connectionParams:
owner:
type: user
user:
id: 99b093ad-f0ff-42ef-be49-5c86a9ca9f52
name: Utkarsh
type: person
object: user
person:
email: utkarsh@composio.dev
avatar_url: s
bot_id: 95e803ea-6677-4fd5-a881-9216e0ba8299
base_url: 'https://api.notion.app'
client_id: 85b2ddba
request_id: a2b510af-acaf-4194-b1ff-ca0403d939e1
token_type: bearer
access_token: secret_H3AAr9E8rR8tA
workspace_id: 35adec70-dbef-4f42-9
client_secret: secret_K05OAKiG3MMe
workspace_icon: 'null'
workspace_name: Composio
duplicated_template_id: 'null'
id: 25613ab6-fb84-456d-bd14-8a748f2cf267
status: ACTIVE
createdAt: '2024-03-11T11:41:32.216Z'
updatedAt: '2024-03-11T11:43:31.855Z'
appName: Notion
logo: 'https://i.imgur.com/98qPYXd.png'
- connectorId: 31a23bf7-8df4-4e76-9860-143a7e3834a2
connectionParams:
base_url: 'https://api.notion.app'
client_id: 85b2ddba-74a4-4aab-8b35-d
client_secret: secret_K05OAKiG3Msyn2SChpm5
id: 27dd1aa9-3267-48e0-8b65-a65c1699589a
status: INITIATED
createdAt: '2024-03-09T13:11:25.166Z'
updatedAt: '2024-03-09T13:11:25.166Z'
appName: Notion
logo: 'https://i.imgur.com/98qPYXd.png'
- connectorId: 31a23bf7-8df4-4e76-
connectionParams:
owner:
type: user
user:
id: 99b093ad-f0ff-42ef-b
name: Utkarsh
type: person
object: user
person:
email: utkarsh@composio.dev
avatar_url: 'null'
bot_id: 95e803ea-6677-4fd5-a881
base_url: 'https://api.notion.app'
client_id: 85b2ddba-74a4-4a
request_id: a9979398-e15a-4d640-5162c9a3385b
token_type: bearer
access_token: secret_H3AAHjY96LPppWhyN4
workspace_id: 35adec70-dbef-9214-62ac8cdc4d75
client_secret: secret_G3MMecFqZVZ8syn2S
workspace_icon: 'null'
workspace_name: Composio
duplicated_template_id: 'null'
id: 6be44ecc-6a27-4675-a813-becf10465702
status: ACTIVE
createdAt: '2024-03-11T11:52:21.585Z'
updatedAt: '2024-03-11T11:52:27.463Z'
appName: Notion
logo: 'https://i.imgur.com/98qPYXd.png'
- connectorId: 31a23bf7-8df4-4e76-9860-
connectionParams:
base_url: 'https://api.notion.app'
client_id: 85b2ddba-74a4-4aab-8b35-
client_secret: secret_K05OAKiG3MMecFqZVZ8
id: 9b81f3c9-54b0-4e45-a6a2-4
status: INITIATED
createdAt: '2024-03-11T07:39:05.438Z'
updatedAt: '2024-03-11T07:39:05.438Z'
appName: Notion
logo: 'https://i.imgur.com/98qPYXd.png'
totalPages: 4
page: 1
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
post:
tags:
- connectedAccounts
summary: Connect an Account
description: |-
Connect an account
This endpoint allows you to connect an external app account with Composio. It requires the integration ID in the request body and returns the connection status, connection ID, and a redirect URL (if applicable) for completing the connection flow.
Use this endpoint to initiate the process of connecting an external app for your end user.
operationId: create-connection
requestBody:
content:
application/json:
schema:
type: object
properties:
integrationId:
type: string
redirectUri:
type: string
examples:
- 'https://google.com'
required:
- integrationId
x-examples:
Example 1:
connectorId: 065bcbcf-e25b-4808-b4ad-13c16ad14824
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
connectionStatus:
type: string
enum:
- SUCCESS
- INITIATED
- FAILED
connectionId:
type: string
redirectUrl:
type: string
examples:
Create a connection:
value:
connectionStatus: INITIATED
connectionId: 4d3e5e98-2fd0-4e7b-841a-a
redirectUrl: 'https://github.com/login/oauth/authorize?client_id=e7c77&redirect_uri'
'404':
description: |-
{
"message": "Connector not found"
}
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
'/v1/connectedAccounts/{connectedAccountId}':
get:
tags:
- connectedAccounts
summary: Get a Connected Account
description: |-
Retrieves details of a specific account connected to the Composio platform by providing its connected account ID.
The response includes the integration ID, connection parameters (such as scope, base URL, client ID, token type, access token, etc.), connection ID, status, and creation/update timestamps.
operationId: get-connected-account
parameters:
- name: connectedAccountId
in: path
description: The unique identifier of the connection.
required: true
schema:
type: string
examples:
- 4d3e5e98-2fd0-4e7b-841a-a208c031b731
examples:
default:
value: 4d3e5e98-2fd0-4e7b-841a-a208c031b731
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
integrationId:
type: string
description: |
The unique identifier of the connector associated with the connection.
connectionParams:
type: object
description: An object containing the parameters specific to the connection.
properties:
scope:
type: string
description: The scope of permissions granted to the connection.
base_url:
type: string
description: The base URL for making API requests to the connected app.
client_id:
type: string
description: The client ID used for authentication with the connected app.
token_type:
type: string
description: ' The type of token used for authentication (e.g., "bearer").'
access_token:
type: string
description: The access token used for authentication with the connected app.
client_secret:
type: string
description: The client secret used for authentication with the connected app.
id:
type: string
description: The unique identifier of the connection.
status:
type: string
enum:
- ACTIVE
- INITIATED
- FAILED
description: ' The status of the connection (e.g., "SUCCESS").'
createdAt:
type: string
description: The timestamp indicating when the connection was created.
updatedAt:
type: string
description: The timestamp indicating when the connection was last updated.
examples:
Get a connection:
value:
connectorId: 065bcbcf-e25b-4808-b4ad-
connectionParams:
scope: ''
base_url: 'https://api.github.app'
client_id: e73c7edc82b30512e717
token_type: bearer
access_token: gho_KewHRYqIGjT
client_secret: f585c6035b3
id: 4d3e5e98-2fd0-4e7b-841a-031b731
status: ACTIVE
createdAt: '2024-03-11T17:13:05.237Z'
updatedAt: '2024-03-11T17:14:08.818Z'
'404':
description: |-
{
"message": "Connection not found or already deleted"
}
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
delete:
tags:
- connectedAccounts
summary: Delete a Connected Account
description: |-
Remove a specific account from the Composio platform by providing its connection ID. Upon successful deletion, the response includes a status indicating the success of the operation.
Use this endpoint to clean up unwanted connections for your end user and manage the connection lifecycle.
operationId: delete-connection
parameters:
- name: connectedAccountId
in: path
description: The unique identifier of the connection.
required: true
schema:
type: string
examples:
- 4d3e5e98-2fd0-4e7b-841a-a208c031b731
examples:
default:
value: 4d3e5e98-2fd0-4e7b-841a-a208c031b731
responses:
'200':
description: |-
{
"message": "Connection not found or already deleted"
}
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 'Status of the api call. '
examples:
Example Response:
value:
status: success
'404':
description: Not Found
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
'/v1/integrations/{integrationId}':
get:
tags:
- integrations
summary: Get an Integration
description: |-
Retrieves details of a specific integration in the Composio platform by providing its unique identifier. The response includes the connector's name, authentication scheme, authentication configuration, creation and update timestamps, enabled status, associated app information, expected input fields, and logo.
Use this endpoint to obtain detailed information about a integration and its configuration. It can be shown to end user for selection.
You will also get parameters that are required to be captured from end user to connect an account using this connector.
ex. API Key or subdomain URL.
If the end-user selects this flow, collect the parameters and connect an account using it.
operationId: get-integration
parameters:
- name: integrationId
in: path
description: The unique identifier of the integration.
required: true
schema:
type: string
examples:
- 065bcbcf-e25b-4808-b4ad-13c16ad14824
examples:
default:
value: 065bcbcf-e25b-4808-b4ad-13c16ad14824
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier of the connector.
name:
type: string
description: The name of the connector.
authScheme:
type: string
description: 'The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").'
authConfig:
type: object
description: An object containing the authentication configuration for the connector.
properties:
base_url:
type: string
description: The base URL for making API requests to the app.
client_id:
type: string
description: The client ID used for authentication with the app.
client_secret:
type: string
description: The client secret used for authentication with the app.
createdAt:
type: string
description: The timestamp indicating when the connector was created.
updatedAt:
type: string
description: The timestamp indicating when the connector was last updated.
enabled:
type: boolean
description: A boolean indicating whether the connector is enabled or not.
appId:
type: string
description: The unique identifier of the app associated with the connector.
expectedInputFields:
type: array
description: An array of input fields expected by the connector.
items:
type: object
logo:
type: string
description: The URL of the logo of the app associated with the connector.
appName:
type: string
description: The name of the app associated with the connector.
examples:
Get a connector:
value:
id: 065bcbcf-e25b-4808-b4ad-13c16ad14824
name: Github 1709897890337
authScheme: OAUTH2
authConfig:
base_url: 'https://api.github.app'
client_id: e73c7edc82b317
client_secret: f585c60af135b3e4ae02689291
createdAt: '2024-03-08T11:38:10.365Z'
updatedAt: '2024-03-11T14:56:49.606Z'
enabled: false
appId: cde35d34-9fde-3d1-ebe642ca665
expectedInputFields: []
logo: 'https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png'
appName: github
'404':
description: Not Found
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
patch:
tags:
- integrations
summary: Update an Integration
description: |-
Updates the settings of a specific integration in the Composio platform.
This endpoint allows you to modify the settings of a integration, such as enabling or disabling it, by providing its unique identifier. The request body should include the updated settings, and the response indicates the success of the update operation.
Use this endpoint to manage the configuration and behavior of integrations in the Composio platform.
operationId: update-integration
parameters:
- name: integrationId
in: path
description: The unique identifier of the integration.
required: true
schema:
type: string
examples:
- 31a23bf7-8df4-4e76-9860-143a7e3834a2
examples:
default:
value: 31a23bf7-8df4-4e76-9860-143a7e3834a2
requestBody:
content:
application/json:
schema:
type: object
properties:
enabled:
type: boolean
description: All the parameters that you see in the GET connector
examples:
Example:
value:
enabled: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
examples:
Example 1:
value:
status: success
'404':
description: Not Found
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
/v1/integrations:
get:
tags:
- integrations
summary: List All Integrations
description: |-
Retrieves a list of all integrations in the Composio platform. It supports pagination to handle large numbers of connectors. The response includes an array of connector objects, each containing information such as the connector's ID, name, authentication scheme, creation/update timestamps, enabled status, associated app information, and logo.
This are the integration you can showcase to end user, and let them select which integration they want to connect an account with.
operationId: list-connectors
parameters:
- name: page
in: query
description: Page number to fetch
schema:
type: integer
examples:
- 1
examples:
default:
value: 1
- name: pageSize
in: query
description: Page Size to assume
schema:
type: integer
examples:
- 10
examples:
default:
value: 10
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier of the newly created connector.
name:
type: string
description: The name of the connector.
authScheme:
type: string
description: The authentication scheme used by the connector.
createdAt:
type: string
description: The timestamp indicating when the connector was created.
updatedAt:
type: string
description: The timestamp indicating when the connector was last updated.
enabled:
type: boolean
description: A boolean indicating whether the connector is enabled or not.
appId:
type: string
description: The unique identifier of the app associated with the connector.
appName:
type: string
description: The name of the app associated with the connector.
logo:
type: string
description: The URL of the logo of the app associated with the connector.
totalPages:
type: integer
page:
type: integer
examples:
List all connectors:
value:
items:
- id: 065bcbcf-e25b-4808-b4a6ad14824
name: Github 1709897890337
authScheme: OAUTH2
createdAt: '2024-03-08T11:38:10.365Z'
updatedAt: '2024-03-11T14:56:49.606Z'
enabled: false
appId: cde35d34-9fde-4e12-42ca665
appName: github
logo: 'https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png'
- id: 200f53ac-04f92-91f8-68b747daff6a
name: Github - tomato_unique_hare
authScheme: API_KEY
createdAt: '2024-03-11T13:06:48.848Z'
updatedAt: '2024-03-11T13:06:48.848Z'
enabled: true
appId: cde35d34-9fde-4ebe642ca665
appName: github
logo: 'https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png'
- id: 31a23bf7-8df4-4e7643a7e3834a2
name: Notion 1709920326906
authScheme: OAUTH2
createdAt: '2024-03-08T17:52:07.518Z'
updatedAt: '2024-03-11T14:46:22.604Z'
enabled: false
appId: db51f6f1-793f-446aa
appName: notion
logo: 'https://i.imgur.com/98qPYXd.png'
totalPages: 2
page: 1
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
post:
tags:
- integrations
summary: Create a new integration
description: 'This endpoint allows you to add a new integration by providing the necessary details such as the integration name, authentication scheme, associated app ID, and authentication configuration. Upon successful creation, the response includes the newly created connector object.'
operationId: create-integration
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the connector.
authScheme:
type: string
enum:
- OAUTH2
- API_KEY
description: 'The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").'
appId:
type: string
description: The unique identifier of the app associated with the connector.
authConfig:
type: object
description: An object containing the authentication configuration for the connector.
properties:
client_id:
type: string
description: The client ID used for authentication with the app.
client_secret:
type: string
description: The client secret used for authentication with the app.
base_url:
type: string
description: ' The base URL for making API requests to the app.'
useComposioAuth:
type: boolean
description: 'Use default Composio credentials to proceed. The developer app credentials will be of Composio. '
examples:
Creating a connector:
value:
name: hello
authScheme: OAUTH2
appId: db51f6f1-793f-449e-9221-bc6043e3d6aa
authConfig:
client_id: dasdasdasdas
client_secret: dasdasdasdasdasdas
base_url: 'https://app.asana.com'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier of the newly created connector.
name:
type: string
description: The name of the connector.
authScheme:
type: string
description: The authentication scheme used by the connector.
authConfig:
type: object
description: An object containing the authentication configuration for the connector.
properties:
base_url:
type: string
description: The base URL for making API requests to the app.
client_id:
type: string
description: The client ID used for authentication with the app.
client_secret:
type: string
description: The client secret used for authentication with the app.
createdAt:
type: string
description: The timestamp indicating when the connector was created.
updatedAt:
type: string
description: The timestamp indicating when the connector was last updated.
enabled:
type: boolean
description: ' A boolean indicating whether the connector is enabled or not.'
appId:
type: string
description: The unique identifier of the app associated with the connector.
expectedInputFields:
type: array
description: An array of input fields expected by the connector.
items:
type: object
logo:
type: string
description: The URL of the logo of the app associated with the connector.
appName:
type: string
description: The name of the app associated with the connector.
examples:
Create a connector:
value:
id: 2184fd84-2fcae-873e-28218f7c0a0b
name: hello
authScheme: OAUTH2
authConfig:
base_url: 'https://app.asana.com'
client_id: dasdasdasdas
client_secret: dasdasdasdasdasdas
createdAt: '2024-03-11T17:23:15.477Z'
updatedAt: '2024-03-11T17:23:15.477Z'
enabled: false
appId: db51f6f1-449e-9221-bc6043e3d6aa
expectedInputFields: []
logo: 'https://i.imgur.com/98qPYXd.png'
appName: notion
'400':
description: Bad Request
security:
- authToken: []
servers:
- url: 'https://backend.composio.dev/api'
description: baseurl
'/v1/actions/{actionName}':
get:
tags:
- actions
summary: Get a Specific Action
description: |-
Retrieves details of a specific action in the Composio platform.
This endpoint allows you to fetch comprehensive information about a particular action by providing its unique identifier.
The response includes the action's name, display name, description, input parameters, expected response, associated app information, and enabled status.
Use this endpoint to obtain detailed information about an action, including its configuration and usage requirements.
You can then pass this to function calling or use LLM to fill in the parameters.
operationId: Get-action
parameters:
- name: actionName
in: path
description: The unique identifier of the action.
required: true
schema:
type: string
examples:
- CreateSubtask
examples:
default:
value: CreateSubtask
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the action.
display_name:
type: string
description: The display name of the action.
description:
type: string
description: |
A description of the action.
parameters:
type: object