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.
@@ -90,6 +90,7 @@ paths:
90
90
name: agent_id
91
91
description: ID of the agent to retrieve.
92
92
required: true
93
+
example: "{agent_id}"
93
94
schema:
94
95
type: string
95
96
minLength: 1
@@ -134,6 +135,7 @@ paths:
134
135
name: agent_id
135
136
description: ID of the agent whose schemas should be retrieved.
136
137
required: true
138
+
example: "{agent_id}"
137
139
schema:
138
140
type: string
139
141
minLength: 1
@@ -186,6 +188,7 @@ paths:
186
188
name: agent_id
187
189
description: ID of the agent to run.
188
190
required: true
191
+
example: "{agent_id}"
189
192
schema:
190
193
type: string
191
194
minLength: 1
@@ -255,7 +258,7 @@ paths:
255
258
- Chat
256
259
summary: Create a chat response
257
260
description: |
258
-
Run an assistant turn. Set `stream` to true to receive server-sent events; otherwise the response is a typed JSON response object.
261
+
Run an assistant turn. The default response is JSON. HTTP clients request server-sent events by setting `stream` to true in the JSON body. An `Accept: text/event-stream` header does not replace `stream`.
259
262
operationId: platform-chat-create
260
263
x-visibility: Public
261
264
x-glean-experimental:
@@ -586,6 +589,7 @@ paths:
586
589
in: path
587
590
required: true
588
591
description: Glean skill ID.
592
+
example: "{skill_id}"
589
593
schema:
590
594
type: string
591
595
minLength: 1
@@ -643,6 +647,7 @@ paths:
643
647
in: path
644
648
required: true
645
649
description: Glean skill ID.
650
+
example: "{skill_id}"
646
651
schema:
647
652
type: string
648
653
minLength: 1
@@ -685,6 +690,7 @@ paths:
685
690
in: path
686
691
required: true
687
692
description: Glean skill ID.
693
+
example: "{skill_id}"
688
694
schema:
689
695
type: string
690
696
minLength: 1
@@ -732,6 +738,7 @@ paths:
732
738
in: path
733
739
required: true
734
740
description: Glean skill ID.
741
+
example: "{skill_id}"
735
742
schema:
736
743
type: string
737
744
minLength: 1
@@ -785,6 +792,7 @@ paths:
785
792
in: path
786
793
required: true
787
794
description: ID of the GitHub-imported skill to sync.
795
+
example: "{skill_id}"
788
796
schema:
789
797
type: string
790
798
minLength: 1
@@ -836,6 +844,7 @@ paths:
836
844
in: path
837
845
required: true
838
846
description: Glean skill ID.
847
+
example: "{skill_id}"
839
848
schema:
840
849
type: string
841
850
minLength: 1
@@ -893,6 +902,7 @@ paths:
893
902
in: path
894
903
required: true
895
904
description: Glean skill ID.
905
+
example: "{skill_id}"
896
906
schema:
897
907
type: string
898
908
minLength: 1
@@ -955,13 +965,15 @@ paths:
955
965
in: path
956
966
required: true
957
967
description: Glean skill ID.
968
+
example: "{skill_id}"
958
969
schema:
959
970
type: string
960
971
minLength: 1
961
972
- name: version
962
973
in: path
963
974
required: true
964
975
description: Major version number.
976
+
example: 1
965
977
schema:
966
978
type: integer
967
979
minimum: 1
@@ -1009,13 +1021,15 @@ paths:
1009
1021
in: path
1010
1022
required: true
1011
1023
description: Glean skill ID.
1024
+
example: "{skill_id}"
1012
1025
schema:
1013
1026
type: string
1014
1027
minLength: 1
1015
1028
- name: version
1016
1029
in: path
1017
1030
required: true
1018
1031
description: Major version number.
1032
+
example: 1
1019
1033
schema:
1020
1034
type: integer
1021
1035
minimum: 1
@@ -1325,6 +1339,7 @@ paths:
1325
1339
name: trigger_id
1326
1340
description: ID of the trigger to retrieve.
1327
1341
required: true
1342
+
example: "{trigger_id}"
1328
1343
schema:
1329
1344
type: string
1330
1345
minLength: 1
@@ -1372,6 +1387,7 @@ paths:
1372
1387
name: trigger_id
1373
1388
description: ID of the trigger to update.
1374
1389
required: true
1390
+
example: "{trigger_id}"
1375
1391
schema:
1376
1392
type: string
1377
1393
minLength: 1
@@ -1426,6 +1442,7 @@ paths:
1426
1442
name: trigger_id
1427
1443
description: ID of the trigger to delete.
1428
1444
required: true
1445
+
example: "{trigger_id}"
1429
1446
schema:
1430
1447
type: string
1431
1448
minLength: 1
@@ -1469,6 +1486,7 @@ paths:
1469
1486
name: trigger_id
1470
1487
description: ID of the trigger whose events to search.
1471
1488
required: true
1489
+
example: "{trigger_id}"
1472
1490
schema:
1473
1491
type: string
1474
1492
minLength: 1
@@ -1585,6 +1603,7 @@ paths:
1585
1603
name: preset_id
1586
1604
description: ID of the preset to retrieve.
1587
1605
required: true
1606
+
example: "{preset_id}"
1588
1607
schema:
1589
1608
type: string
1590
1609
minLength: 1
@@ -1632,13 +1651,15 @@ paths:
1632
1651
name: preset_id
1633
1652
description: ID of the preset the input belongs to.
1634
1653
required: true
1654
+
example: "{preset_id}"
1635
1655
schema:
1636
1656
type: string
1637
1657
minLength: 1
1638
1658
- in: query
1639
1659
name: field
1640
1660
description: Field identifier of the input whose values to list.
1641
1661
required: true
1662
+
example: "{field}"
1642
1663
schema:
1643
1664
type: string
1644
1665
minLength: 1
@@ -1693,6 +1714,7 @@ paths:
1693
1714
name: preset_id
1694
1715
description: ID of the preset to preview.
1695
1716
required: true
1717
+
example: "{preset_id}"
1696
1718
schema:
1697
1719
type: string
1698
1720
minLength: 1
@@ -1737,7 +1759,7 @@ paths:
1737
1759
- Chat
1738
1760
summary: SDK-only logical operation. HTTP clients must call the base path; the URL fragment is not sent. Create a chat response
1739
1761
description: |
1740
-
SDK-only logical operation. HTTP clients must call the base path; the URL fragment is not sent. Run an assistant turn. Set `stream` to true to receive server-sent events; otherwise the response is a typed JSON response object.
1762
+
SDK-only logical operation. HTTP clients must call the base path; the URL fragment is not sent. Run an assistant turn. The default response is JSON. HTTP clients request server-sent events by setting `stream` to true in the JSON body. An `Accept: text/event-stream` header does not replace `stream`.
1741
1763
operationId: platform-chat-create-stream
1742
1764
x-visibility: Public
1743
1765
x-glean-experimental:
@@ -7293,7 +7315,7 @@ components:
7293
7315
stream:
7294
7316
type: boolean
7295
7317
description: |
7296
-
When true, respond with `text/event-stream`. When false or omitted, respond with `application/json`.
7318
+
When true, the HTTP response is `text/event-stream`. When false or omitted, the HTTP response is `application/json`.
7297
7319
default: false
7298
7320
store:
7299
7321
type: boolean
@@ -8279,14 +8301,6 @@ components:
8279
8301
- query
8280
8302
example:
8281
8303
query: quarterly planning 2026
8282
-
datasources:
8283
-
- confluence
8284
-
- google_drive
8285
-
filters:
8286
-
- field: type
8287
-
values:
8288
-
- spreadsheet
8289
-
- presentation
8290
8304
properties:
8291
8305
query:
8292
8306
type: string
@@ -8589,6 +8603,12 @@ components:
8589
8603
required:
8590
8604
- preset_id
8591
8605
- delivery
8606
+
example:
8607
+
preset_id: GITHUB_1
8608
+
inputs:
8609
+
repository: "{repository}"
8610
+
delivery:
8611
+
webhook_url: https://example.com/webhook
8592
8612
properties:
8593
8613
preset_id:
8594
8614
type: string
@@ -8760,6 +8780,11 @@ components:
8760
8780
type: object
8761
8781
additionalProperties: false
8762
8782
description: Partial update. Only the supplied fields are changed.
0 commit comments