Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 22, 00:45 UTC
docs: update toolkits and API data
Sushmithamallesh committed
Apr 6, 2026 at 04:29 UTC
6785f0513b851c96008eb4d0cc8519fa307cc5a5
2 files changed
+551
-551
docs/content/reference/api-reference/tools/index.mdx
+2
-2
@@ -11,9 +11,9 @@ Tool execution endpoints
11
12
| Endpoint | Quick Link |
13
|----------|------------|
14
-| `GET /api/v3/tools` | [List available tools](/reference/api-reference/tools/getTools) |
15
-| `GET /api/v3/tools/enum` | [Get tool enum list](/reference/api-reference/tools/getToolsEnum) |
14
| `POST /api/v3/tools/execute/proxy` | [Execute proxy request](/reference/api-reference/tools/postToolsExecuteProxy) |
15
+| `GET /api/v3.1/tools` | [List available tools](/reference/api-reference/tools/getV3_1Tools) |
16
+| `GET /api/v3.1/tools/enum` | [Get tool enum list](/reference/api-reference/tools/getV3_1ToolsEnum) |
17
| `GET /api/v3.1/tools/{tool_slug}` | [Get tool by slug](/reference/api-reference/tools/getV3_1ToolsByToolSlug) |
18
| `POST /api/v3.1/tools/execute/{tool_slug}` | [Execute tool](/reference/api-reference/tools/postV3_1ToolsExecuteByToolSlug) |
19
| `POST /api/v3.1/tools/execute/{tool_slug}/input` | [Generate tool inputs from natural language](/reference/api-reference/tools/postV3_1ToolsExecuteByToolSlugInput) |
docs/public/openapi.json
+549
-549
@@ -7613,343 +7613,6 @@
7613
}
7614
}
7615
},
7616
- "/api/v3/tools": {
7617
- "get": {
7618
- "summary": "List available tools",
7619
- "description": "Retrieve a paginated list of available tools with comprehensive filtering, sorting and search capabilities. Use query parameters to narrow down results by toolkit, tags, or search terms.",
7620
- "tags": [
7621
- "Tools"
7622
- ],
7623
- "operationId": "getTools",
7624
- "security": [
7625
- {
7626
- "ApiKeyAuth": []
7627
- },
7628
- {
7629
- "UserApiKeyAuth": []
7630
- }
7631
- ],
7632
- "parameters": [
7633
- {
7634
- "schema": {
7635
- "type": "string"
7636
- },
7637
- "required": false,
7638
- "description": "The slug of the toolkit to filter by",
7639
- "in": "query",
7640
- "name": "toolkit_slug"
7641
- },
7642
- {
7643
- "schema": {
7644
- "type": "string"
7645
- },
7646
- "required": false,
7647
- "description": "Comma-separated list of specific tool slugs to retrieve (overrides other filters)",
7648
- "in": "query",
7649
- "name": "tool_slugs"
7650
- },
7651
- {
7652
- "schema": {
7653
- "oneOf": [
7654
- {
7655
- "type": "string"
7656
- },
7657
- {
7658
- "type": "array",
7659
- "items": {
7660
- "type": "string"
7661
- }
7662
- }
7663
- ]
7664
- },
7665
- "required": false,
7666
- "description": "Comma-separated list of auth config IDs to filter tools by",
7667
- "in": "query",
7668
- "name": "auth_config_ids"
7669
- },
7670
- {
7671
- "schema": {
7672
- "type": "string",
7673
- "enum": [
7674
- "true",
7675
- "false"
7676
- ]
7677
- },
7678
- "required": false,
7679
- "description": "Filter to only show important/featured tools (set to \"true\" to enable)",
7680
- "in": "query",
7681
- "name": "important"
7682
- },
7683
- {
7684
- "schema": {
7685
- "type": "array",
7686
- "items": {
7687
- "type": "string"
7688
- }
7689
- },
7690
- "required": false,
7691
- "description": "Filter tools by one or more tags (can be specified multiple times)",
7692
- "in": "query",
7693
- "name": "tags"
7694
- },
7695
- {
7696
- "schema": {
7697
- "type": "array",
7698
- "nullable": true,
7699
- "items": {
7700
- "type": "string"
7701
- },
7702
- "description": "Filter tools by one or more scopes (can be specified multiple times)"
7703
- },
7704
- "required": false,
7705
- "description": "Array of scopes to filter tools by)",
7706
- "name": "scopes",
7707
- "in": "query"
7708
- },
7709
- {
7710
- "schema": {
7711
- "type": "string"
7712
- },
7713
- "required": false,
7714
- "description": "Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.",
7715
- "in": "query",
7716
- "name": "query"
7717
- },
7718
- {
7719
- "schema": {
7720
- "type": "string"
7721
- },
7722
- "required": false,
7723
- "description": "Deprecated: use \"query\" instead. Free-text search query to find tools by name, description, or functionality.",
7724
- "in": "query",
7725
- "name": "search",
7726
- "deprecated": true
7727
- },
7728
- {
7729
- "schema": {
7730
- "type": "boolean",
7731
- "default": true
7732
- },
7733
- "required": false,
7734
- "description": "Include deprecated tools in the response",
7735
- "in": "query",
7736
- "name": "include_deprecated"
7737
- },
7738
- {
7739
- "schema": {
7740
- "oneOf": [
7741
- {
7742
- "type": "null"
7743
- },
7744
- {
7745
- "type": "string"
7746
- },
7747
- {
7748
- "type": "object",
7749
- "additionalProperties": {
7750
- "type": "string"
7751
- },
7752
- "description": "Object representation of parsed bracket notation"
7753
- }
7754
- ]
7755
- },
7756
- "required": false,
7757
- "description": "Toolkit version specification. Use \"latest\" for latest versions or bracket notation for specific versions per toolkit.",
7758
- "in": "query",
7759
- "name": "toolkit_versions",
7760
- "examples": {
7761
- "latest_version": {
7762
- "summary": "Latest version for all toolkits",
7763
- "value": "latest"
7764
- },
7765
- "bracket_notation": {
7766
- "summary": "Specific versions using bracket notation",
7767
- "value": "Use: toolkit_versions[gmail]=20250930_00&toolkit_versions[slack]=20250929_00"
7768
- },
7769
- "null_value": {
7770
- "summary": "No version specified (uses 00000000_00)",
7771
- "value": null
7772
- }
7773
- }
7774
- },
7775
- {
7776
- "schema": {
7777
- "type": "number",
7778
- "nullable": true
7779
- },
7780
- "required": false,
7781
- "description": "Number of items per page, max allowed is 1000",
7782
- "name": "limit",
7783
- "in": "query"
7784
- },
7785
- {
7786
- "schema": {
7787
- "type": "string"
7788
- },
7789
- "required": false,
7790
- "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
7791
- "name": "cursor",
7792
- "in": "query"
7793
- }
7794
- ],
7795
- "responses": {
7796
- "200": {
7797
- "description": "Successfully retrieved tools list with pagination information",
7798
- "content": {
7799
- "application/json": {
7800
- "schema": {
7801
- "$ref": "#/components/schemas/ToolsPaginated"
7802
- }
7803
- }
7804
- }
7805
- },
7806
- "400": {
7807
- "description": "Bad request - Invalid query parameters",
7808
- "content": {
7809
- "application/json": {
7810
- "schema": {
7811
- "$ref": "#/components/schemas/Error"
7812
- }
7813
- }
7814
- }
7815
- },
7816
- "401": {
7817
- "description": "Unauthorized - Authentication credentials are missing or invalid",
7818
- "content": {
7819
- "application/json": {
7820
- "schema": {
7821
- "$ref": "#/components/schemas/Error"
7822
- }
7823
- }
7824
- }
7825
- },
7826
- "403": {
7827
- "description": "Forbidden - User does not have permission to access tools",
7828
- "content": {
7829
- "application/json": {
7830
- "schema": {
7831
- "$ref": "#/components/schemas/Error"
7832
- }
7833
- }
7834
- }
7835
- },
7836
- "404": {
7837
- "description": "Not found - The requested resource was not found",
7838
- "content": {
7839
- "application/json": {
7840
- "schema": {
7841
- "$ref": "#/components/schemas/Error"
7842
- }
7843
- }
7844
- }
7845
- },
7846
- "429": {
7847
- "description": "Too many requests - Rate limit exceeded",
7848
- "content": {
7849
- "application/json": {
7850
- "schema": {
7851
- "$ref": "#/components/schemas/Error"
7852
- }
7853
- }
7854
- }
7855
- },
7856
- "500": {
7857
- "description": "Internal server error - Something went wrong on the server",
7858
- "content": {
7859
- "application/json": {
7860
- "schema": {
7861
- "$ref": "#/components/schemas/Error"
7862
- }
7863
- }
7864
- }
7865
- }
7866
- }
7867
- }
7868
- },
7869
- "/api/v3/tools/enum": {
7870
- "get": {
7871
- "summary": "Get tool enum list",
7872
- "description": "Retrieve a list of all available tool enumeration values (tool slugs) from latest version of each toolkit. This endpoint returns a comma-separated string of tool slugs that can be used in other API calls.",
7873
- "tags": [
7874
- "Tools"
7875
- ],
7876
- "operationId": "getToolsEnum",
7877
- "security": [
7878
- {
7879
- "ApiKeyAuth": []
7880
- },
7881
- {
7882
- "UserApiKeyAuth": []
7883
- }
7884
- ],
7885
- "responses": {
7886
- "200": {
7887
- "description": "Successfully retrieved tool enum list",
7888
- "content": {
7889
- "application/json": {
7890
- "schema": {
7891
- "type": "array",
7892
- "items": {
7893
- "type": "string"
7894
- },
7895
- "description": "JSON string containing all tool enum values from latest version of each toolkit"
7896
- }
7897
- }
7898
- }
7899
- },
7900
- "400": {
7901
- "description": "Bad request - Invalid request parameters",
7902
- "content": {
7903
- "application/json": {
7904
- "schema": {
7905
- "$ref": "#/components/schemas/Error"
7906
- }
7907
- }
7908
- }
7909
- },
7910
- "401": {
7911
- "description": "Unauthorized - Authentication credentials are missing or invalid",
7912
- "content": {
7913
- "application/json": {
7914
- "schema": {
7915
- "$ref": "#/components/schemas/Error"
7916
- }
7917
- }
7918
- }
7919
- },
7920
- "403": {
7921
- "description": "Forbidden - User does not have permission to access tool enums",
7922
- "content": {
7923
- "application/json": {
7924
- "schema": {
7925
- "$ref": "#/components/schemas/Error"
7926
- }
7927
- }
7928
- }
7929
- },
7930
- "404": {
7931
- "description": "Not found - Tool enum list not found",
7932
- "content": {
7933
- "application/json": {
7934
- "schema": {
7935
- "$ref": "#/components/schemas/Error"
7936
- }
7937
- }
7938
- }
7939
- },
7940
- "500": {
7941
- "description": "Internal server error - Something went wrong on the server",
7942
- "content": {
7943
- "application/json": {
7944
- "schema": {
7945
- "$ref": "#/components/schemas/Error"
7946
- }
7947
- }
7948
- }
7949
- }
7950
- }
7951
- }
7952
- },
7616
"/api/v3/toolkits/multi": {
7617
"post": {
7618
"summary": "Fetch multiple toolkits",
@@ -17064,13 +16727,299 @@
16727
},
16728
"description": "List of files in the mount"
16729
},
17067
- "next_cursor": {
16730
+ "next_cursor": {
16731
+ "type": "string",
16732
+ "description": "Cursor for the next page of results. If absent, there are no more pages."
16733
+ }
16734
+ },
16735
+ "required": [
16736
+ "items"
16737
+ ]
16738
+ }
16739
+ }
16740
+ }
16741
+ },
16742
+ "400": {
16743
+ "description": "Bad request",
16744
+ "content": {
16745
+ "application/json": {
16746
+ "schema": {
16747
+ "$ref": "#/components/schemas/Error"
16748
+ }
16749
+ }
16750
+ }
16751
+ },
16752
+ "401": {
16753
+ "description": "Unauthorized",
16754
+ "content": {
16755
+ "application/json": {
16756
+ "schema": {
16757
+ "$ref": "#/components/schemas/Error"
16758
+ }
16759
+ }
16760
+ }
16761
+ },
16762
+ "404": {
16763
+ "description": "Session or mount not found",
16764
+ "content": {
16765
+ "application/json": {
16766
+ "schema": {
16767
+ "$ref": "#/components/schemas/Error"
16768
+ }
16769
+ }
16770
+ }
16771
+ },
16772
+ "500": {
16773
+ "description": "Internal server error",
16774
+ "content": {
16775
+ "application/json": {
16776
+ "schema": {
16777
+ "$ref": "#/components/schemas/Error"
16778
+ }
16779
+ }
16780
+ }
16781
+ }
16782
+ }
16783
+ }
16784
+ },
16785
+ "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/download_url": {
16786
+ "post": {
16787
+ "summary": "Create a presigned download URL for a mount file",
16788
+ "description": "Generates a presigned download URL for a file in a workbench session mount. Accepts a relative path within the mount.",
16789
+ "tags": [
16790
+ "Tool Router"
16791
+ ],
16792
+ "operationId": "postToolRouterSessionBySessionIdMountsByMountIdDownloadUrl",
16793
+ "security": [
16794
+ {
16795
+ "ApiKeyAuth": []
16796
+ },
16797
+ {
16798
+ "UserApiKeyAuth": []
16799
+ }
16800
+ ],
16801
+ "parameters": [
16802
+ {
16803
+ "schema": {
16804
+ "type": "string",
16805
+ "format": "toolRouterSessionId",
16806
+ "description": "The unique identifier of the tool router session",
16807
+ "example": "trs_123456789"
16808
+ },
16809
+ "required": true,
16810
+ "description": "The unique identifier of the tool router session",
16811
+ "name": "session_id",
16812
+ "in": "path"
16813
+ },
16814
+ {
16815
+ "schema": {
16816
+ "type": "string",
16817
+ "minLength": 1,
16818
+ "description": "ID of the storage mount",
16819
+ "example": "files"
16820
+ },
16821
+ "required": true,
16822
+ "description": "ID of the storage mount",
16823
+ "name": "mount_id",
16824
+ "in": "path"
16825
+ }
16826
+ ],
16827
+ "requestBody": {
16828
+ "content": {
16829
+ "application/json": {
16830
+ "schema": {
16831
+ "type": "object",
16832
+ "properties": {
16833
+ "mount_relative_path": {
16834
+ "type": "string",
16835
+ "minLength": 1,
16836
+ "description": "Relative file path within the mount",
16837
+ "example": "report.pdf"
16838
+ }
16839
+ },
16840
+ "required": [
16841
+ "mount_relative_path"
16842
+ ]
16843
+ }
16844
+ }
16845
+ }
16846
+ },
16847
+ "responses": {
16848
+ "201": {
16849
+ "description": "Download URL created successfully",
16850
+ "content": {
16851
+ "application/json": {
16852
+ "schema": {
16853
+ "type": "object",
16854
+ "properties": {
16855
+ "download_url": {
16856
+ "type": "string",
16857
+ "description": "Presigned download URL for the file"
16858
+ },
16859
+ "mount_relative_path": {
16860
+ "type": "string",
16861
+ "description": "Relative file path within the mount (e.g. \"report.pdf\")"
16862
+ },
16863
+ "sandbox_mount_prefix": {
16864
+ "type": "string",
16865
+ "description": "Absolute mount path inside the sandbox (e.g. /mnt/files)"
16866
+ },
16867
+ "expires_at": {
16868
+ "type": "string",
16869
+ "description": "ISO 8601 timestamp when the download URL expires"
16870
+ }
16871
+ },
16872
+ "required": [
16873
+ "download_url",
16874
+ "mount_relative_path",
16875
+ "sandbox_mount_prefix",
16876
+ "expires_at"
16877
+ ]
16878
+ }
16879
+ }
16880
+ }
16881
+ },
16882
+ "400": {
16883
+ "description": "Bad request",
16884
+ "content": {
16885
+ "application/json": {
16886
+ "schema": {
16887
+ "$ref": "#/components/schemas/Error"
16888
+ }
16889
+ }
16890
+ }
16891
+ },
16892
+ "401": {
16893
+ "description": "Unauthorized",
16894
+ "content": {
16895
+ "application/json": {
16896
+ "schema": {
16897
+ "$ref": "#/components/schemas/Error"
16898
+ }
16899
+ }
16900
+ }
16901
+ },
16902
+ "404": {
16903
+ "description": "Session or mount not found",
16904
+ "content": {
16905
+ "application/json": {
16906
+ "schema": {
16907
+ "$ref": "#/components/schemas/Error"
16908
+ }
16909
+ }
16910
+ }
16911
+ },
16912
+ "500": {
16913
+ "description": "Internal server error",
16914
+ "content": {
16915
+ "application/json": {
16916
+ "schema": {
16917
+ "$ref": "#/components/schemas/Error"
16918
+ }
16919
+ }
16920
+ }
16921
+ }
16922
+ }
16923
+ }
16924
+ },
16925
+ "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/upload_url": {
16926
+ "post": {
16927
+ "summary": "Create a presigned upload URL for a mount file",
16928
+ "description": "Generates a presigned upload URL for uploading a file to a workbench session mount. The caller should PUT the file content directly to the returned URL.",
16929
+ "tags": [
16930
+ "Tool Router"
16931
+ ],
16932
+ "operationId": "postToolRouterSessionBySessionIdMountsByMountIdUploadUrl",
16933
+ "security": [
16934
+ {
16935
+ "ApiKeyAuth": []
16936
+ },
16937
+ {
16938
+ "UserApiKeyAuth": []
16939
+ }
16940
+ ],
16941
+ "parameters": [
16942
+ {
16943
+ "schema": {
16944
+ "type": "string",
16945
+ "format": "toolRouterSessionId",
16946
+ "description": "The unique identifier of the tool router session",
16947
+ "example": "trs_123456789"
16948
+ },
16949
+ "required": true,
16950
+ "description": "The unique identifier of the tool router session",
16951
+ "name": "session_id",
16952
+ "in": "path"
16953
+ },
16954
+ {
16955
+ "schema": {
16956
+ "type": "string",
16957
+ "minLength": 1,
16958
+ "description": "ID of the storage mount",
16959
+ "example": "files"
16960
+ },
16961
+ "required": true,
16962
+ "description": "ID of the storage mount",
16963
+ "name": "mount_id",
16964
+ "in": "path"
16965
+ }
16966
+ ],
16967
+ "requestBody": {
16968
+ "content": {
16969
+ "application/json": {
16970
+ "schema": {
16971
+ "type": "object",
16972
+ "properties": {
16973
+ "mount_relative_path": {
16974
+ "type": "string",
16975
+ "minLength": 1,
16976
+ "description": "Supports subdirectories (e.g. \"data/output.csv\", \"images/charts/chart.png\")",
16977
+ "example": "report.pdf"
16978
+ },
16979
+ "mimetype": {
16980
+ "type": "string",
16981
+ "minLength": 1,
16982
+ "description": "MIME type of the file being uploaded",
16983
+ "example": "application/pdf"
16984
+ }
16985
+ },
16986
+ "required": [
16987
+ "mount_relative_path"
16988
+ ]
16989
+ }
16990
+ }
16991
+ }
16992
+ },
16993
+ "responses": {
16994
+ "201": {
16995
+ "description": "Upload URL created successfully",
16996
+ "content": {
16997
+ "application/json": {
16998
+ "schema": {
16999
+ "type": "object",
17000
+ "properties": {
17001
+ "upload_url": {
17002
+ "type": "string",
17003
+ "description": "Presigned upload URL — PUT the file content here"
17004
+ },
17005
+ "mount_relative_path": {
17006
"type": "string",
17069
- "description": "Cursor for the next page of results. If absent, there are no more pages."
17007
+ "description": "Relative file path within the mount (e.g. \"report.pdf\")"
17008
+ },
17009
+ "sandbox_mount_prefix": {
17010
+ "type": "string",
17011
+ "description": "Absolute mount path inside the sandbox (e.g. /mnt/files)"
17012
+ },
17013
+ "expires_at": {
17014
+ "type": "string",
17015
+ "description": "ISO 8601 timestamp when the upload URL expires"
17016
}
17017
},
17018
"required": [
17073
- "items"
17019
+ "upload_url",
17020
+ "mount_relative_path",
17021
+ "sandbox_mount_prefix",
17022
+ "expires_at"
17023
]
17024
}
17025
}
@@ -17119,14 +17068,14 @@
17068
}
17069
}
17070
},
17122
- "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/download_url": {
17071
+ "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/delete": {
17072
"post": {
17124
- "summary": "Create a presigned download URL for a mount file",
17125
- "description": "Generates a presigned download URL for a file in a workbench session mount. Accepts a relative path within the mount.",
17073
+ "summary": "Delete a file from a session mount",
17074
+ "description": "Deletes a file from a workbench session storage mount. S3 delete is idempotent — deleting a non-existent file succeeds silently.",
17075
"tags": [
17076
"Tool Router"
17077
],
17129
- "operationId": "postToolRouterSessionBySessionIdMountsByMountIdDownloadUrl",
17078
+ "operationId": "postToolRouterSessionBySessionIdMountsByMountIdDelete",
17079
"security": [
17080
{
17081
"ApiKeyAuth": []
@@ -17182,35 +17131,25 @@
17131
}
17132
},
17133
"responses": {
17185
- "201": {
17186
- "description": "Download URL created successfully",
17134
+ "200": {
17135
+ "description": "File deleted successfully",
17136
"content": {
17137
"application/json": {
17138
"schema": {
17139
"type": "object",
17140
"properties": {
17192
- "download_url": {
17193
- "type": "string",
17194
- "description": "Presigned download URL for the file"
17195
- },
17141
"mount_relative_path": {
17142
"type": "string",
17198
- "description": "Relative file path within the mount (e.g. \"report.pdf\")"
17143
+ "description": "Relative file path that was deleted"
17144
},
17145
"sandbox_mount_prefix": {
17146
"type": "string",
17147
"description": "Absolute mount path inside the sandbox (e.g. /mnt/files)"
17203
- },
17204
- "expires_at": {
17205
- "type": "string",
17206
- "description": "ISO 8601 timestamp when the download URL expires"
17148
}
17149
},
17150
"required": [
17210
- "download_url",
17151
"mount_relative_path",
17212
- "sandbox_mount_prefix",
17213
- "expires_at"
17152
+ "sandbox_mount_prefix"
17153
]
17154
}
17155
}
@@ -17226,28 +17165,231 @@
17165
}
17166
}
17167
},
17229
- "401": {
17230
- "description": "Unauthorized",
17231
- "content": {
17232
- "application/json": {
17233
- "schema": {
17234
- "$ref": "#/components/schemas/Error"
17235
- }
17236
- }
17237
- }
17168
+ "401": {
17169
+ "description": "Unauthorized",
17170
+ "content": {
17171
+ "application/json": {
17172
+ "schema": {
17173
+ "$ref": "#/components/schemas/Error"
17174
+ }
17175
+ }
17176
+ }
17177
+ },
17178
+ "404": {
17179
+ "description": "Session or mount not found",
17180
+ "content": {
17181
+ "application/json": {
17182
+ "schema": {
17183
+ "$ref": "#/components/schemas/Error"
17184
+ }
17185
+ }
17186
+ }
17187
+ },
17188
+ "500": {
17189
+ "description": "Internal server error",
17190
+ "content": {
17191
+ "application/json": {
17192
+ "schema": {
17193
+ "$ref": "#/components/schemas/Error"
17194
+ }
17195
+ }
17196
+ }
17197
+ }
17198
+ }
17199
+ }
17200
+ },
17201
+ "/api/v3.1/tools": {
17202
+ "get": {
17203
+ "summary": "List available tools",
17204
+ "description": "Retrieve a paginated list of available tools with comprehensive filtering, sorting and search capabilities. Use query parameters to narrow down results by toolkit, tags, or search terms.",
17205
+ "tags": [
17206
+ "Tools"
17207
+ ],
17208
+ "operationId": "getV3_1Tools",
17209
+ "security": [
17210
+ {
17211
+ "ApiKeyAuth": []
17212
+ },
17213
+ {
17214
+ "UserApiKeyAuth": []
17215
+ }
17216
+ ],
17217
+ "parameters": [
17218
+ {
17219
+ "schema": {
17220
+ "type": "string"
17221
+ },
17222
+ "required": false,
17223
+ "description": "The slug of the toolkit to filter by",
17224
+ "in": "query",
17225
+ "name": "toolkit_slug"
17226
+ },
17227
+ {
17228
+ "schema": {
17229
+ "type": "string"
17230
+ },
17231
+ "required": false,
17232
+ "description": "Comma-separated list of specific tool slugs to retrieve (overrides other filters)",
17233
+ "in": "query",
17234
+ "name": "tool_slugs"
17235
+ },
17236
+ {
17237
+ "schema": {
17238
+ "oneOf": [
17239
+ {
17240
+ "type": "string"
17241
+ },
17242
+ {
17243
+ "type": "array",
17244
+ "items": {
17245
+ "type": "string"
17246
+ }
17247
+ }
17248
+ ]
17249
+ },
17250
+ "required": false,
17251
+ "description": "Comma-separated list of auth config IDs to filter tools by",
17252
+ "in": "query",
17253
+ "name": "auth_config_ids"
17254
+ },
17255
+ {
17256
+ "schema": {
17257
+ "type": "string",
17258
+ "enum": [
17259
+ "true",
17260
+ "false"
17261
+ ]
17262
+ },
17263
+ "required": false,
17264
+ "description": "Filter to only show important/featured tools (set to \"true\" to enable)",
17265
+ "in": "query",
17266
+ "name": "important"
17267
+ },
17268
+ {
17269
+ "schema": {
17270
+ "type": "array",
17271
+ "items": {
17272
+ "type": "string"
17273
+ }
17274
+ },
17275
+ "required": false,
17276
+ "description": "Filter tools by one or more tags (can be specified multiple times)",
17277
+ "in": "query",
17278
+ "name": "tags"
17279
+ },
17280
+ {
17281
+ "schema": {
17282
+ "type": "array",
17283
+ "nullable": true,
17284
+ "items": {
17285
+ "type": "string"
17286
+ },
17287
+ "description": "Filter tools by one or more scopes (can be specified multiple times)"
17288
+ },
17289
+ "required": false,
17290
+ "description": "Array of scopes to filter tools by)",
17291
+ "name": "scopes",
17292
+ "in": "query"
17293
+ },
17294
+ {
17295
+ "schema": {
17296
+ "type": "string"
17297
+ },
17298
+ "required": false,
17299
+ "description": "Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.",
17300
+ "in": "query",
17301
+ "name": "query"
17302
+ },
17303
+ {
17304
+ "schema": {
17305
+ "type": "string"
17306
+ },
17307
+ "required": false,
17308
+ "description": "Deprecated: use \"query\" instead. Free-text search query to find tools by name, description, or functionality.",
17309
+ "in": "query",
17310
+ "name": "search",
17311
+ "deprecated": true
17312
+ },
17313
+ {
17314
+ "schema": {
17315
+ "type": "boolean",
17316
+ "default": true
17317
+ },
17318
+ "required": false,
17319
+ "description": "Include deprecated tools in the response",
17320
+ "in": "query",
17321
+ "name": "include_deprecated"
17322
+ },
17323
+ {
17324
+ "schema": {
17325
+ "oneOf": [
17326
+ {
17327
+ "type": "null"
17328
+ },
17329
+ {
17330
+ "type": "string"
17331
+ },
17332
+ {
17333
+ "type": "object",
17334
+ "additionalProperties": {
17335
+ "type": "string"
17336
+ },
17337
+ "description": "Object representation of parsed bracket notation"
17338
+ }
17339
+ ]
17340
+ },
17341
+ "required": false,
17342
+ "description": "Toolkit version specification. Use \"latest\" for latest versions or bracket notation for specific versions per toolkit.",
17343
+ "in": "query",
17344
+ "name": "toolkit_versions",
17345
+ "examples": {
17346
+ "latest_version": {
17347
+ "summary": "Latest version for all toolkits",
17348
+ "value": "latest"
17349
+ },
17350
+ "bracket_notation": {
17351
+ "summary": "Specific versions using bracket notation",
17352
+ "value": "Use: toolkit_versions[gmail]=20250930_00&toolkit_versions[slack]=20250929_00"
17353
+ },
17354
+ "null_value": {
17355
+ "summary": "No version specified (uses 00000000_00)",
17356
+ "value": null
17357
+ }
17358
+ }
17359
+ },
17360
+ {
17361
+ "schema": {
17362
+ "type": "number",
17363
+ "nullable": true
17364
+ },
17365
+ "required": false,
17366
+ "description": "Number of items per page, max allowed is 1000",
17367
+ "name": "limit",
17368
+ "in": "query"
17369
},
17239
- "404": {
17240
- "description": "Session or mount not found",
17370
+ {
17371
+ "schema": {
17372
+ "type": "string"
17373
+ },
17374
+ "required": false,
17375
+ "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
17376
+ "name": "cursor",
17377
+ "in": "query"
17378
+ }
17379
+ ],
17380
+ "responses": {
17381
+ "200": {
17382
+ "description": "Successfully retrieved tools list with pagination information",
17383
"content": {
17384
"application/json": {
17385
"schema": {
17244
- "$ref": "#/components/schemas/Error"
17386
+ "$ref": "#/components/schemas/ToolsPaginated"
17387
}
17388
}
17389
}
17390
},
17249
- "500": {
17250
- "description": "Internal server error",
17391
+ "400": {
17392
+ "description": "Bad request - Invalid query parameters",
17393
"content": {
17394
"application/json": {
17395
"schema": {
@@ -17255,115 +17397,19 @@
17397
}
17398
}
17399
}
17258
- }
17259
- }
17260
- }
17261
- },
17262
- "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/upload_url": {
17263
- "post": {
17264
- "summary": "Create a presigned upload URL for a mount file",
17265
- "description": "Generates a presigned upload URL for uploading a file to a workbench session mount. The caller should PUT the file content directly to the returned URL.",
17266
- "tags": [
17267
- "Tool Router"
17268
- ],
17269
- "operationId": "postToolRouterSessionBySessionIdMountsByMountIdUploadUrl",
17270
- "security": [
17271
- {
17272
- "ApiKeyAuth": []
17273
- },
17274
- {
17275
- "UserApiKeyAuth": []
17276
- }
17277
- ],
17278
- "parameters": [
17279
- {
17280
- "schema": {
17281
- "type": "string",
17282
- "format": "toolRouterSessionId",
17283
- "description": "The unique identifier of the tool router session",
17284
- "example": "trs_123456789"
17285
- },
17286
- "required": true,
17287
- "description": "The unique identifier of the tool router session",
17288
- "name": "session_id",
17289
- "in": "path"
17400
},
17291
- {
17292
- "schema": {
17293
- "type": "string",
17294
- "minLength": 1,
17295
- "description": "ID of the storage mount",
17296
- "example": "files"
17297
- },
17298
- "required": true,
17299
- "description": "ID of the storage mount",
17300
- "name": "mount_id",
17301
- "in": "path"
17302
- }
17303
- ],
17304
- "requestBody": {
17305
- "content": {
17306
- "application/json": {
17307
- "schema": {
17308
- "type": "object",
17309
- "properties": {
17310
- "mount_relative_path": {
17311
- "type": "string",
17312
- "minLength": 1,
17313
- "description": "Supports subdirectories (e.g. \"data/output.csv\", \"images/charts/chart.png\")",
17314
- "example": "report.pdf"
17315
- },
17316
- "mimetype": {
17317
- "type": "string",
17318
- "minLength": 1,
17319
- "description": "MIME type of the file being uploaded",
17320
- "example": "application/pdf"
17321
- }
17322
- },
17323
- "required": [
17324
- "mount_relative_path"
17325
- ]
17326
- }
17327
- }
17328
- }
17329
- },
17330
- "responses": {
17331
- "201": {
17332
- "description": "Upload URL created successfully",
17401
+ "401": {
17402
+ "description": "Unauthorized - Authentication credentials are missing or invalid",
17403
"content": {
17404
"application/json": {
17405
"schema": {
17336
- "type": "object",
17337
- "properties": {
17338
- "upload_url": {
17339
- "type": "string",
17340
- "description": "Presigned upload URL — PUT the file content here"
17341
- },
17342
- "mount_relative_path": {
17343
- "type": "string",
17344
- "description": "Relative file path within the mount (e.g. \"report.pdf\")"
17345
- },
17346
- "sandbox_mount_prefix": {
17347
- "type": "string",
17348
- "description": "Absolute mount path inside the sandbox (e.g. /mnt/files)"
17349
- },
17350
- "expires_at": {
17351
- "type": "string",
17352
- "description": "ISO 8601 timestamp when the upload URL expires"
17353
- }
17354
- },
17355
- "required": [
17356
- "upload_url",
17357
- "mount_relative_path",
17358
- "sandbox_mount_prefix",
17359
- "expires_at"
17360
- ]
17406
+ "$ref": "#/components/schemas/Error"
17407
}
17408
}
17409
}
17410
},
17365
- "400": {
17366
- "description": "Bad request",
17411
+ "403": {
17412
+ "description": "Forbidden - User does not have permission to access tools",
17413
"content": {
17414
"application/json": {
17415
"schema": {
@@ -17372,8 +17418,8 @@
17418
}
17419
}
17420
},
17375
- "401": {
17376
- "description": "Unauthorized",
17421
+ "404": {
17422
+ "description": "Not found - The requested resource was not found",
17423
"content": {
17424
"application/json": {
17425
"schema": {
@@ -17382,8 +17428,8 @@
17428
}
17429
}
17430
},
17385
- "404": {
17386
- "description": "Session or mount not found",
17431
+ "429": {
17432
+ "description": "Too many requests - Rate limit exceeded",
17433
"content": {
17434
"application/json": {
17435
"schema": {
@@ -17393,7 +17439,7 @@
17439
}
17440
},
17441
"500": {
17396
- "description": "Internal server error",
17442
+ "description": "Internal server error - Something went wrong on the server",
17443
"content": {
17444
"application/json": {
17445
"schema": {
@@ -17405,14 +17451,14 @@
17451
}
17452
}
17453
},
17408
- "/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/delete": {
17409
- "post": {
17410
- "summary": "Delete a file from a session mount",
17411
- "description": "Deletes a file from a workbench session storage mount. S3 delete is idempotent — deleting a non-existent file succeeds silently.",
17454
+ "/api/v3.1/tools/enum": {
17455
+ "get": {
17456
+ "summary": "Get tool enum list",
17457
+ "description": "Retrieve a list of all available tool enumeration values (tool slugs) from latest version of each toolkit. This endpoint returns a comma-separated string of tool slugs that can be used in other API calls.",
17458
"tags": [
17413
- "Tool Router"
17459
+ "Tools"
17460
],
17415
- "operationId": "postToolRouterSessionBySessionIdMountsByMountIdDelete",
17461
+ "operationId": "getV3_1ToolsEnum",
17462
"security": [
17463
{
17464
"ApiKeyAuth": []
@@ -17421,79 +17467,23 @@
17467
"UserApiKeyAuth": []
17468
}
17469
],
17424
- "parameters": [
17425
- {
17426
- "schema": {
17427
- "type": "string",
17428
- "format": "toolRouterSessionId",
17429
- "description": "The unique identifier of the tool router session",
17430
- "example": "trs_123456789"
17431
- },
17432
- "required": true,
17433
- "description": "The unique identifier of the tool router session",
17434
- "name": "session_id",
17435
- "in": "path"
17436
- },
17437
- {
17438
- "schema": {
17439
- "type": "string",
17440
- "minLength": 1,
17441
- "description": "ID of the storage mount",
17442
- "example": "files"
17443
- },
17444
- "required": true,
17445
- "description": "ID of the storage mount",
17446
- "name": "mount_id",
17447
- "in": "path"
17448
- }
17449
- ],
17450
- "requestBody": {
17451
- "content": {
17452
- "application/json": {
17453
- "schema": {
17454
- "type": "object",
17455
- "properties": {
17456
- "mount_relative_path": {
17457
- "type": "string",
17458
- "minLength": 1,
17459
- "description": "Relative file path within the mount",
17460
- "example": "report.pdf"
17461
- }
17462
- },
17463
- "required": [
17464
- "mount_relative_path"
17465
- ]
17466
- }
17467
- }
17468
- }
17469
- },
17470
"responses": {
17471
"200": {
17472
- "description": "File deleted successfully",
17472
+ "description": "Successfully retrieved tool enum list",
17473
"content": {
17474
"application/json": {
17475
"schema": {
17476
- "type": "object",
17477
- "properties": {
17478
- "mount_relative_path": {
17479
- "type": "string",
17480
- "description": "Relative file path that was deleted"
17481
- },
17482
- "sandbox_mount_prefix": {
17483
- "type": "string",
17484
- "description": "Absolute mount path inside the sandbox (e.g. /mnt/files)"
17485
- }
17476
+ "type": "array",
17477
+ "items": {
17478
+ "type": "string"
17479
},
17487
- "required": [
17488
- "mount_relative_path",
17489
- "sandbox_mount_prefix"
17490
- ]
17480
+ "description": "JSON string containing all tool enum values from latest version of each toolkit"
17481
}
17482
}
17483
}
17484
},
17485
"400": {
17496
- "description": "Bad request",
17486
+ "description": "Bad request - Invalid request parameters",
17487
"content": {
17488
"application/json": {
17489
"schema": {
@@ -17503,7 +17493,17 @@
17493
}
17494
},
17495
"401": {
17506
- "description": "Unauthorized",
17496
+ "description": "Unauthorized - Authentication credentials are missing or invalid",
17497
+ "content": {
17498
+ "application/json": {
17499
+ "schema": {
17500
+ "$ref": "#/components/schemas/Error"
17501
+ }
17502
+ }
17503
+ }
17504
+ },
17505
+ "403": {
17506
+ "description": "Forbidden - User does not have permission to access tool enums",
17507
"content": {
17508
"application/json": {
17509
"schema": {
@@ -17513,7 +17513,7 @@
17513
}
17514
},
17515
"404": {
17516
- "description": "Session or mount not found",
17516
+ "description": "Not found - Tool enum list not found",
17517
"content": {
17518
"application/json": {
17519
"schema": {
@@ -17523,7 +17523,7 @@
17523
}
17524
},
17525
"500": {
17526
- "description": "Internal server error",
17526
+ "description": "Internal server error - Something went wrong on the server",
17527
"content": {
17528
"application/json": {
17529
"schema": {