@@ -2,7 +2,7 @@ openapi: 3.0.0
22info :
33 version : 0.9.0
44 title : Glean API
5- x-source-commit-sha : 56c08697ca3b6869022a262114e61f1385914425
5+ x-source-commit-sha : 716ecb2c8085d0f207f3bd1581d87c742c2338f1
66 description : |
77 # Introduction
88 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.
2222 These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
2323 x-logo :
2424 url : https://app.glean.com/images/glean-text2.svg
25- x-open-api-commit-sha : daa8736a6f0763faffd2c1079da8a42345536ed7
25+ x-open-api-commit-sha : d6d4b1c9fbabc1b8b326a1ef1c6a861b58625c3d
2626 x-speakeasy-name : ' Glean API'
2727servers :
2828 - url : https://{instance}-be.glean.com
@@ -3122,6 +3122,13 @@ paths:
31223122 description : Not Authorized
31233123 " 409 " :
31243124 description : Conflict
3125+ deprecated : true
3126+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-03, removal scheduled for 2026-10-15: Endpoint is deprecated"
3127+ x-glean-deprecated :
3128+ id : ce596f49-55c4-465e-bf3c-5a3a33906e1f
3129+ introduced : " 2026-02-03"
3130+ message : Endpoint is deprecated
3131+ removal : " 2026-10-15"
31253132 x-speakeasy-name-override : bulkIndex
31263133 x-speakeasy-group : indexing.people
31273134 /api/index/v1/indexemployeelist : {}
@@ -3676,6 +3683,89 @@ paths:
36763683 " 500 " :
36773684 description : Internal error
36783685 x-visibility : Public
3686+ /rest/api/v1/configure/datasources/{datasourceId}/instances/{instanceId} :
3687+ get :
3688+ operationId : getDatasourceInstanceConfiguration
3689+ summary : Get datasource instance configuration
3690+ description : |
3691+ Gets the greenlisted configuration values for a datasource instance. Returns only configuration keys that are exposed via the public API greenlist.
3692+ tags :
3693+ - Datasources
3694+ parameters :
3695+ - $ref : ' #/components/parameters/datasourceId'
3696+ - $ref : ' #/components/parameters/instanceId'
3697+ responses :
3698+ " 200 " :
3699+ description : OK
3700+ content :
3701+ application/json :
3702+ schema :
3703+ $ref : ' #/components/schemas/DatasourceConfigurationResponse'
3704+ " 400 " :
3705+ description : Invalid request
3706+ content :
3707+ application/json :
3708+ schema :
3709+ $ref : ' #/components/schemas/ErrorResponse'
3710+ " 401 " :
3711+ description : Not authorized
3712+ " 403 " :
3713+ description : Forbidden
3714+ content :
3715+ application/json :
3716+ schema :
3717+ $ref : ' #/components/schemas/ErrorResponse'
3718+ " 404 " :
3719+ description : Datasource instance not found
3720+ content :
3721+ application/json :
3722+ schema :
3723+ $ref : ' #/components/schemas/ErrorResponse'
3724+ x-visibility : Preview
3725+ patch :
3726+ operationId : updateDatasourceInstanceConfiguration
3727+ summary : Update datasource instance configuration
3728+ description : |
3729+ Updates the greenlisted configuration values for a datasource instance. Only configuration keys that are exposed via the public API greenlist may be set. Returns the full greenlisted configuration after the update is applied.
3730+ tags :
3731+ - Datasources
3732+ parameters :
3733+ - $ref : ' #/components/parameters/datasourceId'
3734+ - $ref : ' #/components/parameters/instanceId'
3735+ requestBody :
3736+ content :
3737+ application/json :
3738+ schema :
3739+ $ref : ' #/components/schemas/UpdateDatasourceConfigurationRequest'
3740+ required : true
3741+ responses :
3742+ " 200 " :
3743+ description : OK
3744+ content :
3745+ application/json :
3746+ schema :
3747+ $ref : ' #/components/schemas/DatasourceConfigurationResponse'
3748+ " 400 " :
3749+ description : Invalid request
3750+ content :
3751+ application/json :
3752+ schema :
3753+ $ref : ' #/components/schemas/ErrorResponse'
3754+ " 401 " :
3755+ description : Not authorized
3756+ " 403 " :
3757+ description : Forbidden
3758+ content :
3759+ application/json :
3760+ schema :
3761+ $ref : ' #/components/schemas/ErrorResponse'
3762+ " 404 " :
3763+ description : Datasource instance not found
3764+ content :
3765+ application/json :
3766+ schema :
3767+ $ref : ' #/components/schemas/ErrorResponse'
3768+ x-visibility : Preview
36793769 /rest/api/v1/chat#stream:
36803770 post :
36813771 tags :
@@ -6547,16 +6637,34 @@ components:
65476637 deprecated : true
65486638 description : The person that invited this person.
65496639 $ref : " #/components/schemas/Person"
6640+ x-glean-deprecated :
6641+ id : 1d3cd23f-9085-4378-b466-9bdc2e344a71
6642+ introduced : " 2026-02-05"
6643+ message : Use ChannelInviteInfo instead
6644+ removal : " 2026-10-15"
6645+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65506646 inviteTime :
65516647 deprecated : true
65526648 type : string
65536649 format : date-time
65546650 description : The time this person was invited in ISO format (ISO 8601).
6651+ x-glean-deprecated :
6652+ id : 2dc3f572-cded-483d-af07-fc9fc7fd0ae4
6653+ introduced : " 2026-02-05"
6654+ message : Use ChannelInviteInfo instead
6655+ removal : " 2026-10-15"
6656+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65556657 reminderTime :
65566658 deprecated : true
65576659 type : string
65586660 format : date-time
65596661 description : The time this person was reminded in ISO format (ISO 8601) if a reminder was sent.
6662+ x-glean-deprecated :
6663+ id : d02d58cf-eb90-45d0-ab90-f7a9d707ae3c
6664+ introduced : " 2026-02-05"
6665+ message : Use ChannelInviteInfo instead
6666+ removal : " 2026-10-15"
6667+ x-speakeasy-deprecation-message : " Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use ChannelInviteInfo instead"
65606668 ReadPermission :
65616669 description : Describes the read permission level that a user has for a specific feature
65626670 properties :
@@ -7944,12 +8052,6 @@ components:
79448052 chatSessionTrackingToken :
79458053 type : string
79468054 description : A token that is used to track the session.
7947- unauthorizedDatasourceInstances :
7948- type : array
7949- description : |
7950- Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth, aggregated across all tools invoked in this turn.
7951- items :
7952- $ref : " #/components/schemas/UnauthorizedDatasourceInstance"
79538055 DeleteChatsRequest :
79548056 required :
79558057 - ids
@@ -8107,9 +8209,12 @@ components:
81078209 description : Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
81088210 additionalProperties : true
81098211 ErrorResponse :
8110- type : string
8111- title : ErrorResponse
8112- description : Error message returned from the server
8212+ type : object
8213+ description : Error response returned for failed requests
8214+ properties :
8215+ message :
8216+ type : string
8217+ description : Client-facing error message describing what went wrong
81138218 ActionSummary :
81148219 type : object
81158220 description : Represents a minimal summary of an action.
@@ -8123,6 +8228,32 @@ components:
81238228 display_name :
81248229 type : string
81258230 description : The display name of the action.
8231+ type :
8232+ type : string
8233+ description : The type of tool - RETRIEVAL for read-only operations, ACTION for operations that modify data.
8234+ auth_type :
8235+ type : string
8236+ description : The authentication type required - OAUTH_USER, OAUTH_ADMIN, API_KEY, BASIC_AUTH, DWD (domain-wide delegation), or NONE.
8237+ write_action_type :
8238+ type : string
8239+ description : For write actions only - REDIRECT (client renders URL) or EXECUTION (external server call).
8240+ is_setup_finished :
8241+ type : boolean
8242+ description : Whether this action has been fully configured and validated.
8243+ x-includeEmpty : true
8244+ data_source :
8245+ type : string
8246+ description : |
8247+ Indicates the kind of knowledge a tool would access or modify.
8248+ Company knowledge:
8249+ - Glean search, and any native tools that derive from it (e.g., expert search, code search)
8250+ - Native federated tools to company data sources (e.g., outlook search)
8251+ World knowledge:
8252+ - Native tools that bring in public content (e.g., web browser)
8253+ - Platform action like bingwebsearch, geminiwebsearch, etc
8254+ Neutral knowledge:
8255+ - Native tools that don't access or modify content via APIs (e.g., file analyst, think)
8256+ - Platform read or write tools (creator has to determine their knowledge implications)
81268257 AgentSchemas :
81278258 properties :
81288259 agent_id :
@@ -9026,12 +9157,6 @@ components:
90269157 federatedSearchRateLimitError :
90279158 type : boolean
90289159 description : Indicates the federated search results could not be fetched due to rate limiting.
9029- unauthorizedDatasourceInstances :
9030- type : array
9031- description : |
9032- Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth.
9033- items :
9034- $ref : " #/components/schemas/UnauthorizedDatasourceInstance"
90359160 x-speakeasy-name-override : GleanDataError
90369161 ResultsResponse :
90379162 properties :
@@ -13217,6 +13342,49 @@ components:
1321713342 items :
1321813343 type : string
1321913344 description : List of field names to exclude from the export
13345+ ConfigurationValue :
13346+ type : object
13347+ properties :
13348+ value :
13349+ type : string
13350+ description : The configuration value as a string. Only one of value or valueList should be populated.
13351+ valueList :
13352+ type : array
13353+ items :
13354+ type : string
13355+ description : The configuration value as a list of strings. Only one of value or valueList should be populated.
13356+ description : A single configuration value, either a scalar or a list
13357+ ConfigurationValues :
13358+ type : object
13359+ additionalProperties :
13360+ $ref : ' #/components/schemas/ConfigurationValue'
13361+ description : A map from configuration key names to their values
13362+ DatasourceInstanceConfiguration :
13363+ type : object
13364+ properties :
13365+ values :
13366+ $ref : ' #/components/schemas/ConfigurationValues'
13367+ required :
13368+ - values
13369+ description : Configuration for a datasource instance
13370+ DatasourceConfigurationResponse :
13371+ type : object
13372+ properties :
13373+ configuration :
13374+ $ref : ' #/components/schemas/DatasourceInstanceConfiguration'
13375+ required :
13376+ - configuration
13377+ description : |
13378+ The greenlisted configuration values for a datasource instance. Only keys that are exposed via the public API greenlist are included.
13379+ UpdateDatasourceConfigurationRequest :
13380+ type : object
13381+ properties :
13382+ configuration :
13383+ $ref : ' #/components/schemas/DatasourceInstanceConfiguration'
13384+ required :
13385+ - configuration
13386+ description : |
13387+ Request to update greenlisted configuration values for a datasource instance. Only keys that are exposed via the public API greenlist may be set.
1322013388 ChatRequestStream :
1322113389 required :
1322213390 - messages
@@ -13274,6 +13442,22 @@ components:
1327413442 description : The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
1327513443 schema :
1327613444 type : integer
13445+ datasourceId :
13446+ name : datasourceId
13447+ in : path
13448+ description : The datasource type identifier (e.g. o365sharepoint)
13449+ required : true
13450+ schema :
13451+ type : string
13452+ example : o365sharepoint
13453+ instanceId :
13454+ name : instanceId
13455+ in : path
13456+ description : The datasource instance identifier
13457+ required : true
13458+ schema :
13459+ type : string
13460+ example : o365sharepoint_abc123
1327713461 responses :
1327813462 SuccessResponse :
1327913463 description : OK
0 commit comments