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.
@@ -5533,12 +5533,21 @@ components:
5533
5533
additionalProperties: false
5534
5534
required:
5535
5535
- query
5536
+
example:
5537
+
query: quarterly planning 2026
5538
+
datasources:
5539
+
- confluence
5540
+
- google_drive
5541
+
filters:
5542
+
- field: type
5543
+
values:
5544
+
- spreadsheet
5545
+
- presentation
5536
5546
properties:
5537
5547
query:
5538
5548
type: string
5539
5549
description: |
5540
5550
The search query string. Supports inline operators such as `from:jane type:document app:confluence`. Inline operators are AND'd with structured `filters`.
5541
-
example: quarterly planning 2026
5542
5551
page_size:
5543
5552
type: integer
5544
5553
minimum: 1
@@ -5556,18 +5565,12 @@ components:
5556
5565
type: string
5557
5566
description: |
5558
5567
Restrict results to specific datasources. Requests must not specify both `datasources` and `datasource_instances`.
5559
-
example:
5560
-
- confluence
5561
-
- google_drive
5562
5568
datasource_instances:
5563
5569
type: array
5564
5570
items:
5565
5571
type: string
5566
5572
description: |
5567
5573
Restrict results to specific datasource instances. Values are datasource instance identifiers returned by `GET /api/search/filters`. Requests must not specify both `datasources` and `datasource_instances`.
5568
-
example:
5569
-
- slack_acme
5570
-
- slack_eu
5571
5574
filters:
5572
5575
type: array
5573
5576
items:
@@ -9713,6 +9716,127 @@ components:
9713
9716
additionalProperties:
9714
9717
$ref: '#/components/schemas/WriteActionParameter'
9715
9718
description: Parameters supported by the tool.
9719
+
ServerToolBase:
9720
+
type: object
9721
+
properties:
9722
+
requestType:
9723
+
type: string
9724
+
enum:
9725
+
- EXECUTION
9726
+
- AUTHENTICATION_SUGGESTION
9727
+
- VOTE_SUGGESTION
9728
+
description: The type of request made to the user.
9729
+
x-enumDescriptions:
9730
+
EXECUTION: Request for approving execution of the tool.
9731
+
AUTHENTICATION_SUGGESTION: Request for authenticating to a tool, provided as a (tool) suggestion.
9732
+
VOTE_SUGGESTION: Suggestion to vote for enabling an available-but-not-enabled tool.
9733
+
x-speakeasy-enum-descriptions:
9734
+
EXECUTION: Request for approving execution of the tool.
9735
+
AUTHENTICATION_SUGGESTION: Request for authenticating to a tool, provided as a (tool) suggestion.
9736
+
VOTE_SUGGESTION: Suggestion to vote for enabling an available-but-not-enabled tool.
9737
+
requestId:
9738
+
type: string
9739
+
description: Unique identifier for this request.
9740
+
required:
9741
+
- toolType
9742
+
- requestType
9743
+
- requestId
9744
+
x-visibility: Preview
9745
+
x-glean-experimental:
9746
+
id: 4e3ee791-45e0-4125-845f-4b7701aa983c
9747
+
introduced: "2026-07-02"
9748
+
ActionPreview:
9749
+
properties:
9750
+
markdown:
9751
+
type: string
9752
+
description: Markdown preview describing what the action will do.
9753
+
description:
9754
+
type: string
9755
+
description: Short summary of what this specific tool invocation will do.
9756
+
description: Preview information for an action being executed.
9757
+
ServerToolRequest:
9758
+
allOf:
9759
+
- $ref: '#/components/schemas/ServerToolBase'
9760
+
- type: object
9761
+
properties:
9762
+
toolDisplayName:
9763
+
type: string
9764
+
description: Human-readable display name for the tool.
9765
+
serverId:
9766
+
type: string
9767
+
description: |
9768
+
Unique identifier of the tool server. Use with GET /tool-servers/{serverId}/auth
9769
+
to resolve display information and authentication status.
9770
+
toolCta:
9771
+
type: string
9772
+
description: Custom call-to-action (CTA) verb for the approval button (e.g., "Create", "Update", "Send").
9773
+
actionPreview:
9774
+
$ref: '#/components/schemas/ActionPreview'
9775
+
description: Preview information for this tool request.
9776
+
required:
9777
+
- toolName
9778
+
x-visibility: Preview
9779
+
x-glean-experimental:
9780
+
id: 8544e887-4569-4b14-bde0-d1be9e90dbc3
9781
+
introduced: "2026-07-02"
9782
+
AuthContext:
9783
+
type: object
9784
+
properties:
9785
+
serverId:
9786
+
type: string
9787
+
description: ID of the MCP server (populated when toolType is MCP).
9788
+
description: |
9789
+
Context for authentication responses, containing identifiers for the entity being authenticated.
9790
+
x-visibility: Preview
9791
+
x-glean-experimental:
9792
+
id: a7c1d3e5-9f42-4b8a-b6e0-2d4f8a1c3e5b
9793
+
introduced: "2026-07-09"
9794
+
ServerToolResponse:
9795
+
allOf:
9796
+
- $ref: '#/components/schemas/ServerToolBase'
9797
+
- type: object
9798
+
properties:
9799
+
isGranted:
9800
+
type: boolean
9801
+
description: Whether tool request is granted (indicates approval for execution, or completion for auth).
9802
+
grantScope:
9803
+
type: string
9804
+
enum:
9805
+
- CURRENT_REQUEST
9806
+
- CURRENT_SESSION
9807
+
- ALWAYS
9808
+
description: |
9809
+
Scope of the approval grant. Only applicable when isGranted is true and requestType is EXECUTION.
9810
+
default: CURRENT_REQUEST
9811
+
x-enumDescriptions:
9812
+
CURRENT_REQUEST: Approve only the current tool request. Future tool execution requests still require approval.
9813
+
CURRENT_SESSION: Approve the current tool request and auto-approve all future same tool requests in this chat session.
9814
+
ALWAYS: Approve the current tool request and auto-approve all future same tool requests across all chat sessions.
9815
+
x-speakeasy-enum-descriptions:
9816
+
CURRENT_REQUEST: Approve only the current tool request. Future tool execution requests still require approval.
9817
+
CURRENT_SESSION: Approve the current tool request and auto-approve all future same tool requests in this chat session.
9818
+
ALWAYS: Approve the current tool request and auto-approve all future same tool requests across all chat sessions.
9819
+
authContext:
9820
+
$ref: '#/components/schemas/AuthContext'
9821
+
description: Context for AUTHENTICATION_SUGGESTION responses. Required when requestType is AUTHENTICATION_SUGGESTION.
9822
+
description: |
9823
+
Response to a server tool request. The applicable fields depend on requestType:
- authContext: contains serverId or actionPackId for identifying the authenticated entity
9832
+
- reason: optional explanation for skip
9833
+
9834
+
For VOTE_SUGGESTION requests:
9835
+
- voted: whether the user voted for this tool
9836
+
x-visibility: Preview
9837
+
x-glean-experimental:
9838
+
id: 3eae3ee7-2c06-4027-be14-98260a3ce608
9839
+
introduced: "2026-07-02"
9716
9840
ChatMessageFragment:
9717
9841
allOf:
9718
9842
- $ref: '#/components/schemas/Result'
@@ -9732,6 +9856,12 @@ components:
9732
9856
citation:
9733
9857
$ref: '#/components/schemas/ChatMessageCitation'
9734
9858
description: Inline citation.
9859
+
serverToolRequest:
9860
+
$ref: '#/components/schemas/ServerToolRequest'
9861
+
description: request to run a tool on server.
9862
+
serverToolResponse:
9863
+
$ref: '#/components/schemas/ServerToolResponse'
9864
+
description: response corresponding to the server tool request.
9735
9865
description: Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation, followupRoutingSuggestion or file.
0 commit comments