OBJECT

Query

Queries are used to retrieve data. If you're new to our API, try the me query to explore the information you have access to. Hit ctrl-space at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.

link GraphQL Schema definition

1type Query {
2
3# Retrieve a list of temporal data objects.
4# Example:
5# Request:
6# query {
7#
8# temporalDataObjects(
9#
10# organizationId: "35521"){
11#
12# records{name}
13#
14# offset
15#
16# limit
17#
18# count
19#
20# }
21# }
22# Response:
23# {
24#
25# "data": {
26#
27# "temporalDataObjects": {
28#
29# "records": [
30#
31# {
32#
33# "name": "example"
34#
35# },
36#
37# {
38#
39# "name": "example"
40#
41# },
42#
43# ],
44#
45# "offset": 0,
46#
47# "limit": 30,
48#
49# "count": 8
50#
51# }
52#
53# }
54# }
55#
56# Arguments
57# organizationId: Organization ID to get TDOs for. Defaults to
58# the user's own organization.
59# You can only retrieves content for your own organizations or organizations
60# that have shared data with yours.
61# applicationId: Application ID (an authorization construct that
62# maps directly to organization ID)
63# to get TDOs for. Defaults to the user's own organization.
64# id: Provide an ID to retrieve a single specific TDO.
65# offset: Provide an offset to skip to a certain element in the
66# result, for paging.
67# limit: Specify maximum number of results to retrieve in this
68# result. Page size.
69# sourceId: Optionally, specify a source ID. TDOs ingested from
70# this source will
71# be returned.
72# programId: Optionally, specify a program ID. TDOs belong to
73# this program will
74# be returned.
75# scheduledJobId: Optionally, specify a scheduled job ID. TDOs
76# ingested under this
77# scheduled job will be returned.
78# sampleMedia: Whether to retrieve only tdos with the specified
79# sampleMedia value
80# includePublic: Whether to retrieve public data that is not part
81# of the user's organization.
82# The default is false. Pass true to include public data in the result set.
83# dateTimeFilter: Provide optional filters against any date/time
84# field to filter
85# objects within a given time window.
86# Matching objects must meet all of the given conditions.
87# mentionId: Retrieve TDOs associated with the given mention
88temporalDataObjects(
89organizationId: ID,
90applicationId: ID,
91id: ID,
92offset: Int,
93limit: Int,
94sourceId: ID,
95programId: ID,
96scheduledJobId: ID,
97sampleMedia: Boolean,
98includePublic: Boolean,
99orderBy: TemporalDataObjectOrderBy,
100orderDirection: OrderDirection,
101dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
102mentionId: ID
103): TDOList
104
105# Retrieve a single temporal data object
106# Example:
107# Request:
108# query {
109#
110# temporalDataObject(
111#
112# id: 1570654874) {
113#
114# id
115#
116# name
117#
118# }
119# }
120# Response:
121# {
122#
123# "data": {
124#
125# "temporalDataObject": {
126#
127# "id": "1570654874",
128#
129# "name": "example"
130#
131# }
132#
133# }
134# }
135#
136# Arguments
137# id: the TDO ID
138temporalDataObject(id: ID!): TemporalDataObject
139
140# Retrieve a single Asset
141# Example:
142# Request:
143# query {
144#
145# asset(
146#
147# id: "1570654874_4hJtNKSUXD") {
148#
149# id
150#
151# name
152#
153# description
154#
155# }
156# }
157# Response:
158# {
159#
160# "data": {
161#
162# "asset": {
163#
164# "id": "1570654874_4hJtNKSUXD",
165#
166# "name": "example",
167#
168# "description": "example"
169#
170# }
171#
172# }
173# }
174#
175# Arguments
176# id: The asset ID
177asset(id: ID!): Asset
178
179# Retrieve multiple assets
180# Example:
181# Request:
182# query {
183#
184# assets(
185#
186# ids:["1570654874_4hJtNKSUXD"],
187#
188# contentTypes:[],
189#
190# assetTypes:["text"],
191#
192# sourceEngineIds:[],
193#
194# createdDateFilter:null,
195#
196# scrollId: null){
197#
198# assets{
199#
200# records{id}
201#
202# count
203#
204# }
205#
206# scrollId
207#
208# }
209# }
210# Response:
211# {
212#
213# "data": {
214#
215# "assets": {
216#
217# "assets": {
218#
219# "records": [],
220#
221# "count": 0
222#
223# },
224#
225# "scrollId": ""
226#
227# }
228#
229# }
230# }
231#
232# Arguments
233# ids: List of asset ids
234# contentTypes: Filter assets with content type included in the
235# list
236# See https://www.iana.org/assignments/media-types/media-types.xhtml
237# assetTypes: Filter assets with assetType included in the list
238# See https://docs.veritone.com/#/apis/tutorials/asset-types for list of values.
239# sourceEngineIds: Filter by source engine.
240# Not all assets have associated engineId, ex. media assets
241# createdDateFilter: Filter by created date
242# Note createdDateFilter.filter is required, but currently ignored
243# offset: Offset to skip to a certain element in the result, for
244# paging.
245# limit: Maximum number of results to retrieve in this result.
246# Page size.
247# scrollId: Use this field when sequentially iterating over the
248# assets list
249# This is required for when offset + limit exceeds 10000.
250# The value of this field is set from the response of the first/previous
251# assets query
252assets(
253ids: [ID!],
254contentTypes: [String!],
255assetTypes: [String!],
256sourceEngineIds: [String!],
257createdDateFilter: TemporalDataObjectDateTimeFilter,
258offset: Int,
259limit: Int,
260scrollId: String
261): AssetScrollList
262
263# Retrieve a single Widget
264# Example:
265# Request:
266# query {
267#
268# widget(
269#
270# id: "KOIFUT_rT_Oy3Ev9zfKT6A") {
271#
272# collection{
273#
274# id
275#
276# }
277#
278# }
279# }
280# Response:
281# {
282#
283# "data": {
284#
285# "widget": {
286#
287# "collection": {
288#
289# "id": "243625"
290#
291# }
292#
293# }
294#
295# }
296# }
297#
298# Arguments
299# id: The widget ID
300widget(id: ID!): Widget
301
302# Retrieve clone job entries
303# Example:
304# Request:
305# query {
306#
307# cloneRequests {
308#
309# records{
310#
311# id
312#
313# }
314#
315# }
316# }
317#
318# Response:
319#
320# {
321#
322# "data": {
323#
324# "cloneRequests": {
325#
326# "records": []
327#
328# }
329#
330# }
331# }
332#
333# Arguments
334# id: Provide an ID to retrieve a single specific clone request.
335# applicationId: Application ID to get clone requests for.
336# Defaults to the user's own application.
337cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
338
339# Retrieve most recent builds
340# Example:
341# Request:
342# query {
343#
344# recentBuilds(limit:2) {
345#
346# records{
347#
348# id
349#
350# name
351#
352# }
353#
354# }
355# }
356# Response:
357# {
358#
359# "data": {
360#
361# "recentBuilds": {
362#
363# "records": [
364#
365# {
366#
367# "id": "44193f81-57b4-47dd-9fe0-be95000776d9",
368#
369# "name": "example Version 5"
370#
371# },
372#
373# {
374#
375# "id": "bae12129-2724-40c3-abd2-6bb4021f21ae",
376#
377# "name": "example Version 4"
378#
379# }
380#
381# ]
382#
383# }
384#
385# }
386# }
387#
388# Arguments
389# buildStatus: Engine build status:
390# offset: Specify maximum number of results to retrieve in this
391# result. Page size.
392# limit: Specify maximum number of results to retrieve in this
393# result.
394# orderBy: Set order information on the query. Multiple fields
395# are supported.
396# Default order by modifiedDateTime desc
397recentBuilds(
398buildStatus: [BuildStatus!],
399offset: Int,
400limit: Int,
401orderBy: [EngineBuildOrderBy!]
402): BuildList
403
404# Retrieve engine overview
405# Example:
406# Request:
407# query {
408#
409# engineOverview {
410#
411# ready
412#
413# }
414# }
415#
416# Response:
417#
418# {
419#
420# "data": {
421#
422# "engineOverview": {
423#
424# "ready": 7
425#
426# }
427#
428# }
429# }
430engineOverview: EngineOverview
431
432# Retrieve engines
433# Example:
434# Request:
435# query {
436#
437# engines(limit:2) {
438#
439# records{
440#
441# id
442#
443# state
444#
445# }
446#
447# }
448# }
449# Response:
450# {
451#
452# "data": {
453#
454# "engines": {
455#
456# "records": [
457#
458# {
459#
460# "id": "2",
461#
462# "state": "pending"
463#
464# },
465#
466# {
467#
468# "id": "1",
469#
470# "state": "pending"
471#
472# }
473#
474# ]
475#
476# }
477#
478# }
479# }
480#
481# Arguments
482# id: Provide an ID to retrieve a single specific engine.
483# categoryId: Provide a category ID to filter by engine category.
484# category: provide a category name or ID to filter by engine
485# category
486# state: Provide a list of states to filter by engine state.
487# owned: If true, return only engines owned by the user's
488# organization.
489# libraryRequired: If true, return only engines that require a
490# library.
491# createsTDO: If true, return only engines that create their own
492# TDO.
493# If false, return only engines that do not create a TDO.
494# If not set, return either.
495# name: Provide a name, or part of a name, to search by engine
496# name
497# offset: Specify maximum number of results to retrieve in this
498# result. Page size.
499# limit: Specify maximum number of results to retrieve in this
500# result.
501# filter: Filters for engine attributes
502# orderBy: Provide a list of EngineSortField to sort by.
503# edgeVersion: Edge version to filter
504engines(
505id: ID,
506ids: [ID!],
507categoryId: String,
508category: String,
509state: [EngineState],
510owned: Boolean,
511libraryRequired: Boolean,
512createsTDO: Boolean,
513name: String,
514offset: Int,
515limit: Int,
516filter: EngineFilter,
517orderBy: [EngineSortField],
518edgeVersion: Int
519): EngineList
520
521# Retrieve a single engine by ID
522# Example:
523# Request:
524# query {
525#
526# engine(id:1) {
527#
528# name
529#
530# state
531#
532# }
533# }
534# Response:
535# {
536#
537# "data": {
538#
539# "engine": {
540#
541# "name": "example",
542#
543# "state": "pending"
544#
545# }
546#
547# }
548# }
549#
550# Arguments
551# id: Provide the engine ID
552engine(id: ID!): Engine
553
554# Retrieve an engine build
555# Example:
556# Request:
557# query {
558#
559# engineBuild(id: "2a1a1b58-6983-4002-b9ed-7b7f325f621a"){
560#
561# name
562#
563# engineId
564#
565# }
566# }
567#
568# Response:
569# {
570#
571# "data": {
572#
573# "engineBuild": {
574#
575# "name": "example Version 1",
576#
577# "engineId": "1"
578#
579# }
580#
581# }
582# }
583#
584# Arguments
585# id: Provide the build ID
586engineBuild(id: ID!): Build
587
588# Retrieve engine categories
589# Example:
590# Request:
591# query {
592#
593# engineCategories(limit:2) {
594#
595# records {
596#
597# id
598#
599# type {
600#
601# name
602#
603# }
604#
605# name
606#
607# }
608#
609# }
610# }
611# Response:
612# {
613#
614# "data": {
615#
616# "engineCategories": {
617#
618# "records": [
619#
620# {
621#
622# "id": "581dbb32-ea5b-4458-bd15-8094942345e3",
623#
624# "type": {
625#
626# "name": "Cognition"
627#
628# },
629#
630# "name": "Transcode"
631#
632# },
633#
634# {
635#
636# "id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182",
637#
638# "type": {
639#
640# "name": "Cognition"
641#
642# },
643#
644# "name": "Transcription"
645#
646# }
647#
648# ]
649#
650# }
651#
652# }
653# }
654#
655# Arguments
656# id: Provide an ID to retrieve a single specific engine
657# category.
658# ids: Provide multiple IDs to retrieve engine categories
659# name: Provide a name, or part of one, to search by category
660# name
661# type: Return all categories of an engine type
662# offset: Specify maximum number of results to retrieve in this
663# result. Page size.
664# limit: Specify maximum number of results to retrieve in this
665# result.
666engineCategories(
667id: ID,
668ids: [ID!],
669name: String,
670type: String,
671offset: Int,
672limit: Int
673): EngineCategoryList
674
675# Retrieve a specific engine category\
676# Example:
677# Request:
678# query {
679#
680# engineCategory(id: "581dbb32-ea5b-4458-bd15-8094942345e3") {
681#
682# name
683#
684# type{
685#
686# name
687#
688# }
689#
690# }
691# }
692# Response:
693# {
694#
695# "data": {
696#
697# "engineCategory": {
698#
699# "name": "Transcode",
700#
701# "type": {
702#
703# "name": "Cognition"
704#
705# }
706#
707# }
708#
709# }
710# }
711#
712# Arguments
713# id: Supply the ID of the engine category to retrieve
714engineCategory(id: ID!): EngineCategory
715
716# Retrieve jobs
717# Example:
718# Request:
719# query {
720#
721# jobs(limit:2) {
722#
723# records{
724#
725# id
726#
727# name
728#
729# }
730#
731# }
732# }
733# Response:
734# {
735#
736# "data": {
737#
738# "jobs": {
739#
740# "records": []
741#
742# }
743#
744# }
745# }
746#
747# Arguments
748# id: Provide an ID to retrieve a single specific job.
749# status: Provide a list of status strings to filter by status
750# offset: Provide an offset to skip to a certain element in the
751# result, for paging.
752# limit: Specify the maximum number of results to included in
753# this response, or page size.
754# applicationId: Provide an application ID to filter jobs for a
755# given application.
756# Defaults to the user's own application.
757# targetId: Provide a target ID to get the set of jobs running
758# against a particular TDO.
759# clusterId: Provide a cluster ID to get the jobs running on a
760# specific cluster
761# scheduledJobIds: Provide a list of scheduled job IDs to get
762# jobs associated with the scheduled jobs
763# hasScheduledJobId: Return only jobs that are (true) or are not
764# (false) associated with a scheduled job
765# orderBy: Provide sort information. The default is to sort by
766# createdDateTime descending.
767# dateTimeFilter: Filter by date/time field
768# applicationIds: Provide list of application IDs to filter jobs.
769# Defaults to the user's own application.
770# engineIds: Provide a list of engine IDs to filter for jobs
771# that contain tasks for the specified engines.
772# engineCategoryIds: Provide a list of engine category IDs to
773# filter for jobs
774# that contain tasks for engines in the specific categories.
775jobs(
776hasTargetTDO: Boolean,
777id: ID,
778status: [JobStatusFilter!],
779applicationStatus: String,
780offset: Int,
781limit: Int,
782applicationId: ID,
783targetId: ID,
784clusterId: ID,
785scheduledJobIds: [ID!],
786hasScheduledJobId: Boolean,
787orderBy: [JobSortField!],
788dateTimeFilter: [JobDateTimeFilter!],
789applicationIds: [ID],
790engineIds: [ID!],
791engineCategoryIds: [ID!]
792): JobList
793
794# Retrieve a single job by ID
795#
796# Arguments
797# id: the job ID.
798job(id: ID!): Job
799
800# Retrieve a single task by ID
801#
802# Arguments
803# id: Provide the task ID.
804task(id: ID!): Task
805
806# Retrieve entity identifier types
807# Example:
808# Request:
809# query {
810#
811# entityIdentifierTypes(limit:2) {
812#
813# records{
814#
815# id
816#
817# label
818#
819# }
820#
821# }
822# }
823# Response:
824# {
825#
826# "data": {
827#
828# "entityIdentifierTypes": {
829#
830# "records": [
831#
832# {
833#
834# "id": "face",
835#
836# "label": "Face"
837#
838# },
839#
840# {
841#
842# "id": "audio-recording",
843#
844# "label": "audio file"
845#
846# }
847#
848# ]
849#
850# }
851#
852# }
853# }
854#
855# Arguments
856# id: Provide an ID to retrieve a single specific entity
857# identifier type.
858# offset: Provide an offset to skip to a certain element in the
859# result, for paging.
860# limit: Specify maximum number of results to retrieve in this
861# result. Page size.
862entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
863
864# Retrieve an entity identifier type
865# Example:
866# Request:
867# query {
868#
869# entityIdentifierType(id:"face") {
870#
871# label
872#
873# entityIdentifierItems {
874#
875# libraryTypeId
876#
877# }
878#
879# }
880# }
881# Response:
882# {
883#
884# "data": {
885#
886# "entityIdentifierType": {
887#
888# "label": "Face",
889#
890# "entityIdentifierItems": [
891#
892# {
893#
894# "libraryTypeId": "people"
895#
896# },
897#
898# {
899#
900# "libraryTypeId": "suspect"
901#
902# },
903#
904# {
905#
906# "libraryTypeId": "people-known-offender"
907#
908# },
909#
910# {
911#
912# "libraryTypeId": "people-of-interest"
913#
914# }
915#
916# ]
917#
918# }
919#
920# }
921# }
922#
923# Arguments
924# id: Provide the entity identifier type ID
925entityIdentifierType(id: ID!): EntityIdentifierType
926
927# Retrieve all library types
928# Example:
929# Request:
930# query {
931#
932# libraryTypes(limit:2) {
933#
934# records{
935#
936# id
937#
938# entityTypeName
939#
940# }
941#
942# }
943# }
944# Response:
945# {
946#
947# "data": {
948#
949# "libraryTypes": {
950#
951# "records": [
952#
953# {
954#
955# "id": "people-known-offender",
956#
957# "entityTypeName": "known offender"
958#
959# },
960#
961# {
962#
963# "id": "dataset",
964#
965# "entityTypeName": "dataset"
966#
967# }
968#
969# ]
970#
971# }
972#
973# }
974# }
975#
976# Arguments
977# id: Provide an ID to retrieve a single specific library type.
978# offset: Provide an offset to skip to a certain element in the
979# result, for paging.
980# limit: Specify maximum number of results to retrieve in this
981# result. Page size.
982libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
983
984# Retrieve a single library type
985# Example:
986# Request:
987# query {
988#
989# libraryType(id: "people-known-offender") {
990#
991# entityTypeName
992#
993# label
994#
995# }
996# }
997# Response:
998# {
999#
1000# "data": {
1001#
1002# "libraryType": {
1003#
1004# "entityTypeName": "known offender",
1005#
1006# "label": "IDentify - Known Offender"
1007#
1008# }
1009#
1010# }
1011# }
1012#
1013# Arguments
1014# id: Provide an ID to retrieve a single specific library type.
1015libraryType(id: ID): LibraryType
1016
1017# Retrieve libraries and entities
1018# Example:
1019# Request:
1020# query {
1021#
1022# libraries(limit:2) {
1023#
1024# records {
1025#
1026# id
1027#
1028# name
1029#
1030# libraryTypeId
1031#
1032# }
1033#
1034# }
1035# }
1036# Response:
1037# {
1038#
1039# "data": {
1040#
1041# "libraries": {
1042#
1043# "records": [
1044#
1045# {
1046#
1047# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1048#
1049# "name": "example",
1050#
1051# "libraryTypeId": "123"
1052#
1053# }
1054#
1055# ]
1056#
1057# }
1058#
1059# }
1060# }
1061#
1062# Arguments
1063# id: Provide an ID to retrieve a single specific library.
1064# name: Provide a name string to search by name.
1065# type: Provide the name or ID of a library to search for
1066# libraries
1067# that contain that type.
1068# entityIdentifierTypeIds: Provide the id of an entity identifier
1069# type to search for libraries that correlate
1070# to that type.
1071# includeOwnedOnly: Specify true if only libraries owned by the
1072# user's organization
1073# should be returned. Otherwise, shared libraries will be included.
1074# offset: Provide an offset to skip to a certain element in the
1075# result, for paging.
1076# limit: Specify maximum number of results to retrieve in this
1077# result. Page size.
1078# orderBy: Specify a field to order by
1079# orderDirection: Specify the direction to order by
1080libraries(
1081id: ID,
1082name: String,
1083type: String,
1084entityIdentifierTypeIds: [String!],
1085includeOwnedOnly: Boolean,
1086offset: Int,
1087limit: Int,
1088orderBy: LibraryOrderBy,
1089orderDirection: OrderDirection
1090): LibraryList
1091
1092# Retrieve a specific library
1093# Example:
1094# Request:
1095# query {
1096#
1097# library(id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1098#
1099# name
1100#
1101# organizationId
1102#
1103# }
1104# }
1105# Response:
1106# {
1107#
1108# "data": {
1109#
1110# "library": {
1111#
1112# "name": "example",
1113#
1114# "organizationId": "35521"
1115#
1116# }
1117#
1118# }
1119# }
1120#
1121# Arguments
1122# id: Provide a library ID.
1123library(id: ID!): Library
1124
1125# Retrieve a specific library engine model
1126# Example:
1127# Request:
1128# query {
1129#
1130# libraryEngineModel(id: "87714ca6-8dbd-4da0-9dc0-d9233927b00d") {
1131#
1132# trainStatus
1133#
1134# engineId
1135#
1136# }
1137# }
1138# Response:
1139# {
1140#
1141# "data": {
1142#
1143# "libraryEngineModel": {
1144#
1145# "trainStatus": "pending",
1146#
1147# "engineId": "1"
1148#
1149# }
1150#
1151# }
1152# }
1153#
1154# Arguments
1155# id: Provide the library engine model ID
1156libraryEngineModel(id: ID!): LibraryEngineModel
1157
1158# Retrieve a specific entity
1159# Example:
1160# Request:
1161# query {
1162#
1163# entity(id: "85b700fa-f327-4fea-b94b-ed83054170db") {
1164#
1165# name
1166#
1167# libraryId
1168#
1169# isPublished
1170#
1171# }
1172# }
1173# Response:
1174# {
1175#
1176# "data": {
1177#
1178# "entity": {
1179#
1180# "name": "example",
1181#
1182# "libraryId": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1183#
1184# "isPublished": false
1185#
1186# }
1187#
1188# }
1189# }
1190#
1191# Arguments
1192# id: Provide an entity ID.
1193entity(id: ID!): Entity
1194
1195# Retrieve a list of entities across libraries
1196# Example:
1197# Request:
1198# query {
1199#
1200# entities(libraryIds: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1201#
1202# records {
1203#
1204# id
1205#
1206# name
1207#
1208# isPublished
1209#
1210# }
1211#
1212# }
1213# }
1214# Response:
1215# {
1216#
1217# "data": {
1218#
1219# "entities": {
1220#
1221# "records": [
1222#
1223# {
1224#
1225# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1226#
1227# "name": "example",
1228#
1229# "isPublished": false
1230#
1231# }
1232#
1233# ]
1234#
1235# }
1236#
1237# }
1238# }
1239#
1240# Arguments
1241# ids: Provide a list of entity IDs to retrieve those entities
1242# libraryIds: Provide a list of library IDs to retrieve entities
1243# across
1244# multiple libraries.
1245entities(
1246ids: [ID!],
1247libraryIds: [ID!],
1248isPublished: Boolean,
1249identifierTypeId: ID,
1250name: String,
1251offset: Int,
1252limit: Int,
1253orderBy: LibraryEntityOrderBy,
1254orderDirection: OrderDirection
1255): EntityList
1256
1257# Retrieve library configuration
1258# Example:
1259# Request:
1260# query {
1261#
1262# libraryConfiguration(id:"7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7") {
1263#
1264# confidence{
1265#
1266# min
1267#
1268# max
1269#
1270# }
1271#
1272# }
1273# }
1274# Response:
1275# {
1276#
1277# "data": {
1278#
1279# "libraryConfiguration": {
1280#
1281# "confidence": {
1282#
1283# "min": 0,
1284#
1285# "max": 100
1286#
1287# }
1288#
1289# }
1290#
1291# }
1292# }
1293#
1294# Arguments
1295# id: Provide configuration id
1296libraryConfiguration(id: ID!): LibraryConfiguration
1297
1298# Retrieve applications. These are custom applications integrated into
1299# the Veritone platform using the VDA framework.
1300# Example:
1301# Request:
1302# query {
1303#
1304# applications(limit:2) {
1305#
1306# records {
1307#
1308# id
1309#
1310# name
1311#
1312# }
1313#
1314# }
1315# }
1316# Response:
1317# {
1318#
1319# "data": {
1320#
1321# "applications": {
1322#
1323# "records": [
1324#
1325# {
1326#
1327# "id": "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a",
1328#
1329# "name": "appexamplebill"
1330#
1331# },
1332#
1333# {
1334#
1335# "id": "5908703b-51b4-4291-9787-b54bada73b0a",
1336#
1337# "name": "appexample2"
1338#
1339# }
1340#
1341# ]
1342#
1343# }
1344#
1345# }
1346# }
1347#
1348# Arguments
1349# id: Provide an ID to retrieve a single specific application.
1350# status: Provide a status, such as "draft" or "active"
1351# owned: If true, return only applications owned by the user's
1352# organization.
1353# orgId: For super admin user only, if specified, the query
1354# returns applications for this orgId.
1355# isPublic: Filter applications that are public
1356# offset: Provide an offset to skip to a certain element in the
1357# result, for paging.
1358# limit: Specify maximum number of results to retrieve in this
1359# result. Page size.
1360applications(
1361id: ID,
1362status: ApplicationStatus,
1363owned: Boolean,
1364orgId: ID,
1365isPublic: Boolean,
1366offset: Int,
1367limit: Int
1368): ApplicationList
1369
1370# Retrieve organizations
1371# Example:
1372# Request:
1373# query {
1374#
1375# organizations(limit:2) {
1376#
1377# records {
1378#
1379# id
1380#
1381# name
1382#
1383# }
1384#
1385# }
1386# }
1387# Response:
1388# {
1389#
1390# "data": {
1391#
1392# "organizations": {
1393#
1394# "records": [
1395#
1396# {
1397#
1398# "id": "35521",
1399#
1400# "name": "WTS API Docs Org"
1401#
1402# }
1403#
1404# ]
1405#
1406# }
1407#
1408# }
1409# }
1410#
1411# Arguments
1412# id: Provide an ID to retrieve a single specific organization.
1413# offset: Provide an offset to skip to a certain element in the
1414# result, for paging.
1415# limit: Specify maximum number of results to retrieve in this
1416# result. Page size.
1417# kvpProperty: Provide a property from the organization kvp to
1418# filter the organization list.
1419# kvpValue: Provide value to for the kvpFeature filter.
1420# If not present the filter becomes kvpProperty existence filter
1421# name: Optionally, supply a string for string match
1422# nameMatch: Supply the type of string match to apply.
1423organizations(
1424id: ID,
1425offset: Int,
1426limit: Int,
1427kvpProperty: String,
1428kvpValue: String,
1429name: String,
1430nameMatch: StringMatch
1431): OrganizationList
1432
1433# Retrieve a single organization
1434# Example:
1435# Request:
1436# query {
1437#
1438# organization(id: "35521") {
1439#
1440# status
1441#
1442# }
1443# }
1444# Response:
1445# {
1446#
1447# "data": {
1448#
1449# "organization": {
1450#
1451# "status": "active"
1452#
1453# }
1454#
1455# }
1456# }
1457#
1458# Arguments
1459# id: The organization ID
1460# TODO take application ID as well as org ID
1461organization(id: ID!): Organization
1462
1463# Retrieve basic organization info about the organizations to which the user
1464# belongs
1465# Example:
1466# Request:
1467# query {
1468#
1469# myOrganizations {
1470#
1471# records {
1472#
1473# id
1474#
1475# name
1476#
1477# }
1478#
1479# }
1480# }
1481# Response:
1482# {
1483#
1484# "data": {
1485#
1486# "myOrganizations": {
1487#
1488# "records": [
1489#
1490# {
1491#
1492# "id": "35521",
1493#
1494# "name": "WTS API Docs Org"
1495#
1496# }
1497#
1498# ]
1499#
1500# }
1501#
1502# }
1503# }
1504#
1505# Arguments
1506# offset: Provide an offset to skip to a certain element in the
1507# result, for paging.
1508# limit: Specify maximum number of results to retrieve in this
1509# result. Page size.
1510myOrganizations(offset: Int, limit: Int, userName: String): OrganizationInfoList
1511
1512# Retrieve permissions
1513# Example:
1514# Request:
1515# query {
1516#
1517# permissions(limit:5) {
1518#
1519# records {
1520#
1521# id
1522#
1523# name
1524#
1525# }
1526#
1527# }
1528# }
1529#
1530# Response:
1531# {
1532#
1533# "data": {
1534#
1535# "permissions": {
1536#
1537# "records": [
1538#
1539# {
1540#
1541# "id": "2",
1542#
1543# "name": "admin.access"
1544#
1545# },
1546#
1547# {
1548#
1549# "id": "9",
1550#
1551# "name": "admin.group.create"
1552#
1553# },
1554#
1555# {
1556#
1557# "id": "12",
1558#
1559# "name": "admin.group.delete"
1560#
1561# },
1562#
1563# {
1564#
1565# "id": "10",
1566#
1567# "name": "admin.group.read"
1568#
1569# },
1570#
1571# {
1572#
1573# "id": "11",
1574#
1575# "name": "admin.group.update"
1576#
1577# }
1578#
1579# ]
1580#
1581# }
1582#
1583# }
1584# }
1585#
1586# Arguments
1587# id: Provide an ID to retrieve a single specific permission.
1588# offset: Provide an offset to skip to a certain element in the
1589# result, for paging.
1590# limit: Specify maximum number of results to retrieve in this
1591# result. Page size.
1592permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
1593
1594# Retrieve users
1595# Example:
1596# Request:
1597# query {
1598#
1599# users(
1600#
1601# organizationIds:"35521",
1602#
1603# limit: 2) {
1604#
1605# records {
1606#
1607# id
1608#
1609# name
1610#
1611# }
1612#
1613# }
1614# }
1615# Response:
1616# {
1617#
1618# "data": {
1619#
1620# "users": {
1621#
1622# "records": [
1623#
1624# {
1625#
1626# "id": "267de7e1-efb2-444a-a524-210328b78503",
1627#
1628# "name": "example"
1629#
1630# },
1631#
1632# {
1633#
1634# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066",
1635#
1636# "name": "example1"
1637#
1638# }
1639#
1640# ]
1641#
1642# }
1643#
1644# }
1645# }
1646#
1647# Arguments
1648# id: Provide an ID to retrieve a single specific user.
1649# A user ID is a string in UUID format.
1650# ids: Provide IDs to retrieve multiple users by ID.
1651# name: Provide a name, or part of one, to search by name.
1652# organizationIds: Provide a list of organization IDs to filter
1653# your search by organization.
1654# offset: Provide an offset to skip to a certain element in the
1655# result, for paging.
1656# limit: Specify maximum number of results to retrieve in this
1657# result. Page size.
1658# includeAllOrgUsers: Include all organization users.
1659# dateTimeFilter: Filter by date/time field
1660# status: Filter by account status
1661users(
1662id: ID,
1663ids: [ID],
1664name: String,
1665organizationIds: [ID],
1666offset: Int,
1667limit: Int,
1668includeAllOrgUsers: Boolean,
1669dateTimeFilter: [UsersDateTimeFilter!],
1670status: UserStatus
1671): UserList
1672
1673# Retrieve an individual user
1674# Example:
1675# Request:
1676# query {
1677#
1678# user(id: "267de7e1-efb2-444a-a524-210328b78503") {
1679#
1680# name
1681#
1682# status
1683#
1684# }
1685# }
1686# Response:
1687# {
1688#
1689# "data": {
1690#
1691# "user": {
1692#
1693# "name": "example",
1694#
1695# "status": "deleted"
1696#
1697# }
1698#
1699# }
1700# }
1701#
1702# Arguments
1703# id: The user ID.
1704# A user ID is a string in UUID format.
1705user(id: ID!, organizationIds: [ID]): User
1706
1707# Retrieve user's organization API tokens
1708# Example:
1709# Request:
1710# query {
1711#
1712# tokens {
1713#
1714# id
1715#
1716# applicationId
1717#
1718# }
1719# }
1720# Response:
1721# {
1722#
1723# "data": {
1724#
1725# "tokens": []
1726#
1727# }
1728# }
1729tokens: [Token]
1730
1731# Retrieve information for the current logged-in user
1732# Example:
1733# Request:
1734# query {
1735#
1736# me {
1737#
1738# id
1739#
1740# organizationId
1741#
1742# }
1743# }
1744# Response:
1745# {
1746#
1747# "data": {
1748#
1749# "me": {
1750#
1751# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008",
1752#
1753# "organizationId": "35521"
1754#
1755# }
1756#
1757# }
1758# }
1759me: User
1760
1761# Retrieve groups
1762# Example:
1763# Request:
1764# query {
1765#
1766# groups {
1767#
1768# records {
1769#
1770# id
1771#
1772# name
1773#
1774# }
1775#
1776# }
1777# }
1778# Response:
1779# {
1780#
1781# "data": {
1782#
1783# "groups": {
1784#
1785# "records": [
1786#
1787# {
1788#
1789# "id": "8db639c1-c926-4f83-90de-d86c2ae5973d",
1790#
1791# "name": "WTS API Docs Org"
1792#
1793# }
1794#
1795# ]
1796#
1797# }
1798#
1799# }
1800# }
1801#
1802# Arguments
1803# id: Provide an ID to retrieve a specific group by ID
1804# ids: Provide IDs to retrieve multiple groups by ID
1805# name: Provide a name, or part of one, to search for groups by
1806# name
1807# organizationIds: "
1808# Provide a list of organization IDs to retrieve groups defined
1809# within certain organizations.
1810# offset: Provide an offset to skip to a certain element in the
1811# result, for paging.
1812# limit: Specify maximum number of results to retrieve in this
1813# result. Page size.
1814groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
1815
1816# Retrieve a single mention
1817#
1818# Arguments
1819# mentionId: The mention ID
1820# limit: Comments pagination - limit
1821# offset: Comments pagination - limit
1822# userId: The user who owns the mention.
1823mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
1824
1825# Retrieve a shared mention
1826#
1827# Arguments
1828# shareId: share token
1829sharedMention(shareId: ID!): SharedMention
1830
1831# Search for mentions across an index.
1832# This query requires a user token.
1833# Known Issues:
1834# - Offset can not go past 10,000. To get around this, the best practice is to
1835# keep updating the start time of the query based on the last mention you have
1836# processed.
1837# Example:
1838# Request:
1839# query{
1840#
1841# searchMentions(search:{
1842#
1843# offset: 0
1844#
1845# limit: 1
1846#
1847# index: ["mine"]
1848#
1849# query:{
1850#
1851# operator: "and"
1852#
1853# conditions: [{
1854#
1855# operator: "term"
1856#
1857# field: "trackingUnitName"
1858#
1859# value: "Dallas Cowboys Super Bowl"
1860#
1861# },
1862#
1863# {
1864#
1865# operator: "term"
1866#
1867# field: "mentionStatusId"
1868#
1869# value: "1"
1870#
1871# }]
1872#
1873# }
1874#
1875# }) {
1876#
1877# jsondata
1878#
1879# }
1880# }
1881# Response:
1882# {
1883#
1884# "data": {
1885#
1886# "searchMentions": {
1887#
1888# "jsondata": {
1889#
1890# "results": [
1891#
1892# {
1893#
1894# "id": 47569938,
1895#
1896# "programFormatName": "Information and News",
1897#
1898# "mentionDate": "2017-01-31T07:59:18.000Z",
1899#
1900# "mediaStartTime": "2017-01-31T07:45:01.000Z",
1901#
1902# "mediaId": 20017455,
1903#
1904# "metadata": {
1905#
1906# "filename": "AM-RADIO",
1907#
1908# "veritone-file": {
1909#
1910# "size": 0,
1911#
1912# "filename": "AM-RADIO",
1913#
1914# "mimetype": "audio/mpeg"
1915#
1916# },
1917#
1918# "veritone-media-source": {
1919#
1920# "mediaSourceId": "14326",
1921#
1922# "mediaSourceTypeId": "1"
1923#
1924# },
1925#
1926# "veritone-program": {
1927#
1928# "programId": "3828",
1929#
1930# "programName": "AM-RADIO Morning Talk",
1931#
1932# "programImage":
1933# "https://s3.amazonaws.com/veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
1934#
1935# "programLiveImage":
1936# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG"
1937#
1938# }
1939#
1940# },
1941#
1942# "fileLocation":
1943# "https://inspirent.s3.amazonaws.com/recordings/9605ea97-87df-428e-6740-720df8b8691c_original.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T205111Z&X-Amz-Expires=604800&X-Amz-Signature=00f62a6e2367c109320c98b9aea190cd28d82ac347eeeca030f42810b7ab75e3&X-Amz-SignedHeaders=host",
1944#
1945# "fileType": "audio/mpeg",
1946#
1947# "snippets": [
1948#
1949# {
1950#
1951# "startTime": 857.62,
1952#
1953# "endTime": 887.33,
1954#
1955# "text": "eighty first women's Australian Open final Monica Seles beat Steffi
1956# Graf four six six three six two in one thousand nine hundred twenty eight the
1957# Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back
1958# Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the
1959# Cowboys twenty sixteen at the one hundred fourth women's Australian Open final
1960# six three six six four that time capsule your",
1961#
1962# "hits": [
1963#
1964# {
1965#
1966# "startTime": 865.7,
1967#
1968# "endTime": 865.929,
1969#
1970# "queryTerm": "Dallas"
1971#
1972# },
1973#
1974# {
1975#
1976# "startTime": 865.93,
1977#
1978# "endTime": 866.07,
1979#
1980# "queryTerm": "Cowboys"
1981#
1982# },
1983#
1984# {
1985#
1986# "startTime": 872.74,
1987#
1988# "endTime": 873.31,
1989#
1990# "queryTerm": "Super"
1991#
1992# },
1993#
1994# {
1995#
1996# "startTime": 873.31,
1997#
1998# "endTime": 873.43,
1999#
2000# "queryTerm": "Bowl"
2001#
2002# }
2003#
2004# ]
2005#
2006# }
2007#
2008# ],
2009#
2010# "userSnippets": null,
2011#
2012# "advertiserId": 0,
2013#
2014# "advertiserName": "",
2015#
2016# "brandId": 0,
2017#
2018# "brandImage": "",
2019#
2020# "brandName": "",
2021#
2022# "campaignId": 0,
2023#
2024# "campaignName": "",
2025#
2026# "organizationId": 7295,
2027#
2028# "organizationName": "Demo Organization",
2029#
2030# "trackingUnitId": 10032,
2031#
2032# "trackingUnitName": "Dallas Cowboys Super Bowl",
2033#
2034# "mentionStatusId": 1,
2035#
2036# "mediaSourceTypeId": 1,
2037#
2038# "mediaSourceTypeName": "Audio",
2039#
2040# "mediaSourceId": 14326,
2041#
2042# "mediaSourceName": "AM-RADIO Morning Talk",
2043#
2044# "isNational": true,
2045#
2046# "spotTypeId": null,
2047#
2048# "spotTypeName": null,
2049#
2050# "programId": 3828,
2051#
2052# "programName": "AM-RADIO",
2053#
2054# "programImage":
2055# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2056#
2057# "programLiveImage":
2058# "https://s3.amazonaws.com/veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG",
2059#
2060# "impressions": 1894,
2061#
2062# "audience": [
2063#
2064# {
2065#
2066# "gender": "men",
2067#
2068# "age_group": "35-44",
2069#
2070# "audience": 11,
2071#
2072# "isTargetMatch": true
2073#
2074# },
2075#
2076# {
2077#
2078# "gender": "men",
2079#
2080# "age_group": "45-49",
2081#
2082# "audience": 121,
2083#
2084# "isTargetMatch": true
2085#
2086# },
2087#
2088# {
2089#
2090# "gender": "men",
2091#
2092# "age_group": "50-54",
2093#
2094# "audience": 474,
2095#
2096# "isTargetMatch": true
2097#
2098# },
2099#
2100# {
2101#
2102# "gender": "men",
2103#
2104# "age_group": "65+",
2105#
2106# "audience": 95,
2107#
2108# "isTargetMatch": true
2109#
2110# },
2111#
2112# {
2113#
2114# "gender": "women",
2115#
2116# "age_group": "50-54",
2117#
2118# "audience": 19,
2119#
2120# "isTargetMatch": false
2121#
2122# },
2123#
2124# {
2125#
2126# "gender": "women",
2127#
2128# "age_group": "65+",
2129#
2130# "audience": 693,
2131#
2132# "isTargetMatch": false
2133#
2134# },
2135#
2136# {
2137#
2138# "gender": "men",
2139#
2140# "age_group": "55-64",
2141#
2142# "audience": 481,
2143#
2144# "isTargetMatch": true
2145#
2146# }
2147#
2148# ],
2149#
2150# "targetAudience": {
2151#
2152# "gender": 1,
2153#
2154# "genderName": "M",
2155#
2156# "ageGroup": [
2157#
2158# 0,
2159#
2160# 5
2161#
2162# ],
2163#
2164# "ageGroupMin": 18,
2165#
2166# "ageGroupMax": 0,
2167#
2168# "impressions": 1182
2169#
2170# },
2171#
2172# "audienceMarketCount": 3,
2173#
2174# "audienceAffiliateCount": 1,
2175#
2176# "rating": null,
2177#
2178# "ratings": null,
2179#
2180# "comments": null,
2181#
2182# "markets": [
2183#
2184# {
2185#
2186# "marketId": 54,
2187#
2188# "marketName": "Des Moines-Ames, IA"
2189#
2190# }
2191#
2192# ],
2193#
2194# "marketId": null,
2195#
2196# "marketName": null,
2197#
2198# "hourOfDay": 7,
2199#
2200# "dayOfWeek": 2,
2201#
2202# "dayOfMonth": 31,
2203#
2204# "month": 1,
2205#
2206# "year": 2017,
2207#
2208# "isMatch": true,
2209#
2210# "mentionStatusName": "Pending Verification",
2211#
2212# "complianceStatusId": null,
2213#
2214# "cognitiveEngineResults": null,
2215#
2216# "hits": 4
2217#
2218# }
2219#
2220# ],
2221#
2222# "totalResults": 579,
2223#
2224# "limit": 1,
2225#
2226# "from": 0,
2227#
2228# "to": 0,
2229#
2230# "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e",
2231#
2232# "timestamp": 1513371071
2233#
2234# }
2235#
2236# }
2237#
2238# }
2239# }
2240#
2241# Arguments
2242# search: JSON structure containing the search query.
2243# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2244# search query syntax
2245searchMentions(search: JSONData!): SearchResult
2246
2247# Search for media across an index.
2248# This query requires a user token.
2249# Example:
2250# Request:
2251# query{
2252#
2253# searchMedia(search:{
2254#
2255# offset: 0
2256#
2257# limit: 1
2258#
2259# index: ["mine"]
2260#
2261# query:{
2262#
2263# operator: "query_string"
2264#
2265# field: "transcript.transcript"
2266#
2267# value: "paris NOT \"las vegas\""
2268#
2269# }
2270#
2271# }) {
2272#
2273# jsondata
2274#
2275# }
2276# }
2277# Response:
2278# {
2279#
2280# "data": {
2281#
2282# "searchMedia": {
2283#
2284# "jsondata": {
2285#
2286# "results": [
2287#
2288# {
2289#
2290# "recording": {
2291#
2292# "recordingId": "43033727",
2293#
2294# "fileLocation":
2295# "https://inspirent.s3.amazonaws.com/assets/43033727/ea9d9845-775b-48cd-aada-16fa56894ba0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T181255Z&X-Amz-Expires=604800&X-Amz-Signature=2fd918d5ac20979bd27d365bfa455904cf1726307fddbd362a28a8bd9a0a81a8&X-Amz-SignedHeaders=host",
2296#
2297# "fileType": "video/mp4",
2298#
2299# "programId": "-1",
2300#
2301# "programName": "Weekly Talkshow",
2302#
2303# "programLiveImage":
2304# "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg",
2305#
2306# "mediaSourceId": "-1",
2307#
2308# "mediaSourceTypeId": "5",
2309#
2310# "sliceTime": 1512682022,
2311#
2312# "mediaStartTime": 1512681992,
2313#
2314# "aibDuration": 90,
2315#
2316# "isOwn": true,
2317#
2318# "hitStartTime": 1512682022,
2319#
2320# "hitEndTime": 1512682082
2321#
2322# },
2323#
2324# "startDateTime": 1512682022,
2325#
2326# "stopDateTime": 1512682082,
2327#
2328# "hits": [
2329#
2330# {
2331#
2332# "veritone-file": {
2333#
2334# "filename": "Veritone_v06.mp4",
2335#
2336# "mimetype": "video/mp4",
2337#
2338# "size": 162533502
2339#
2340# }
2341#
2342# }
2343#
2344# ]
2345#
2346# }
2347#
2348# ],
2349#
2350# "totalResults": 733275,
2351#
2352# "limit": 1,
2353#
2354# "from": 0,
2355#
2356# "to": 0,
2357#
2358# "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7",
2359#
2360# "timestamp": 1513361576
2361#
2362# }
2363#
2364# }
2365#
2366# }
2367# }
2368#
2369# Arguments
2370# search: JSON structure containing the search query.
2371# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2372# search query syntax
2373searchMedia(search: JSONData!): SearchResult
2374
2375# Retrieve the root folders for an organization
2376# Example:
2377# Request:
2378# query {
2379#
2380# rootFolders {
2381#
2382# id
2383#
2384# typeId
2385#
2386# }
2387# }
2388# Response:
2389# {
2390#
2391# "data": {
2392#
2393# "rootFolders": [
2394#
2395# {
2396#
2397# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2398#
2399# "typeId": 4
2400#
2401# },
2402#
2403# {
2404#
2405# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
2406#
2407# "typeId": 4
2408#
2409# }
2410#
2411# ]
2412#
2413# }
2414# }
2415#
2416# Arguments
2417# type: The type of root folder to retrieve
2418rootFolders(type: RootFolderType): [Folder]
2419
2420# Retrieve a single folder. Used to navigate the folder tree structure.
2421# Example:
2422# Request:
2423# query {
2424#
2425# folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") {
2426#
2427# typeId
2428#
2429# treeObjectId
2430#
2431# childFolders{
2432#
2433# records{
2434#
2435# id
2436#
2437# }
2438#
2439# }
2440#
2441# }
2442# }
2443# Response:
2444# {
2445#
2446# "data": {
2447#
2448# "folder": {
2449#
2450# "typeId": 4,
2451#
2452# "treeObjectId": "3104f61f-4bd1-4175-9fe6-27436d591c54",
2453#
2454# "childFolders": {
2455#
2456# "records": [
2457#
2458# {
2459#
2460# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
2461#
2462# },
2463#
2464# {
2465#
2466# "id": "a347319d-72da-43a2-93fc-e677876aca80"
2467#
2468# }
2469#
2470# ]
2471#
2472# }
2473#
2474# }
2475#
2476# }
2477# }
2478#
2479# Arguments
2480# id: Provide an ID to retrieve a single specific user.
2481folder(id: ID!): Folder
2482
2483# Example:
2484# Request:
2485# query {
2486#
2487# auditEvents(limit: 2) {
2488#
2489# records {
2490#
2491# id
2492#
2493# application
2494#
2495# }
2496#
2497# }
2498# }
2499# Response:
2500# {
2501#
2502# "data": {
2503#
2504# "auditEvents": {
2505#
2506# "records": [
2507#
2508# {
2509#
2510# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f",
2511#
2512# "application": ""
2513#
2514# }
2515#
2516# ]
2517#
2518# }
2519#
2520# }
2521# }
2522#
2523# Arguments
2524# query: An elastic query for audit events
2525# application: Filter logs by a specific application
2526# terms: Term filters to filter documents by properties in the
2527# payload
2528auditEvents(
2529query: JSONData,
2530orderDirection: OrderDirection,
2531application: String,
2532terms: [JSONData!],
2533limit: Int,
2534offset: Int
2535): AuditEventList!
2536
2537# Retrieve a folder overview
2538# Example:
2539# Request:
2540# query {
2541#
2542# folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") {
2543#
2544# childFoldersCount
2545#
2546# childNonFolderObjectsCount
2547#
2548# }
2549# }
2550# Response:
2551# {
2552#
2553# "data": {
2554#
2555# "folderOverview": {
2556#
2557# "childFoldersCount": 3,
2558#
2559# "childNonFolderObjectsCount": 0
2560#
2561# }
2562#
2563# }
2564# }
2565#
2566# Arguments
2567# ids: Tree Object Ids
2568folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
2569
2570# Example:
2571# Request:
2572# query {
2573#
2574# folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") {
2575#
2576# id
2577#
2578# typeId
2579#
2580# }
2581# }
2582# Response:
2583# {
2584#
2585# "data": {
2586#
2587# "folderSummaryDetails": [
2588#
2589# {
2590#
2591# "id": "1580701928",
2592#
2593# "typeId": 5
2594#
2595# },
2596#
2597# {
2598#
2599# "id": "1580388995",
2600#
2601# "typeId": 5
2602#
2603# },
2604#
2605# {
2606#
2607# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2608#
2609# "typeId": 4
2610#
2611# },
2612#
2613# {
2614#
2615# "id": "243625",
2616#
2617# "typeId": 3
2618#
2619# },
2620#
2621# {
2622#
2623# "id": "242599",
2624#
2625# "typeId": 3
2626#
2627# },
2628#
2629# {
2630#
2631# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
2632#
2633# "typeId": 1
2634#
2635# },
2636#
2637# {
2638#
2639# "id": "a347319d-72da-43a2-93fc-e677876aca80",
2640#
2641# "typeId": 1
2642#
2643# },
2644#
2645# {
2646#
2647# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320",
2648#
2649# "typeId": 1
2650#
2651# }
2652#
2653# ]
2654#
2655# }
2656# }
2657#
2658# Arguments
2659# ids: Tree Object Ids
2660folderSummaryDetails(
2661ids: [ID!]!,
2662rootFolderType: RootFolderType
2663): [FolderSummaryDetail]
2664
2665# Retrieve configs for a given application
2666# Example:
2667# Request:
2668# query {
2669#
2670# applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
2671#
2672# records: {
2673#
2674# configType
2675#
2676# configLevel
2677#
2678# }
2679#
2680# offset: 0
2681#
2682# limit: 1
2683#
2684# }
2685# }
2686# Response:
2687# {
2688#
2689# "data": {
2690#
2691# "applicationConfig": {
2692#
2693# "records": {
2694#
2695# "configType": "String",
2696#
2697# "configLevel": "Organization"
2698#
2699# }
2700#
2701# }
2702#
2703# }
2704# }
2705#
2706# Arguments
2707# orgId: Optional. Organization ID.
2708#
2709# If not specified, this will be the user's organization
2710# userId: Optional. If specified, returned the configs for this
2711# user and organization combo
2712# includeDefaults: If true, include defaults not specified
2713# configKeyRegexp: If specified, filter the configKey
2714# offset: Specify maximum number of results to retrieve in this
2715# result. Page size.
2716# limit: Specify maximum number of results to retrieve in this
2717# result.
2718applicationConfig(
2719appId: ID!,
2720orgId: ID,
2721userId: ID,
2722includeDefaults: Boolean,
2723configKeyRegexp: String,
2724offset: Int,
2725limit: Int
2726): ApplicationConfigList!
2727
2728# Retrieve config definitions for a given application
2729# Example:
2730# Request:
2731# query {
2732#
2733# applicationConfigDefinition(applicationId:
2734# "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') {
2735#
2736# records: {
2737#
2738# configType
2739#
2740# defaultValue
2741#
2742# }
2743#
2744# offset: 0
2745#
2746# limit: 1
2747#
2748# }
2749# }
2750# Response:
2751# {
2752#
2753# "data": {
2754#
2755# "applicationConfigDefinition": {
2756#
2757# "records": [{
2758#
2759# "configType": Boolean,
2760#
2761# "defaultValue": true,
2762#
2763# }]
2764#
2765# }
2766#
2767# }
2768# }
2769#
2770# Arguments
2771# configKey: If specified, grab definition for this config key
2772# offset: Specify maximum number of results to retrieve in this
2773# result. Page size.
2774# limit: Specify maximum number of results to retrieve in this
2775# result.
2776applicationConfigDefinition(
2777appId: ID!,
2778configKey: String,
2779offset: Int,
2780limit: Int
2781): ApplicationConfigDefinitionList!
2782
2783# Retrieve a single application
2784# Example:
2785# Request:
2786# query {
2787#
2788# application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
2789#
2790# name
2791#
2792# key
2793#
2794# }
2795# }
2796# Response:
2797# {
2798#
2799# "data": {
2800#
2801# "application": {
2802#
2803# "name": "appexamplebill",
2804#
2805# "key": "appexamplebill"
2806#
2807# }
2808#
2809# }
2810# }
2811#
2812# Arguments
2813# id: The application ID
2814application(id: ID!): Application
2815
2816# Retrieve a list of schemas for structured data ingestions\
2817# Example:
2818# Request:
2819# query {
2820#
2821# schemas(limit: 2) {
2822#
2823# records {
2824#
2825# id
2826#
2827# organizationId
2828#
2829# }
2830#
2831# }
2832# }
2833# Response:
2834# {
2835#
2836# "data": {
2837#
2838# "schemas": {
2839#
2840# "records": [
2841#
2842# {
2843#
2844# "id": "21a08123-45dc-497e-b329-360d9f3fcaac",
2845#
2846# "organizationId": "35521"
2847#
2848# },
2849#
2850# {
2851#
2852# "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112",
2853#
2854# "organizationId": "35521"
2855#
2856# }
2857#
2858# ]
2859#
2860# }
2861#
2862# }
2863# }
2864#
2865# Arguments
2866# id: Id of a schema to retrieve
2867# ids: Ids of schemas to retrieve
2868# dataRegistryId: Specify the id of the DataRegistry to get
2869# schemas
2870# status: Specify one or more statuses to filter by schema status
2871# majorVersion: Specify a major version to filter schemas
2872# name: Specify a data registry name to filter schemas
2873# nameMatch: The strategy used to find data registry name
2874# limit: Limit
2875# offset: Offset
2876# orderBy: Specify one or more fields and direction to order
2877# results
2878schemas(
2879id: ID,
2880ids: [ID!],
2881dataRegistryId: ID,
2882status: [SchemaStatus!],
2883majorVersion: Int,
2884name: String,
2885nameMatch: StringMatch,
2886limit: Int,
2887offset: Int,
2888orderBy: [SchemaOrder]
2889): SchemaList
2890
2891# Retrieve a schema for structured data ingestions
2892# Example:
2893# Request:
2894# query {
2895#
2896# schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") {
2897#
2898# definition
2899#
2900# status
2901#
2902# }
2903# }
2904# Response:
2905# {
2906#
2907# "data": {
2908#
2909# "schema": {
2910#
2911# "definition": {
2912#
2913# "example": "example value"
2914#
2915# },
2916#
2917# "status": "draft"
2918#
2919# }
2920#
2921# }
2922# }
2923#
2924# Arguments
2925# id: Supply the ID of the schema to retrieve
2926schema(id: ID!): Schema
2927
2928# Example:
2929# Request:
2930# query {
2931#
2932# schemaProperties(limit: 2) {
2933#
2934# records {
2935#
2936# type
2937#
2938# dataRegistryId
2939#
2940# }
2941#
2942# }
2943# }
2944# Response:
2945# {
2946#
2947# "data": {
2948#
2949# "schemaProperties": {
2950#
2951# "records": [
2952#
2953# {
2954#
2955# "type": "string",
2956#
2957# "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6"
2958#
2959# },
2960#
2961# {
2962#
2963# "type": "string",
2964#
2965# "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c"
2966#
2967# }
2968#
2969# ]
2970#
2971# }
2972#
2973# }
2974# }
2975#
2976# Arguments
2977# limit: Limit
2978# offset: Offset
2979schemaProperties(
2980dataRegistryVersion: [DataRegistryVersion!],
2981search: String,
2982limit: Int,
2983offset: Int
2984): SchemaPropertyList
2985
2986# Retrieve a structured data object
2987# Example:
2988# Request:
2989# query {
2990#
2991# structuredData(
2992#
2993# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2994#
2995# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2996#
2997# data
2998#
2999# }
3000# }
3001# Response:
3002# {
3003#
3004# "data": {
3005#
3006# "structuredData": {
3007#
3008# "data": {
3009#
3010# "example": "example"
3011#
3012# }
3013#
3014# }
3015#
3016# }
3017# }
3018#
3019# Arguments
3020# id: Supply the ID of the structured data object to retrieve.
3021# This will override filters.
3022# schemaId: Schema Id for the structured data object to retrieve
3023structuredData(id: ID!, schemaId: ID!): StructuredData
3024
3025# Retrieve a structured data object
3026# Example:
3027# Request:
3028# query {
3029#
3030# structuredDataObject(
3031#
3032# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3033#
3034# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3035#
3036# data
3037#
3038# }
3039# }
3040# Response:
3041# {
3042#
3043# "data": {
3044#
3045# "structuredDataObject": {
3046#
3047# "data": {
3048#
3049# "example": "example"
3050#
3051# }
3052#
3053# }
3054#
3055# }
3056# }
3057#
3058# Arguments
3059# id: Supply the ID of the structured data object to retrieve.
3060# This will override filters.
3061# schemaId: Schema Id for the structured data object to retrieve
3062structuredDataObject(id: ID!, schemaId: ID!): StructuredData
3063
3064# Retrieve a paginated list of structured data object
3065# Example:
3066# Request:
3067# query {
3068#
3069# structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3070#
3071# records {
3072#
3073# id
3074#
3075# data
3076#
3077# }
3078#
3079# }
3080# }
3081# Response:
3082# {
3083#
3084# "data": {
3085#
3086# "structuredDataObjects": {
3087#
3088# "records": [
3089#
3090# {
3091#
3092# "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3093#
3094# "data": {
3095#
3096# "example": "example"
3097#
3098# }
3099#
3100# },
3101#
3102# {
3103#
3104# "id": "f914eafe-ed9b-46b1-a48d-effd5575764a",
3105#
3106# "data": {
3107#
3108# "example": "example"
3109#
3110# }
3111#
3112# }
3113#
3114# ]
3115#
3116# }
3117#
3118# }
3119# }
3120#
3121# Arguments
3122# id: Supply the ID of the structured data object to retrieve.
3123# This will override filters.
3124# ids: List of Ids of the structured data objects to retrieve.
3125# This will override filters.
3126# schemaId: Schema Id for the structured data object to retrieve
3127# filter: Query to filter SDO. Supports operations such as and,
3128# or, eq, gt, lt, etc.
3129# TODO link to syntax documentation
3130structuredDataObjects(
3131id: ID,
3132ids: [ID!],
3133schemaId: ID!,
3134orderBy: [StructuredDataOrderBy!],
3135limit: Int,
3136offset: Int,
3137owned: Boolean,
3138filter: JSONData
3139): StructuredDataList
3140
3141# Returns information about the GraphQL server, useful
3142# for diagnostics. This data is primarily used by Veritone
3143# development, and some fields may be restricted to Veritone administrators.
3144graphqlServiceInfo: GraphQLServiceInfo
3145
3146# Returns a signed writable S3 URL. A client can then
3147# upload to this URL with an HTTP PUT without providing
3148# any additional authorization (_note_: it must be a PUT.
3149# A POST will fail.)
3150# Example:
3151# Request:
3152# query {
3153#
3154# getSignedWritableUrl(type: "preview") {
3155#
3156# bucket
3157#
3158# key
3159#
3160# url
3161#
3162# }
3163# }
3164# Response:
3165# {
3166#
3167# "data": {
3168#
3169# "getSignedWritableUrl": {
3170#
3171# "bucket": "prod-api.veritone.com",
3172#
3173# "key":
3174# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3175#
3176# "url":
3177# "https://s3.amazonaws.com/prod-api.veritone.com/35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194850Z&X-Amz-Expires=86400&X-Amz-Signature=44857350a7f0b7311d4b911b557f4171a6ffe126c76e3d26f6e5cd532f645e53&X-Amz-SignedHeaders=host"
3178#
3179# }
3180#
3181# }
3182# }
3183#
3184# Arguments
3185# key: Optional key of the object to generate a writable
3186# URL for. If not provided, a new, unique key will
3187# be generated. If a key is provided and resembles a file name
3188# (with extension delimited by .), a UUID will be inserted
3189# into the file name, leaving the extension intact.
3190# If a key is provided and does not resemble
3191# a file name, a UUID will be appended.
3192# type: Optional type of resource, such as `asset`, `thumbnail`,
3193# `discovery-analytics` or `preview`
3194# path: Optional extended path information. If the uploaded
3195# content will be contained
3196# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3197# (for `entityIdentifier`), the ID of the object should be provided here.
3198# expiresInSeconds: Optional expiresInSeconds custom expiration
3199# to signedUrlExpires
3200# Max expiresInSeconds up to 604800
3201# organizationId: Optional organization ID. Normally this value
3202# is computed by the server
3203# based on the authorization token used for the request.
3204# Is is used only by Veritone platform components.
3205getSignedWritableUrl(
3206key: String,
3207type: String,
3208path: String,
3209expiresInSeconds: Int,
3210organizationId: ID
3211): WritableUrlInfo
3212
3213# Return writable storage URLs in bulk.
3214# A maximum of 1000 can be created in one call.
3215# See `getSignedWritableUrl` for details on usage of the
3216# response contents.
3217# Example:
3218# Request:
3219# query {
3220#
3221# getSignedWritableUrls(number: 2) {
3222#
3223# bucket
3224#
3225# key
3226#
3227# url
3228#
3229# }
3230# }
3231# Response:
3232# {
3233#
3234# "data": {
3235#
3236# "getSignedWritableUrls": [
3237#
3238# {
3239#
3240# "bucket": "prod-api.veritone.com",
3241#
3242# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3243#
3244# "url":
3245# "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=57c8d9046297e6d6839d19e7d22552618e9ff89dd4855ca7f7aceb26e89d3de4&X-Amz-SignedHeaders=host"
3246#
3247# },
3248#
3249# {
3250#
3251# "bucket": "prod-api.veritone.com",
3252#
3253# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3254#
3255# "url":
3256# "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=9e139df517ca85fa0b969f0d3ff55b890b8a5e199c4fa7b3a26ea2f12a65bfec&X-Amz-SignedHeaders=host"
3257#
3258# }
3259#
3260# ]
3261#
3262# }
3263# }
3264#
3265# Arguments
3266# number: Number of signed URLs to return
3267# type: Optional type of resource, such as `asset`, `thumbnail`,
3268# or `preview`
3269# path: Optional extended path information. If the uploaded
3270# content will be contained
3271# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3272# (for `entityIdentifier`), the ID of the object should be provided here.
3273# organizationId: Optional organization ID. Normally this value
3274# is computed by the server
3275# based on the authorization token used for the request.
3276# Is is used only by Veritone platform components.
3277getSignedWritableUrls(
3278number: Int!,
3279type: String,
3280path: String,
3281organizationId: ID
3282): [WritableUrlInfo!]!
3283
3284# Retrieve the rights of the current user
3285# Example:
3286# Request:
3287# query {
3288#
3289# myRights {
3290#
3291# resources
3292#
3293# operations
3294#
3295# }
3296# }
3297# Response:
3298# {
3299#
3300# "data": {
3301#
3302# "myRights": {
3303#
3304# "resources": {},
3305#
3306# "operations": [
3307#
3308# "admin.access",
3309#
3310# "admin.org.read",
3311#
3312# "admin.org.update",
3313#
3314# "admin.user.create",
3315#
3316# "admin.user.read",
3317#
3318# "admin.user.update",
3319#
3320# "admin.user.delete",
3321#
3322# ...
3323#
3324# ]
3325#
3326# }
3327#
3328# }
3329# }
3330myRights: RightsListing
3331
3332# Retrieve the shared folders for an organization
3333# Example:
3334# Request:
3335# query {
3336#
3337# sharedFolders {
3338#
3339# id
3340#
3341# }
3342# }
3343# Response:
3344# {
3345#
3346# "data": {
3347#
3348# "sharedFolders": []
3349#
3350# }
3351# }
3352sharedFolders: [Folder]
3353
3354# Retrieve multiple watchlists
3355# Example:
3356# Request:
3357# query {
3358#
3359# watchlists(limit: 2) {
3360#
3361# records {
3362#
3363# id
3364#
3365# name
3366#
3367# }
3368#
3369# }
3370# }
3371# Response:
3372# {
3373#
3374# "data": {
3375#
3376# "watchlists": {
3377#
3378# "records": [
3379#
3380# {
3381#
3382# "id": "326916",
3383#
3384# "name": "example"
3385#
3386# },
3387#
3388# {
3389#
3390# "id": "325791",
3391#
3392# "name": "example"
3393#
3394# }
3395#
3396# ]
3397#
3398# }
3399#
3400# }
3401# }
3402#
3403# Arguments
3404# isDisabled: Set `true` to include only disabled watchlist or
3405# `false` to include only enabled watchlists. By default,
3406# both are included.
3407# names: Provide a list of names to filter folders
3408watchlists(
3409id: ID,
3410maxStopDateTime: DateTime,
3411minStopDateTime: DateTime,
3412minStartDateTime: DateTime,
3413maxStartDateTime: DateTime,
3414name: String,
3415offset: Int,
3416limit: Int,
3417orderBy: WatchlistOrderBy,
3418orderDirection: OrderDirection,
3419isDisabled: Boolean,
3420names: [String],
3421nameMatch: StringMatch
3422): WatchlistList
3423
3424# Retrieve a single watchlist by id
3425# Example:
3426# Request:
3427# query {
3428#
3429# watchlist(id: "325791") {
3430#
3431# name
3432#
3433# watchlistType
3434#
3435# }
3436# }
3437# Response:
3438# {
3439#
3440# "data": {
3441#
3442# "watchlist": {
3443#
3444# "name": "example",
3445#
3446# "watchlistType": "tracking"
3447#
3448# }
3449#
3450# }
3451# }
3452watchlist(id: ID!): Watchlist
3453
3454# Example:
3455# Request:
3456# query {
3457#
3458# mentionStatusOptions {
3459#
3460# id
3461#
3462# name
3463#
3464# }
3465# }
3466# Response:
3467# {
3468#
3469# "data": {
3470#
3471# "mentionStatusOptions": [
3472#
3473# {
3474#
3475# "id": "7",
3476#
3477# "name": "Auto Verified"
3478#
3479# },
3480#
3481# {
3482#
3483# "id": "5",
3484#
3485# "name": "Invalid"
3486#
3487# },
3488#
3489# {
3490#
3491# "id": "3",
3492#
3493# "name": "Needs Review"
3494#
3495# },
3496#
3497# {
3498#
3499# "id": "1",
3500#
3501# "name": "Pending Verification"
3502#
3503# },
3504#
3505# {
3506#
3507# "id": "6",
3508#
3509# "name": "Processing Verification"
3510#
3511# },
3512#
3513# {
3514#
3515# "id": "4",
3516#
3517# "name": "Request Bonus"
3518#
3519# },
3520#
3521# {
3522#
3523# "id": "2",
3524#
3525# "name": "Verified"
3526#
3527# }
3528#
3529# ]
3530#
3531# }
3532# }
3533mentionStatusOptions: [MentionStatus!]!
3534
3535# Retrieve multiple data registries
3536# Example:
3537# Request:
3538# query {
3539#
3540# dataRegistries(limit: 2) {
3541#
3542# records {
3543#
3544# id
3545#
3546# name
3547#
3548# }
3549#
3550# }
3551# }
3552# Response:
3553# {
3554#
3555# "data": {
3556#
3557# "dataRegistries": {
3558#
3559# "records": [
3560#
3561# {
3562#
3563# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
3564#
3565# "name": "example"
3566#
3567# },
3568#
3569# {
3570#
3571# "id": "317c941d-30d0-455e-882b-34a26e513364",
3572#
3573# "name": "example"
3574#
3575# }
3576#
3577# ]
3578#
3579# }
3580#
3581# }
3582# }
3583dataRegistries(
3584id: ID,
3585ids: [ID!],
3586name: String,
3587nameMatch: StringMatch,
3588offset: Int,
3589limit: Int,
3590orderBy: DataRegistryOrderBy,
3591orderDirection: OrderDirection,
3592filterByOwnership: SchemaOwnership
3593): DataRegistryList
3594
3595# Retrieve a single data registry
3596# Example:
3597# Request:
3598# query {
3599#
3600# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
3601#
3602# name
3603#
3604# organizationId
3605#
3606# source
3607#
3608# }
3609# }
3610# Response:
3611# {
3612#
3613# "data": {
3614#
3615# "dataRegistry": {
3616#
3617# "name": "example",
3618#
3619# "organizationId": "35521",
3620#
3621# "source": "veritone-35521.datasets"
3622#
3623# }
3624#
3625# }
3626# }
3627dataRegistry(id: ID!): DataRegistry
3628
3629# Retrieve a subscription by id
3630# Example:
3631# Request:
3632# query {
3633#
3634# subscription(id: "275818") {
3635#
3636# isActive
3637#
3638# jsondata
3639#
3640# }
3641# }
3642# Response:
3643# {
3644#
3645# "data": {
3646#
3647# "subscription": {
3648#
3649# "isActive": true,
3650#
3651# "jsondata": {
3652#
3653# "tracking_unit_id": "325791",
3654#
3655# "creator_email": "example email",
3656#
3657# "unsubscribe_hash":
3658# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
3659#
3660# }
3661#
3662# }
3663#
3664# }
3665# }
3666subscription(id: ID!): Subscription!
3667
3668cognitiveSearch(id: ID!): CognitiveSearch!
3669
3670# Retrieve multiple collections
3671# Example:
3672# Request:
3673# query {
3674#
3675# collections {
3676#
3677# records {
3678#
3679# id
3680#
3681# name
3682#
3683# }
3684#
3685# }
3686# }
3687# Response:
3688# {
3689#
3690# "data": {
3691#
3692# "collections": {
3693#
3694# "records": [
3695#
3696# {
3697#
3698# "id": "241121",
3699#
3700# "name": "example"
3701#
3702# },
3703#
3704# {
3705#
3706# "id": "242599",
3707#
3708# "name": "example"
3709#
3710# },
3711#
3712# {
3713#
3714# "id": "243625",
3715#
3716# "name": "example"
3717#
3718# }
3719#
3720# ]
3721#
3722# }
3723#
3724# }
3725# }
3726collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
3727
3728# Retrieve a collection by id
3729# Example:
3730# Request:
3731# query {
3732#
3733# collection(id: "241121") {
3734#
3735# name
3736#
3737# isActive
3738#
3739# }
3740# }
3741# Response:
3742# {
3743#
3744# "data": {
3745#
3746# "collection": {
3747#
3748# "name": "example",
3749#
3750# "isActive": true
3751#
3752# }
3753#
3754# }
3755# }
3756collection(id: ID!): Collection!
3757
3758collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
3759
3760# Retrieve a list of collection mentions
3761# Specify at least one of folderId or mentionId
3762collectionMentions(
3763folderId: ID,
3764mentionId: ID,
3765orderBy: CollectionMentionOrderBy,
3766limit: Int,
3767offset: Int
3768): CollectionMentionList!
3769
3770# Retrieve multiple mentions
3771# Example:
3772# Request:
3773# query {
3774#
3775# mentions {
3776#
3777# records {
3778#
3779# id
3780#
3781# }
3782#
3783# }
3784# }
3785# Response:
3786# {
3787#
3788# "data": {
3789#
3790# "mentions": {
3791#
3792# "records": []
3793#
3794# }
3795#
3796# }
3797# }
3798#
3799# Arguments
3800# watchlistId: Get mentions created from the specified watchlist
3801# sourceId: Get mentions associated with the specified source
3802# sourceTypeId: Get mentions associated with sources of the
3803# specified source type
3804# tdoId: Get mentions associated directly with the specific TDO
3805# dateTimeFilter: Specify date/time filters against mention
3806# fields.
3807# Querying for mentions can be expensive. If the query does not
3808# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
3809# a user-provided `dateTimeFilter`, a default filter of the
3810# past 7 days is applied.
3811# orderBy: Set order information on the query. Multiple fields
3812# are supported.
3813# folderId: Provide a folder ID to filter by collection
3814mentions(
3815id: ID,
3816watchlistId: ID,
3817sourceId: ID,
3818sourceTypeId: ID,
3819tdoId: ID,
3820dateTimeFilter: [MentionDateTimeFilter!],
3821orderBy: [MentionOrderBy!],
3822offset: Int,
3823limit: Int,
3824folderId: ID
3825): MentionList
3826
3827# Retrieves engine results by TDO and engine ID or by job ID.
3828# Example:
3829# Request:
3830# query {
3831#
3832# engineResults(
3833#
3834# tdoId: "1580507556",
3835#
3836# engineIds: "4") {
3837#
3838# sourceId
3839#
3840# records {
3841#
3842# tdoId
3843#
3844# }
3845#
3846# }
3847# }
3848# Response:
3849# {
3850#
3851# "data": {
3852#
3853# "engineResults": {
3854#
3855# "sourceId": null,
3856#
3857# "records": []
3858#
3859# }
3860#
3861# }
3862# }
3863#
3864# Arguments
3865# tdoId: Provide the ID of the TDO containing engine results to
3866# retrieve.
3867# If this parameter is used, engineIds or engineCategoryIds must also be set.
3868# Results for _only_ the specified TDO will be returned.
3869# sourceId: Provide the ID of the Source containing engine
3870# results to retrieve.
3871# If this parameter is used, engineIds or engineCategoryIds must also be set.
3872# This takes priority over tdoId.
3873# engineIds: Provide one or more engine IDs to retrieve engine
3874# results by
3875# ID. This parameter is mandatory if tdoId is used, but optional
3876# if jobId or engineCategory is used.
3877# engineCategoryIds: Provide one or more category IDs to get all
3878# results from that categroy.
3879# jobId: Provide a job ID to retrieve engine results for the job.
3880# mentionId: Provide a mention ID to retrieve engine results for
3881# the mention.
3882# startOffsetMs: Start offset ms for the results.
3883# stopOffsetMs: End offset ms for the results.
3884# startDate: Start date for the results. Takes priority over
3885# startOffsetMs.
3886# stopDate: End date for the results. Takes priority over
3887# stopOffsetMs.
3888# ignoreUserEdited: Whether or not to exclude user edited engine
3889# results. Defaults to false.
3890# fallbackTdoId: A TDO ID can be provided for use if the provided
3891# `sourceId` and/or
3892# `mentionId` parameters do not resolve to a logical set of TDOs.
3893# Depending on parameter settings and available data,
3894# results from other TDOs can be included in the response.
3895engineResults(
3896tdoId: ID,
3897sourceId: ID,
3898engineIds: [ID!],
3899engineCategoryIds: [ID!],
3900jobId: ID,
3901mentionId: ID,
3902startOffsetMs: Int,
3903stopOffsetMs: Int,
3904startDate: DateTime,
3905stopDate: DateTime,
3906ignoreUserEdited: Boolean,
3907fallbackTdoId: ID
3908): EngineResultList
3909
3910# Retrieve a trigger by id
3911# Example:
3912# Request:
3913# query {
3914#
3915# trigger(id: "2998") {
3916#
3917# target
3918#
3919# createdDateTime
3920#
3921# }
3922# }
3923# Response:
3924# {
3925#
3926# "data": {
3927#
3928# "trigger": {
3929#
3930# "target": "Email",
3931#
3932# "createdDateTime": "2021-06-18T13:35:08.631Z"
3933#
3934# }
3935#
3936# }
3937# }
3938trigger(id: ID!): Trigger
3939
3940# Retrieve triggers
3941# Example:
3942# Request:
3943# query {
3944#
3945# triggers {
3946#
3947# id
3948#
3949# }
3950# }
3951# Response:
3952# {
3953#
3954# "data": {
3955#
3956# "triggers": [
3957#
3958# {
3959#
3960# "id": "2998"
3961#
3962# }
3963#
3964# ]
3965#
3966# }
3967# }
3968triggers: [Trigger]
3969
3970# Fetch all saved searches that the current user has made
3971# Fetch all saved searches that have been shared with
3972# the current users organization
3973# Include any saved searches that the user has created
3974# Example:
3975# Request:
3976# query {
3977#
3978# savedSearches {
3979#
3980# records {
3981#
3982# id
3983#
3984# name
3985#
3986# }
3987#
3988# }
3989# }
3990# Response:
3991# {
3992#
3993# "data": {
3994#
3995# "savedSearches": {
3996#
3997# "records": [
3998#
3999# {
4000#
4001# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
4002#
4003# "name": "example"
4004#
4005# }
4006#
4007# ]
4008#
4009# }
4010#
4011# }
4012# }
4013savedSearches(
4014offset: Int,
4015limit: Int,
4016includeShared: Boolean,
4017filterByName: String,
4018orderBy: SavedSearchOrderBy,
4019orderDirection: OrderDirection
4020): SavedSearchList!
4021
4022# Retrieve a list of export requests
4023# Example:
4024# Request:
4025# query {
4026#
4027# exportRequests(limit: 2) {
4028#
4029# records {
4030#
4031# id
4032#
4033# organizationId
4034#
4035# }
4036#
4037# }
4038# }
4039# Response:
4040# {
4041#
4042# "data": {
4043#
4044# "exportRequests": {
4045#
4046# "records": [
4047#
4048# {
4049#
4050# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4051#
4052# "organizationId": "35521"
4053#
4054# }
4055#
4056# ]
4057#
4058# }
4059#
4060# }
4061# }
4062#
4063# Arguments
4064# id: Provide an ID to retrieve a single export request
4065# offset: Provide an offset to skip to a certain element in the
4066# result, for paging.
4067# limit: Specify maximum number of results to retrieve in this
4068# result. Page size.
4069# status: Provide a list of status options to filter by status
4070# event: Provide an event to retrieve export request. Should be
4071# 'exportRequest' or 'mentionExportRequest'
4072# Default value is 'exportRequest'
4073exportRequests(
4074id: ID,
4075offset: Int,
4076limit: Int,
4077status: [ExportRequestStatus!],
4078event: ExportRequestEvent
4079): ExportRequestList!
4080
4081# Retrieve a single export request by id
4082# Example:
4083# Request:
4084# query {
4085#
4086# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
4087#
4088# id
4089#
4090# organizationId
4091#
4092# requestorId
4093#
4094# status
4095#
4096# }
4097# }
4098# Response:
4099# {
4100#
4101# "data": {
4102#
4103# "exportRequest": {
4104#
4105# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4106#
4107# "organizationId": "35521",
4108#
4109# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4110#
4111# "status": "complete"
4112#
4113# }
4114#
4115# }
4116# }
4117#
4118# Arguments
4119# event: Provide an event to retrieve export request. Should be
4120# 'exportRequest' or 'mentionExportRequest'
4121# Default value is 'exportRequest'
4122exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4123
4124# Retrieve a event by id
4125# Example:
4126# Request:
4127# query {
4128#
4129# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4130#
4131# eventName
4132#
4133# eventType
4134#
4135# description
4136#
4137# }
4138# }
4139# Response:
4140# {
4141#
4142# "data": {
4143#
4144# "event": {
4145#
4146# "eventName": "example",
4147#
4148# "eventType": "example",
4149#
4150# "description": "new example description"
4151#
4152# }
4153#
4154# }
4155# }
4156event(id: ID!): Event!
4157
4158# Retrieve a list of events by application
4159# Example:
4160# Request:
4161# query {
4162#
4163# events(
4164#
4165# application: "system",
4166#
4167# limit: 2) {
4168#
4169# records {
4170#
4171# id
4172#
4173# eventName
4174#
4175# }
4176#
4177# }
4178# }
4179# Response:
4180# {
4181#
4182# "data": {
4183#
4184# "events": {
4185#
4186# "records": [
4187#
4188# {
4189#
4190# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4191#
4192# "eventName": "ActionTokenForbidden"
4193#
4194# },
4195#
4196# {
4197#
4198# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4199#
4200# "eventName": "ActionUserForbidden"
4201#
4202# }
4203#
4204# ]
4205#
4206# }
4207#
4208# }
4209# }
4210#
4211# Arguments
4212# application: Provide an application to retrieve all its events.
4213# Use 'system' to list all public system events.
4214# offset: Provide an offset to skip to a certain element in the
4215# result, for paging.
4216# limit: Specify maximum number of results to retrieve in this
4217# result. Page size.
4218events(application: String!, offset: Int, limit: Int): EventList!
4219
4220# Retrieve a list of subscriptions by organization
4221# Example:
4222# Request:
4223# query {
4224#
4225# eventSubscriptions(limit: 2) {
4226#
4227# records {
4228#
4229# id
4230#
4231# eventName
4232#
4233# }
4234#
4235# }
4236# }
4237# Response:
4238# {
4239#
4240# "data": {
4241#
4242# "eventSubscriptions": {
4243#
4244# "records": [
4245#
4246# {
4247#
4248# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4249#
4250# "eventName": "LibraryTrainingComplete"
4251#
4252# },
4253#
4254# {
4255#
4256# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4257#
4258# "eventName": "LibraryTrainingComplete"
4259#
4260# }
4261#
4262# ]
4263#
4264# }
4265#
4266# }
4267# }
4268#
4269# Arguments
4270# ids: The event subscription ids
4271# eventName: The name of the event
4272# eventType: The type of event, such as `mention`, `job`,
4273# `engine`.
4274# offset: Provide an offset to skip to a certain element in the
4275# result, for paging.
4276# limit: Specify maximum number of results to retrieve in this
4277# result. Page size.
4278eventSubscriptions(
4279ids: [ID!],
4280eventName: String,
4281eventType: String,
4282offset: Int,
4283limit: Int
4284): EventSubscriptionList!
4285
4286# Retrieve a subscription by id
4287# Example:
4288# Request:
4289# query {
4290#
4291# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4292#
4293# id
4294#
4295# organizationId
4296#
4297# eventName
4298#
4299# targetName
4300#
4301# }
4302# }
4303# Response:
4304# {
4305#
4306# "data": {
4307#
4308# "eventSubscription": {
4309#
4310# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4311#
4312# "organizationId": "35521",
4313#
4314# "eventName": "LibraryTrainingComplete",
4315#
4316# "targetName": "NotificationMailbox"
4317#
4318# }
4319#
4320# }
4321# }
4322eventSubscription(id: ID!): EventSubscription!
4323
4324# Example:
4325# Request:
4326# query {
4327#
4328# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4329#
4330# organizationId
4331#
4332# actionType
4333#
4334# name
4335#
4336# }
4337# }
4338# Response:
4339# {
4340#
4341# "data": {
4342#
4343# "eventActionTemplate": {
4344#
4345# "organizationId": "35521",
4346#
4347# "actionType": "job",
4348#
4349# "name": "example"
4350#
4351# }
4352#
4353# }
4354# }
4355eventActionTemplate(id: ID!): EventActionTemplate
4356
4357# Example:
4358# Request:
4359# query {
4360#
4361# eventActionTemplates(
4362#
4363# inputType: event,
4364#
4365# actionType: job
4366#
4367# limit:2) {
4368#
4369# records {
4370#
4371# id
4372#
4373# name
4374#
4375# }
4376#
4377# }
4378# }
4379# Response:
4380# {
4381#
4382# "data": {
4383#
4384# "eventActionTemplates": {
4385#
4386# "records": [
4387#
4388# {
4389#
4390# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4391#
4392# "name": "example"
4393#
4394# },
4395#
4396# {
4397#
4398# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4399#
4400# "name": "example"
4401#
4402# }
4403#
4404# ]
4405#
4406# }
4407#
4408# }
4409# }
4410#
4411# Arguments
4412# ownerApplicationId: The application id
4413# inputType: use "event" for now. In the future, we allow
4414# additional input_type types. For example, a schedule or a tweet.
4415# actionType: Either "job", "webhook", "sms", "email". Future
4416# action_type could be "gql" where action is purely a function call.
4417# offset: Provide an offset to skip to a certain element in the
4418# result, for paging.
4419# limit: Specify maximum number of results to retrieve in this
4420# result. Page size.
4421eventActionTemplates(
4422ownerApplicationId: ID,
4423inputType: EventActionTemplateInputType,
4424actionType: EventActionTemplateActionType,
4425offset: Int,
4426limit: Int
4427): EventActionTemplateList!
4428
4429# Example:
4430# Request:
4431# query {
4432#
4433# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4434#
4435# name
4436#
4437# eventName
4438#
4439# description
4440#
4441# }
4442# }
4443# Response:
4444# {
4445#
4446# "data": {
4447#
4448# "eventCustomRule": {
4449#
4450# "name": "example",
4451#
4452# "eventName": "example",
4453#
4454# "description": "example description"
4455#
4456# }
4457#
4458# }
4459# }
4460eventCustomRule(id: ID!): EventCustomRule
4461
4462# Example:
4463# Request:
4464# query {
4465#
4466# eventCustomRules(limit: 2) {
4467#
4468# records {
4469#
4470# id
4471#
4472# name
4473#
4474# }
4475#
4476# }
4477# }
4478# Response:
4479# {
4480# <