You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
2144
+
x-visibility: Preview
2145
+
parameters:
2146
+
- in: query
2147
+
name: toolNames
2148
+
description: Optional array of tool names to filter by
2149
+
required: false
2150
+
schema:
2151
+
type: array
2152
+
items:
2153
+
type: string
2154
+
style: form
2155
+
explode: false
2156
+
responses:
2157
+
"200":
2158
+
description: Successful operation
2159
+
content:
2160
+
application/json:
2161
+
schema:
2162
+
$ref: "#/components/schemas/ToolsListResponse"
2163
+
"400":
2164
+
description: Bad Request
2165
+
"401":
2166
+
description: Unauthorized
2167
+
"404":
2168
+
description: Not Found
2169
+
"429":
2170
+
description: Too Many Requests
2171
+
x-speakeasy-name-override: list
2172
+
x-speakeasy-group: client.tools
2173
+
/rest/api/v1/tools/call:
2174
+
post:
2175
+
summary: Execute the specified tool
2176
+
description: Execute the specified tool with provided parameters
2177
+
x-visibility: Preview
2178
+
requestBody:
2179
+
required: true
2180
+
content:
2181
+
application/json:
2182
+
schema:
2183
+
$ref: "#/components/schemas/ToolsCallRequest"
2184
+
responses:
2185
+
"200":
2186
+
description: Successful operation
2187
+
content:
2188
+
application/json:
2189
+
schema:
2190
+
$ref: "#/components/schemas/ToolsCallResponse"
2191
+
"400":
2192
+
description: Bad Request
2193
+
"401":
2194
+
description: Unauthorized
2195
+
"404":
2196
+
description: Not Found
2197
+
"429":
2198
+
description: Too Many Requests
2199
+
x-speakeasy-name-override: run
2200
+
x-speakeasy-group: client.tools
2137
2201
/api/index/v1/indexdocument:
2138
2202
post:
2139
2203
summary: Index document
@@ -3179,7 +3243,7 @@ paths:
3179
3243
get:
3180
3244
description: Lists policies with filtering.
3181
3245
summary: Lists policies.
3182
-
operationId: getpolicies
3246
+
operationId: listpolicies
3183
3247
x-visibility: Public
3184
3248
tags:
3185
3249
- Governance
@@ -7450,6 +7514,7 @@ components:
7450
7514
type: object
7451
7515
title: Input
7452
7516
description: The input to the agent.
7517
+
additionalProperties: true
7453
7518
messages:
7454
7519
type: array
7455
7520
items:
@@ -9828,6 +9893,117 @@ components:
9828
9893
- DEPRECATE
9829
9894
- UNVERIFY
9830
9895
description: The verification action requested.
9896
+
ToolParameter:
9897
+
type: object
9898
+
properties:
9899
+
type:
9900
+
type: string
9901
+
description: Parameter type (string, number, boolean, object, array)
9902
+
enum:
9903
+
- string
9904
+
- number
9905
+
- boolean
9906
+
- object
9907
+
- array
9908
+
name:
9909
+
type: string
9910
+
description: The name of the parameter
9911
+
description:
9912
+
type: string
9913
+
description: The description of the parameter
9914
+
isRequired:
9915
+
type: boolean
9916
+
description: Whether the parameter is required
9917
+
possibleValues:
9918
+
type: array
9919
+
description: The possible values for the parameter. Can contain only primitive values or arrays of primitive values.
9920
+
items:
9921
+
type: string
9922
+
items:
9923
+
type: object
9924
+
description: When type is 'array', this describes the structure of the item in the array.
9925
+
$ref: "#/components/schemas/ToolParameter"
9926
+
properties:
9927
+
type: object
9928
+
description: When type is 'object', this describes the structure of the object.
9929
+
additionalProperties:
9930
+
$ref: "#/components/schemas/ToolParameter"
9931
+
Tool:
9932
+
type: object
9933
+
properties:
9934
+
type:
9935
+
type: string
9936
+
description: Type of tool (READ, WRITE)
9937
+
enum:
9938
+
- READ
9939
+
- WRITE
9940
+
name:
9941
+
type: string
9942
+
description: Unique identifier for the tool
9943
+
displayName:
9944
+
type: string
9945
+
description: Human-readable name
9946
+
description:
9947
+
type: string
9948
+
description: LLM friendly description of the tool
9949
+
parameters:
9950
+
type: object
9951
+
description: The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
9952
+
additionalProperties:
9953
+
$ref: "#/components/schemas/ToolParameter"
9954
+
ToolsListResponse:
9955
+
type: object
9956
+
properties:
9957
+
tools:
9958
+
type: array
9959
+
items:
9960
+
$ref: "#/components/schemas/Tool"
9961
+
ToolsCallParameter:
9962
+
type: object
9963
+
required:
9964
+
- name
9965
+
- value
9966
+
properties:
9967
+
name:
9968
+
type: string
9969
+
description: The name of the parameter
9970
+
value:
9971
+
type: string
9972
+
description: The value of the parameter (for primitive types)
9973
+
items:
9974
+
type: array
9975
+
description: The value of the parameter (for array types)
9976
+
items:
9977
+
$ref: "#/components/schemas/ToolsCallParameter"
9978
+
properties:
9979
+
type: object
9980
+
description: The value of the parameter (for object types)
9981
+
additionalProperties:
9982
+
$ref: "#/components/schemas/ToolsCallParameter"
9983
+
ToolsCallRequest:
9984
+
type: object
9985
+
required:
9986
+
- name
9987
+
- parameters
9988
+
properties:
9989
+
name:
9990
+
type: string
9991
+
description: Required name of the tool to execute
9992
+
parameters:
9993
+
type: object
9994
+
description: The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
9995
+
additionalProperties:
9996
+
$ref: "#/components/schemas/ToolsCallParameter"
9997
+
ToolsCallResponse:
9998
+
type: object
9999
+
properties:
10000
+
rawResponse:
10001
+
additionalProperties: true
10002
+
type: object
10003
+
description: The raw response from the tool
10004
+
error:
10005
+
type: string
10006
+
description: The error message if applicable
9831
10007
IndexDocumentRequest:
9832
10008
type: object
9833
10009
description: Describes the request body of the /indexdocument API call
|`agent_id`|*Optional[str]*|:heavy_minus_sign:| The ID of the agent to run. |
11
-
|`input`|[Optional[models.AgentRunInput]](../models/agentruninput.md)|:heavy_minus_sign:| The input to the agent. |
11
+
|`input`|Dict[str, *Any*]|:heavy_minus_sign:| The input to the agent. |
12
12
|`messages`| List[[models.Message](../models/message.md)]|:heavy_minus_sign:| The messages to pass an input to the agent. |
13
13
|`status`|[Optional[models.AgentExecutionStatus]](../models/agentexecutionstatus.md)|:heavy_minus_sign:| The status of the run. One of 'error', 'success'. |
0 commit comments