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
In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
@@ -22,7 +22,7 @@ info:
22
22
These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
summary: Create an agent run and stream the response
918
-
description: Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
918
+
description: "Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object."
919
919
operationId: createAndStreamRun
920
920
x-visibility: Preview
921
921
requestBody:
@@ -979,7 +979,7 @@ paths:
979
979
tags:
980
980
- Agents
981
981
summary: Create an agent run and wait for the response
982
-
description: Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
982
+
description: "Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object."
983
983
operationId: createAndWaitRun
984
984
x-visibility: Preview
985
985
requestBody:
@@ -8039,7 +8039,7 @@ components:
8039
8039
- type
8040
8040
title: MessageTextBlock
8041
8041
AgentRunCreate:
8042
-
description: Payload for creating a run.
8042
+
description: "Payload for creating a run. **Important**: If the agent uses an input form trigger, the `input` field is required and must include all fields defined in the form schema. Even fields marked as optional in the UI must be included in the request—use an empty string (`\"\"`) for optional fields without values. Omitting required form fields will result in a 500 error."
8043
8043
type: object
8044
8044
required:
8045
8045
- agent_id
@@ -8051,7 +8051,7 @@ components:
8051
8051
input:
8052
8052
type: object
8053
8053
title: Input
8054
-
description: The input to the agent.
8054
+
description: The input to the agent. Required when the agent uses an input form trigger.
Payload for creating a run.**Important**: If the agent uses an input form trigger, the `input` field is required and must include all fields defined in the form schema. Even fields marked as optional in the UI must be included in the request—use an empty string (`""`) for optional fields without values. Omitting required form fields will result in a 500 error.
|`agentId`|*String*|:heavy_check_mark:| The ID of the agent to run. |
11
-
|`input`| Map\<String, *Object*> |:heavy_minus_sign:| The input to the agent. |
11
+
|`input`| Map\<String, *Object*> |:heavy_minus_sign:| The input to the agent. Required when the agent uses an input form trigger.|
12
12
|`messages`| List\<[Message](../../models/components/Message.md)> |:heavy_minus_sign:| The messages to pass an input to the agent. |
13
13
|`metadata`| Map\<String, *Object*> |:heavy_minus_sign:| The metadata to pass to the agent. |
14
14
|`status`|[Optional\<AgentExecutionStatus>](../../models/components/AgentExecutionStatus.md)|:heavy_minus_sign:| The status of the run. One of 'error', 'success'. |
Payload for creating a run.**Important**: If the agent uses an input form trigger, the `input` field is required and must include all fields defined in the form schema. Even fields marked as optional in the UI must be included in the request—use an empty string (`""`) for optional fields without values. Omitting required form fields will result in a 500 error.
0 commit comments