Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
docs: update toolkits and API data
Sushmithamallesh committed
Mar 18, 2026 at 10:16 UTC
3a46641657ac9015885af9eb7bd52057a478e541
3 files changed
+915
-109
docs/content/reference/api-reference/tool-router/index.mdx
+1
@@ -16,6 +16,7 @@ description: "(Labs) Tool router endpoints"
16
| `POST /api/v3/tool_router/session/{session_id}/execute_meta` | [Execute a meta tool within a tool router session](/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecuteMeta) |
17
| `GET /api/v3/tool_router/session/{session_id}` | [Get a tool router session by ID](/reference/api-reference/tool-router/getToolRouterSessionBySessionId) |
18
| `POST /api/v3/tool_router/session/{session_id}/link` | [Create a link session for a toolkit in a tool router session](/reference/api-reference/tool-router/postToolRouterSessionBySessionIdLink) |
19
+| `POST /api/v3/tool_router/session/{session_id}/proxy_execute` | [Execute proxy request within a tool router session](/reference/api-reference/tool-router/postToolRouterSessionBySessionIdProxyExecute) |
20
| `GET /api/v3/tool_router/session/{session_id}/toolkits` | [Get toolkits for a tool router session](/reference/api-reference/tool-router/getToolRouterSessionBySessionIdToolkits) |
21
| `GET /api/v3/tool_router/session/{session_id}/tools` | [List meta tools with schemas for a tool router session](/reference/api-reference/tool-router/getToolRouterSessionBySessionIdTools) |
22
| `POST /api/v3/tool_router/session/{session_id}/search` | [Search for tools using a query](/reference/api-reference/tool-router/postToolRouterSessionBySessionIdSearch) |
docs/public/data/meta-tools.json
+2
-1
@@ -951,7 +951,8 @@
951
"post a formatted message to slack channel"
952
],
953
"title": "Use Case",
954
- "type": "string"
954
+ "type": "string",
955
+ "maxLength": 1024
956
},
957
"known_fields": {
958
"type": "string",
docs/public/openapi.json
+912
-108
@@ -14604,6 +14604,12 @@
14604
"workbench": {
14605
"type": "object",
14606
"properties": {
14607
+ "enable": {
14608
+ "type": "boolean",
14609
+ "default": true,
14610
+ "description": "Set to false to disable the workbench entirely. When disabled, no code execution tools are available in the session.",
14611
+ "example": true
14612
+ },
14613
"enable_proxy_execution": {
14614
"type": "boolean",
14615
"default": true,
@@ -14619,72 +14625,12 @@
14625
}
14626
},
14627
"default": {
14628
+ "enable": true,
14629
"enable_proxy_execution": true
14630
},
14631
"additionalProperties": false,
14632
"description": "Configuration for workbench behavior"
14633
},
14627
- "custom_tools": {
14628
- "type": "array",
14629
- "items": {
14630
- "type": "object",
14631
- "properties": {
14632
- "slug": {
14633
- "type": "string",
14634
- "minLength": 1,
14635
- "maxLength": 58,
14636
- "pattern": "^[a-zA-Z0-9_-]+$",
14637
- "description": "Machine identifier for the tool (e.g. GET_USER_CONTEXT). Max 58 chars, alphanumeric + underscores/hyphens only. Used to generate the LOCAL_ prefixed tool name.",
14638
- "example": "GET_CUSTOMER_ORDERS"
14639
- },
14640
- "name": {
14641
- "type": "string",
14642
- "minLength": 1,
14643
- "maxLength": 128,
14644
- "description": "Human-readable display name for the tool (max 128 chars)",
14645
- "example": "Get customer orders"
14646
- },
14647
- "description": {
14648
- "type": "string",
14649
- "minLength": 1,
14650
- "maxLength": 5120,
14651
- "description": "Description of what this tool does (max 5KB). Used for BM25 search matching and shown to the LLM.",
14652
- "example": "Fetch recent orders for a customer by their email address"
14653
- },
14654
- "input_schema": {
14655
- "type": "object",
14656
- "additionalProperties": {},
14657
- "description": "JSON schema describing the tool input parameters. Must have type: \"object\" and a properties field.",
14658
- "example": {
14659
- "type": "object",
14660
- "properties": {
14661
- "email": {
14662
- "type": "string",
14663
- "description": "Customer email"
14664
- }
14665
- },
14666
- "required": [
14667
- "email"
14668
- ]
14669
- }
14670
- },
14671
- "toolkit": {
14672
- "type": "string",
14673
- "minLength": 1,
14674
- "description": "Associate this local tool with an existing toolkit. Connected toolkit tools get higher search priority. Omit for no-auth tools.",
14675
- "example": "gmail"
14676
- }
14677
- },
14678
- "required": [
14679
- "slug",
14680
- "name",
14681
- "description",
14682
- "input_schema"
14683
- ]
14684
- },
14685
- "maxItems": 100,
14686
- "description": "Custom tools to include in search. Each tool needs a name, description, and input_schema. Optionally specify a toolkit to inherit connection priority. These are searched via BM25 and merged with Composio tool results."
14687
- },
14634
"experimental": {
14635
"type": "object",
14636
"properties": {
@@ -14699,6 +14645,163 @@
14645
},
14646
"additionalProperties": false,
14647
"description": "Customize assistive prompt generation (e.g., timezone)."
14648
+ },
14649
+ "custom_toolkits": {
14650
+ "type": "array",
14651
+ "items": {
14652
+ "type": "object",
14653
+ "properties": {
14654
+ "slug": {
14655
+ "type": "string",
14656
+ "minLength": 1,
14657
+ "pattern": "^[a-zA-Z0-9_-]+$",
14658
+ "description": "Unique slug for the toolkit. Must not conflict with existing Composio toolkit slugs. Alphanumeric, underscores, and hyphens only.",
14659
+ "example": "ecommerce"
14660
+ },
14661
+ "name": {
14662
+ "type": "string",
14663
+ "minLength": 1,
14664
+ "maxLength": 128,
14665
+ "description": "Display name shown to the LLM and in search results.",
14666
+ "example": "E-Commerce API"
14667
+ },
14668
+ "description": {
14669
+ "type": "string",
14670
+ "minLength": 1,
14671
+ "maxLength": 2048,
14672
+ "description": "Used for BM25 search matching and shown in toolkit connection statuses.",
14673
+ "example": "Internal e-commerce API for order management and fulfillment"
14674
+ },
14675
+ "tools": {
14676
+ "type": "array",
14677
+ "items": {
14678
+ "type": "object",
14679
+ "properties": {
14680
+ "slug": {
14681
+ "type": "string",
14682
+ "minLength": 1,
14683
+ "pattern": "^[a-zA-Z0-9_-]+$",
14684
+ "description": "Tool slug. Combined with toolkit slug to form LOCAL_<TOOLKIT>_<TOOL> (max 60 chars total).",
14685
+ "example": "GET_CUSTOMER_ORDERS"
14686
+ },
14687
+ "name": {
14688
+ "type": "string",
14689
+ "minLength": 1,
14690
+ "maxLength": 128,
14691
+ "description": "Human-readable display name",
14692
+ "example": "Get Customer Orders"
14693
+ },
14694
+ "description": {
14695
+ "type": "string",
14696
+ "minLength": 1,
14697
+ "maxLength": 5120,
14698
+ "description": "Used for BM25 search matching and shown to the LLM.",
14699
+ "example": "Fetch recent orders for a customer by their email address"
14700
+ },
14701
+ "input_schema": {
14702
+ "type": "object",
14703
+ "additionalProperties": {},
14704
+ "description": "Must have type: \"object\" and a properties field.",
14705
+ "example": {
14706
+ "type": "object",
14707
+ "properties": {
14708
+ "email": {
14709
+ "type": "string",
14710
+ "description": "Customer email"
14711
+ }
14712
+ },
14713
+ "required": [
14714
+ "email"
14715
+ ]
14716
+ }
14717
+ },
14718
+ "output_schema": {
14719
+ "type": "object",
14720
+ "additionalProperties": {},
14721
+ "description": "Optional output schema for the tool response."
14722
+ }
14723
+ },
14724
+ "required": [
14725
+ "slug",
14726
+ "name",
14727
+ "description",
14728
+ "input_schema"
14729
+ ]
14730
+ },
14731
+ "minItems": 1,
14732
+ "maxItems": 100,
14733
+ "description": "Tools in this custom toolkit"
14734
+ }
14735
+ },
14736
+ "required": [
14737
+ "slug",
14738
+ "name",
14739
+ "description",
14740
+ "tools"
14741
+ ]
14742
+ },
14743
+ "description": "Custom toolkits with grouped tools. Toolkit slugs must not conflict with existing Composio toolkits. All tools are no-auth."
14744
+ },
14745
+ "custom_tools": {
14746
+ "type": "array",
14747
+ "items": {
14748
+ "type": "object",
14749
+ "properties": {
14750
+ "slug": {
14751
+ "type": "string",
14752
+ "minLength": 1,
14753
+ "pattern": "^[a-zA-Z0-9_-]+$",
14754
+ "description": "Tool slug. Forms LOCAL_<TOOL> (standalone) or LOCAL_<TOOLKIT>_<TOOL> (extending). Max 60 chars total.",
14755
+ "example": "GET_IMPORTANT_EMAILS"
14756
+ },
14757
+ "name": {
14758
+ "type": "string",
14759
+ "minLength": 1,
14760
+ "maxLength": 128,
14761
+ "description": "Human-readable display name",
14762
+ "example": "Get Important Emails"
14763
+ },
14764
+ "description": {
14765
+ "type": "string",
14766
+ "minLength": 1,
14767
+ "maxLength": 5120,
14768
+ "description": "Used for BM25 search matching and shown to the LLM.",
14769
+ "example": "Fetch emails marked as important from the last 24 hours"
14770
+ },
14771
+ "input_schema": {
14772
+ "type": "object",
14773
+ "additionalProperties": {},
14774
+ "description": "Must have type: \"object\" and a properties field.",
14775
+ "example": {
14776
+ "type": "object",
14777
+ "properties": {
14778
+ "limit": {
14779
+ "type": "number",
14780
+ "description": "Max results to return"
14781
+ }
14782
+ }
14783
+ }
14784
+ },
14785
+ "output_schema": {
14786
+ "type": "object",
14787
+ "additionalProperties": {},
14788
+ "description": "JSON Schema describing tool output (optional)"
14789
+ },
14790
+ "extends_toolkit": {
14791
+ "type": "string",
14792
+ "minLength": 1,
14793
+ "description": "If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's auth/connection status. If omitted, the tool is standalone (no-auth).",
14794
+ "example": "gmail"
14795
+ }
14796
+ },
14797
+ "required": [
14798
+ "slug",
14799
+ "name",
14800
+ "description",
14801
+ "input_schema"
14802
+ ]
14803
+ },
14804
+ "description": "Custom tools to include in search. Standalone tools need no auth. Tools with extends_toolkit inherit the Composio toolkit's connection."
14805
}
14806
},
14807
"additionalProperties": false,
@@ -15135,6 +15238,10 @@
15238
"workbench": {
15239
"type": "object",
15240
"properties": {
15241
+ "enable": {
15242
+ "type": "boolean",
15243
+ "description": "Whether the workbench (code execution sandbox) is enabled. When false, COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed."
15244
+ },
15245
"proxy_execution_enabled": {
15246
"type": "boolean",
15247
"description": "Whether proxy execution is enabled in the workbench"
@@ -15147,11 +15254,25 @@
15254
}
15255
},
15256
"default": {
15257
+ "enable": true,
15258
"proxy_execution_enabled": true
15259
},
15260
"description": "Workbench configuration"
15261
+ }
15262
+ },
15263
+ "required": [
15264
+ "user_id"
15265
+ ],
15266
+ "description": "The session configuration including user, toolkits, and overrides"
15267
+ },
15268
+ "experimental": {
15269
+ "type": "object",
15270
+ "properties": {
15271
+ "assistive_prompt": {
15272
+ "type": "string",
15273
+ "description": "The assistive system prompt for the tool router session"
15274
},
15154
- "custom_tools": {
15275
+ "custom_toolkits": {
15276
"type": "array",
15277
"items": {
15278
"type": "object",
@@ -15159,7 +15280,6 @@
15280
"slug": {
15281
"type": "string",
15282
"minLength": 1,
15162
- "maxLength": 58,
15283
"pattern": "^[a-zA-Z0-9_-]+$"
15284
},
15285
"name": {
@@ -15167,6 +15287,76 @@
15287
"minLength": 1,
15288
"maxLength": 128
15289
},
15290
+ "description": {
15291
+ "type": "string",
15292
+ "minLength": 1,
15293
+ "maxLength": 2048
15294
+ },
15295
+ "tools": {
15296
+ "type": "array",
15297
+ "items": {
15298
+ "type": "object",
15299
+ "properties": {
15300
+ "slug": {
15301
+ "type": "string",
15302
+ "description": "Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)"
15303
+ },
15304
+ "name": {
15305
+ "type": "string",
15306
+ "minLength": 1,
15307
+ "maxLength": 128
15308
+ },
15309
+ "description": {
15310
+ "type": "string",
15311
+ "minLength": 1,
15312
+ "maxLength": 5120
15313
+ },
15314
+ "input_schema": {
15315
+ "type": "object",
15316
+ "additionalProperties": {}
15317
+ },
15318
+ "output_schema": {
15319
+ "type": "object",
15320
+ "additionalProperties": {}
15321
+ },
15322
+ "original_slug": {
15323
+ "type": "string",
15324
+ "description": "Original tool slug as provided by the user"
15325
+ }
15326
+ },
15327
+ "required": [
15328
+ "slug",
15329
+ "name",
15330
+ "description",
15331
+ "input_schema",
15332
+ "original_slug"
15333
+ ]
15334
+ }
15335
+ }
15336
+ },
15337
+ "required": [
15338
+ "slug",
15339
+ "name",
15340
+ "description",
15341
+ "tools"
15342
+ ]
15343
+ },
15344
+ "description": "User-defined custom toolkits with grouped tools (no-auth)"
15345
+ },
15346
+ "custom_tools": {
15347
+ "type": "array",
15348
+ "items": {
15349
+ "type": "object",
15350
+ "properties": {
15351
+ "slug": {
15352
+ "type": "string",
15353
+ "description": "Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)"
15354
+ },
15355
+ "name": {
15356
+ "type": "string",
15357
+ "minLength": 1,
15358
+ "maxLength": 128
15359
+ },
15360
"description": {
15361
"type": "string",
15362
"minLength": 1,
@@ -15176,38 +15366,30 @@
15366
"type": "object",
15367
"additionalProperties": {}
15368
},
15179
- "toolkit": {
15369
+ "output_schema": {
15370
+ "type": "object",
15371
+ "additionalProperties": {}
15372
+ },
15373
+ "extends_toolkit": {
15374
"type": "string",
15375
"minLength": 1
15376
+ },
15377
+ "original_slug": {
15378
+ "type": "string",
15379
+ "description": "Original tool slug as provided by the user"
15380
}
15381
},
15382
"required": [
15383
"slug",
15384
"name",
15385
"description",
15188
- "input_schema"
15386
+ "input_schema",
15387
+ "original_slug"
15388
]
15389
},
15191
- "description": "User-provided custom tools configured for this session"
15192
- }
15193
- },
15194
- "required": [
15195
- "user_id"
15196
- ],
15197
- "description": "The session configuration including user, toolkits, and overrides"
15198
- },
15199
- "experimental": {
15200
- "type": "object",
15201
- "properties": {
15202
- "assistive_prompt": {
15203
- "type": "string",
15204
- "description": "The assistive system prompt to inject into your agent for optimal tool router usage",
15205
- "example": "You are an AI agent that completes user tasks by calling Composio ToolRouter meta-tools..."
15390
+ "description": "Custom tools — standalone or extending Composio toolkits"
15391
}
15392
},
15208
- "required": [
15209
- "assistive_prompt"
15210
- ],
15393
"description": "Experimental features including the generated system prompt. Only returned on session creation, not on GET.",
15394
"x-experimental": true
15395
}
@@ -15849,6 +16031,10 @@
16031
"workbench": {
16032
"type": "object",
16033
"properties": {
16034
+ "enable": {
16035
+ "type": "boolean",
16036
+ "description": "Whether the workbench (code execution sandbox) is enabled. When false, COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed."
16037
+ },
16038
"proxy_execution_enabled": {
16039
"type": "boolean",
16040
"description": "Whether proxy execution is enabled in the workbench"
@@ -15861,11 +16047,25 @@
16047
}
16048
},
16049
"default": {
16050
+ "enable": true,
16051
"proxy_execution_enabled": true
16052
},
16053
"description": "Workbench configuration"
16054
+ }
16055
+ },
16056
+ "required": [
16057
+ "user_id"
16058
+ ],
16059
+ "description": "The session configuration including user, toolkits, and overrides"
16060
+ },
16061
+ "experimental": {
16062
+ "type": "object",
16063
+ "properties": {
16064
+ "assistive_prompt": {
16065
+ "type": "string",
16066
+ "description": "The assistive system prompt for the tool router session"
16067
},
15868
- "custom_tools": {
16068
+ "custom_toolkits": {
16069
"type": "array",
16070
"items": {
16071
"type": "object",
@@ -15873,7 +16073,6 @@
16073
"slug": {
16074
"type": "string",
16075
"minLength": 1,
15876
- "maxLength": 58,
16076
"pattern": "^[a-zA-Z0-9_-]+$"
16077
},
16078
"name": {
@@ -15884,38 +16083,115 @@
16083
"description": {
16084
"type": "string",
16085
"minLength": 1,
15887
- "maxLength": 5120
16086
+ "maxLength": 2048
16087
},
15889
- "input_schema": {
15890
- "type": "object",
15891
- "additionalProperties": {}
15892
- },
15893
- "toolkit": {
15894
- "type": "string",
15895
- "minLength": 1
16088
+ "tools": {
16089
+ "type": "array",
16090
+ "items": {
16091
+ "type": "object",
16092
+ "properties": {
16093
+ "slug": {
16094
+ "type": "string",
16095
+ "description": "Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)"
16096
+ },
16097
+ "name": {
16098
+ "type": "string",
16099
+ "minLength": 1,
16100
+ "maxLength": 128
16101
+ },
16102
+ "description": {
16103
+ "type": "string",
16104
+ "minLength": 1,
16105
+ "maxLength": 5120
16106
+ },
16107
+ "input_schema": {
16108
+ "type": "object",
16109
+ "additionalProperties": {}
16110
+ },
16111
+ "output_schema": {
16112
+ "type": "object",
16113
+ "additionalProperties": {}
16114
+ },
16115
+ "original_slug": {
16116
+ "type": "string",
16117
+ "description": "Original tool slug as provided by the user"
16118
+ }
16119
+ },
16120
+ "required": [
16121
+ "slug",
16122
+ "name",
16123
+ "description",
16124
+ "input_schema",
16125
+ "original_slug"
16126
+ ]
16127
+ }
16128
}
16129
},
16130
"required": [
16131
"slug",
16132
"name",
16133
"description",
15902
- "input_schema"
16134
+ "tools"
16135
]
16136
},
15905
- "description": "User-provided custom tools configured for this session"
15906
- }
15907
- },
15908
- "required": [
15909
- "user_id"
15910
- ],
15911
- "description": "The session configuration including user, toolkits, and overrides"
15912
- }
15913
- },
15914
- "required": [
15915
- "session_id",
15916
- "mcp",
15917
- "tool_router_tools",
15918
- "config"
16137
+ "description": "User-defined custom toolkits with grouped tools (no-auth)"
16138
+ },
16139
+ "custom_tools": {
16140
+ "type": "array",
16141
+ "items": {
16142
+ "type": "object",
16143
+ "properties": {
16144
+ "slug": {
16145
+ "type": "string",
16146
+ "description": "Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)"
16147
+ },
16148
+ "name": {
16149
+ "type": "string",
16150
+ "minLength": 1,
16151
+ "maxLength": 128
16152
+ },
16153
+ "description": {
16154
+ "type": "string",
16155
+ "minLength": 1,
16156
+ "maxLength": 5120
16157
+ },
16158
+ "input_schema": {
16159
+ "type": "object",
16160
+ "additionalProperties": {}
16161
+ },
16162
+ "output_schema": {
16163
+ "type": "object",
16164
+ "additionalProperties": {}
16165
+ },
16166
+ "extends_toolkit": {
16167
+ "type": "string",
16168
+ "minLength": 1
16169
+ },
16170
+ "original_slug": {
16171
+ "type": "string",
16172
+ "description": "Original tool slug as provided by the user"
16173
+ }
16174
+ },
16175
+ "required": [
16176
+ "slug",
16177
+ "name",
16178
+ "description",
16179
+ "input_schema",
16180
+ "original_slug"
16181
+ ]
16182
+ },
16183
+ "description": "Custom tools — standalone or extending Composio toolkits"
16184
+ }
16185
+ },
16186
+ "description": "Experimental features",
16187
+ "x-experimental": true
16188
+ }
16189
+ },
16190
+ "required": [
16191
+ "session_id",
16192
+ "mcp",
16193
+ "tool_router_tools",
16194
+ "config"
16195
]
16196
}
16197
}
@@ -16108,6 +16384,534 @@
16384
}
16385
}
16386
},
16387
+ "/api/v3/tool_router/session/{session_id}/proxy_execute": {
16388
+ "post": {
16389
+ "summary": "Execute proxy request within a tool router session",
16390
+ "description": "Execute any native API call on a toolkit with authentication automatically injected from Composio. This endpoint proxies HTTP requests to third-party APIs using connected account credentials resolved from the session context. Provide the toolkit slug, API endpoint, and HTTP method — Composio handles authentication injection, abstracting away credential management. Supports all HTTP methods, custom headers/query parameters, and binary request/response bodies.",
16391
+ "tags": [
16392
+ "Tool Router"
16393
+ ],
16394
+ "operationId": "postToolRouterSessionBySessionIdProxyExecute",
16395
+ "security": [
16396
+ {
16397
+ "ApiKeyAuth": []
16398
+ },
16399
+ {
16400
+ "UserApiKeyAuth": []
16401
+ },
16402
+ {
16403
+ "workbench_access_key": []
16404
+ }
16405
+ ],
16406
+ "parameters": [
16407
+ {
16408
+ "schema": {
16409
+ "type": "string",
16410
+ "format": "toolRouterSessionId",
16411
+ "description": "The unique identifier of the tool router session. Required for public API endpoints, optional for internal endpoints where it is injected by middleware.",
16412
+ "example": "trs_LX9uJKBinWWr"
16413
+ },
16414
+ "required": false,
16415
+ "description": "Tool router session ID (required for public API, optional for internal - injected by middleware)",
16416
+ "name": "session_id",
16417
+ "in": "path"
16418
+ }
16419
+ ],
16420
+ "requestBody": {
16421
+ "content": {
16422
+ "application/json": {
16423
+ "schema": {
16424
+ "type": "object",
16425
+ "properties": {
16426
+ "toolkit_slug": {
16427
+ "type": "string",
16428
+ "description": "The slug of the toolkit to use for the request",
16429
+ "example": "gmail"
16430
+ },
16431
+ "endpoint": {
16432
+ "type": "string",
16433
+ "description": "The API endpoint to call (absolute URL or path relative to base URL of the connected account)",
16434
+ "example": "/api/v1/resources"
16435
+ },
16436
+ "method": {
16437
+ "type": "string",
16438
+ "enum": [
16439
+ "GET",
16440
+ "POST",
16441
+ "PUT",
16442
+ "DELETE",
16443
+ "PATCH",
16444
+ "HEAD"
16445
+ ],
16446
+ "description": "The HTTP method to use for the request",
16447
+ "example": "GET"
16448
+ },
16449
+ "body": {
16450
+ "nullable": true,
16451
+ "description": "The request body (for POST, PUT, and PATCH requests)",
16452
+ "example": {
16453
+ "name": "New Resource",
16454
+ "description": "This is a new resource"
16455
+ },
16456
+ "type": "object"
16457
+ },
16458
+ "binary_body": {
16459
+ "anyOf": [
16460
+ {
16461
+ "type": "object",
16462
+ "properties": {
16463
+ "url": {
16464
+ "type": "string",
16465
+ "format": "uri",
16466
+ "description": "URL to fetch binary content from"
16467
+ },
16468
+ "content_type": {
16469
+ "type": "string",
16470
+ "description": "Content-Type header to use for the request"
16471
+ }
16472
+ },
16473
+ "required": [
16474
+ "url"
16475
+ ]
16476
+ },
16477
+ {
16478
+ "type": "object",
16479
+ "properties": {
16480
+ "base64": {
16481
+ "type": "string",
16482
+ "minLength": 1,
16483
+ "description": "Base64-encoded binary data"
16484
+ },
16485
+ "content_type": {
16486
+ "type": "string",
16487
+ "description": "Content-Type header to use for the request"
16488
+ }
16489
+ },
16490
+ "required": [
16491
+ "base64"
16492
+ ]
16493
+ }
16494
+ ],
16495
+ "description": "Binary body to send. For binary upload via URL: use {url: \"https://...\", content_type?: \"...\"}. For binary upload via base64: use {base64: \"...\", content_type?: \"...\"}."
16496
+ },
16497
+ "parameters": {
16498
+ "type": "array",
16499
+ "items": {
16500
+ "type": "object",
16501
+ "properties": {
16502
+ "name": {
16503
+ "type": "string",
16504
+ "description": "Parameter name",
16505
+ "example": "x-api-key"
16506
+ },
16507
+ "value": {
16508
+ "type": "string",
16509
+ "description": "Parameter value",
16510
+ "example": "abc123def456"
16511
+ },
16512
+ "type": {
16513
+ "type": "string",
16514
+ "enum": [
16515
+ "header",
16516
+ "query"
16517
+ ],
16518
+ "description": "Parameter type (header or query)",
16519
+ "example": "header"
16520
+ }
16521
+ },
16522
+ "required": [
16523
+ "name",
16524
+ "value",
16525
+ "type"
16526
+ ]
16527
+ },
16528
+ "description": "Additional HTTP headers or query parameters to include in the request",
16529
+ "example": [
16530
+ {
16531
+ "name": "x-api-key",
16532
+ "value": "abc123def456",
16533
+ "type": "header"
16534
+ },
16535
+ {
16536
+ "name": "filter",
16537
+ "value": "active",
16538
+ "type": "query"
16539
+ }
16540
+ ]
16541
+ },
16542
+ "custom_connection_data": {
16543
+ "type": "object",
16544
+ "properties": {
16545
+ "authScheme": {
16546
+ "type": "string",
16547
+ "enum": [
16548
+ "OAUTH2",
16549
+ "DCR_OAUTH",
16550
+ "API_KEY",
16551
+ "BASIC_WITH_JWT",
16552
+ "BASIC",
16553
+ "BEARER_TOKEN",
16554
+ "OAUTH1",
16555
+ "NO_AUTH",
16556
+ "SERVICE_ACCOUNT",
16557
+ "GOOGLE_SERVICE_ACCOUNT",
16558
+ "S2S_OAUTH2"
16559
+ ]
16560
+ },
16561
+ "toolkitSlug": {
16562
+ "type": "string"
16563
+ },
16564
+ "val": {
16565
+ "type": "object",
16566
+ "properties": {
16567
+ "subdomain": {
16568
+ "type": "string"
16569
+ },
16570
+ "your-domain": {
16571
+ "type": "string"
16572
+ },
16573
+ "region": {
16574
+ "type": "string"
16575
+ },
16576
+ "shop": {
16577
+ "type": "string"
16578
+ },
16579
+ "account_url": {
16580
+ "type": "string"
16581
+ },
16582
+ "COMPANYDOMAIN": {
16583
+ "type": "string"
16584
+ },
16585
+ "extension": {
16586
+ "type": "string"
16587
+ },
16588
+ "form_api_base_url": {
16589
+ "type": "string"
16590
+ },
16591
+ "instanceEndpoint": {
16592
+ "type": "string"
16593
+ },
16594
+ "api_url": {
16595
+ "type": "string"
16596
+ },
16597
+ "borneo_dashboard_url": {
16598
+ "type": "string"
16599
+ },
16600
+ "proxy_username": {
16601
+ "type": "string"
16602
+ },
16603
+ "proxy_password": {
16604
+ "type": "string"
16605
+ },
16606
+ "domain": {
16607
+ "type": "string"
16608
+ },
16609
+ "version": {
16610
+ "type": "string"
16611
+ },
16612
+ "dc": {
16613
+ "type": "string"
16614
+ },
16615
+ "site_name": {
16616
+ "type": "string"
16617
+ },
16618
+ "instanceName": {
16619
+ "type": "string"
16620
+ },
16621
+ "account_id": {
16622
+ "type": "string"
16623
+ },
16624
+ "your_server": {
16625
+ "type": "string"
16626
+ },
16627
+ "server_location": {
16628
+ "type": "string"
16629
+ },
16630
+ "base_url": {
16631
+ "type": "string"
16632
+ },
16633
+ "state_prefix": {
16634
+ "type": "string",
16635
+ "maxLength": 40,
16636
+ "description": "The oauth2 state prefix for the connection"
16637
+ },
16638
+ "long_redirect_url": {
16639
+ "type": "boolean",
16640
+ "description": "Whether to return the redirect url without shortening"
16641
+ },
16642
+ "access_token": {
16643
+ "type": "string"
16644
+ },
16645
+ "id_token": {
16646
+ "type": "string"
16647
+ },
16648
+ "token_type": {
16649
+ "type": "string"
16650
+ },
16651
+ "refresh_token": {
16652
+ "type": "string",
16653
+ "nullable": true
16654
+ },
16655
+ "expires_in": {
16656
+ "anyOf": [
16657
+ {
16658
+ "type": "number"
16659
+ },
16660
+ {
16661
+ "type": "string"
16662
+ },
16663
+ {
16664
+ "nullable": true,
16665
+ "type": "object"
16666
+ }
16667
+ ]
16668
+ },
16669
+ "scope": {
16670
+ "anyOf": [
16671
+ {
16672
+ "type": "string"
16673
+ },
16674
+ {
16675
+ "type": "array",
16676
+ "items": {
16677
+ "type": "string"
16678
+ }
16679
+ },
16680
+ {
16681
+ "nullable": true,
16682
+ "type": "object"
16683
+ }
16684
+ ]
16685
+ },
16686
+ "webhook_signature": {
16687
+ "type": "string"
16688
+ },
16689
+ "authed_user": {
16690
+ "type": "object",
16691
+ "properties": {
16692
+ "access_token": {
16693
+ "type": "string"
16694
+ },
16695
+ "scope": {
16696
+ "type": "string"
16697
+ }
16698
+ },
16699
+ "description": "for slack user scopes"
16700
+ },
16701
+ "client_id": {
16702
+ "type": "string",
16703
+ "description": "Dynamically registered client ID"
16704
+ },
16705
+ "client_secret": {
16706
+ "type": "string",
16707
+ "description": "Dynamically registered client secret"
16708
+ },
16709
+ "client_id_issued_at": {
16710
+ "type": "number"
16711
+ },
16712
+ "client_secret_expires_at": {
16713
+ "type": "number"
16714
+ },
16715
+ "generic_api_key": {
16716
+ "type": "string"
16717
+ },
16718
+ "api_key": {
16719
+ "type": "string"
16720
+ },
16721
+ "bearer_token": {
16722
+ "type": "string"
16723
+ },
16724
+ "basic_encoded": {
16725
+ "type": "string"
16726
+ },
16727
+ "username": {
16728
+ "type": "string"
16729
+ },
16730
+ "password": {
16731
+ "type": "string"
16732
+ },
16733
+ "token": {
16734
+ "type": "string"
16735
+ },
16736
+ "oauth_token": {
16737
+ "type": "string"
16738
+ },
16739
+ "oauth_token_secret": {
16740
+ "type": "string"
16741
+ },
16742
+ "oauth_verifier": {
16743
+ "type": "string"
16744
+ },
16745
+ "consumer_key": {
16746
+ "type": "string"
16747
+ },
16748
+ "redirectUrl": {
16749
+ "type": "string"
16750
+ },
16751
+ "callback_url": {
16752
+ "type": "string"
16753
+ },
16754
+ "application_id": {
16755
+ "type": "string"
16756
+ },
16757
+ "installation_id": {
16758
+ "type": "string"
16759
+ },
16760
+ "private_key": {
16761
+ "type": "string"
16762
+ },
16763
+ "credentials_json": {
16764
+ "type": "string"
16765
+ },
16766
+ "expires_at": {
16767
+ "type": "string"
16768
+ }
16769
+ },
16770
+ "required": [
16771
+ "access_token"
16772
+ ],
16773
+ "additionalProperties": {}
16774
+ }
16775
+ },
16776
+ "required": [
16777
+ "authScheme",
16778
+ "toolkitSlug",
16779
+ "val"
16780
+ ],
16781
+ "additionalProperties": true
16782
+ }
16783
+ },
16784
+ "required": [
16785
+ "toolkit_slug",
16786
+ "endpoint",
16787
+ "method"
16788
+ ]
16789
+ }
16790
+ }
16791
+ }
16792
+ },
16793
+ "responses": {
16794
+ "200": {
16795
+ "description": "Successfully executed proxy request and received response",
16796
+ "content": {
16797
+ "application/json": {
16798
+ "schema": {
16799
+ "type": "object",
16800
+ "properties": {
16801
+ "data": {
16802
+ "nullable": true,
16803
+ "description": "The response data returned from the proxied API",
16804
+ "example": {
16805
+ "id": "123",
16806
+ "name": "Resource Name",
16807
+ "created_at": "2023-01-01T00:00:00Z"
16808
+ },
16809
+ "type": "object"
16810
+ },
16811
+ "binary_data": {
16812
+ "type": "object",
16813
+ "properties": {
16814
+ "url": {
16815
+ "type": "string",
16816
+ "description": "URL to download binary content"
16817
+ },
16818
+ "content_type": {
16819
+ "type": "string",
16820
+ "description": "Content-Type of the binary data"
16821
+ },
16822
+ "size": {
16823
+ "type": "number",
16824
+ "description": "File size in bytes"
16825
+ },
16826
+ "expires_at": {
16827
+ "type": "string",
16828
+ "description": "ISO 8601 timestamp when the URL expires"
16829
+ }
16830
+ },
16831
+ "required": [
16832
+ "url",
16833
+ "content_type",
16834
+ "size"
16835
+ ],
16836
+ "description": "Binary body response data. Present when the response is a binary file."
16837
+ },
16838
+ "status": {
16839
+ "type": "number",
16840
+ "description": "The HTTP status code returned from the proxied API",
16841
+ "example": 200
16842
+ },
16843
+ "headers": {
16844
+ "type": "object",
16845
+ "additionalProperties": {
16846
+ "type": "string"
16847
+ },
16848
+ "description": "The HTTP headers returned from the proxied API",
16849
+ "example": {
16850
+ "content-type": "application/json",
16851
+ "cache-control": "no-cache"
16852
+ }
16853
+ }
16854
+ },
16855
+ "required": [
16856
+ "status"
16857
+ ]
16858
+ }
16859
+ }
16860
+ }
16861
+ },
16862
+ "400": {
16863
+ "description": "Bad request",
16864
+ "content": {
16865
+ "application/json": {
16866
+ "schema": {
16867
+ "$ref": "#/components/schemas/Error"
16868
+ }
16869
+ }
16870
+ }
16871
+ },
16872
+ "401": {
16873
+ "description": "Unauthorized",
16874
+ "content": {
16875
+ "application/json": {
16876
+ "schema": {
16877
+ "$ref": "#/components/schemas/Error"
16878
+ }
16879
+ }
16880
+ }
16881
+ },
16882
+ "403": {
16883
+ "description": "Forbidden",
16884
+ "content": {
16885
+ "application/json": {
16886
+ "schema": {
16887
+ "$ref": "#/components/schemas/Error"
16888
+ }
16889
+ }
16890
+ }
16891
+ },
16892
+ "404": {
16893
+ "description": "Not found",
16894
+ "content": {
16895
+ "application/json": {
16896
+ "schema": {
16897
+ "$ref": "#/components/schemas/Error"
16898
+ }
16899
+ }
16900
+ }
16901
+ },
16902
+ "500": {
16903
+ "description": "Internal server error",
16904
+ "content": {
16905
+ "application/json": {
16906
+ "schema": {
16907
+ "$ref": "#/components/schemas/Error"
16908
+ }
16909
+ }
16910
+ }
16911
+ }
16912
+ }
16913
+ }
16914
+ },
16915
"/api/v3/tool_router/session/{session_id}/toolkits": {
16916
"get": {
16917
"summary": "Get toolkits for a tool router session",