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 a single application
2666# Example:
2667# Request:
2668# query {
2669#
2670# application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
2671#
2672# name
2673#
2674# key
2675#
2676# }
2677# }
2678# Response:
2679# {
2680#
2681# "data": {
2682#
2683# "application": {
2684#
2685# "name": "appexamplebill",
2686#
2687# "key": "appexamplebill"
2688#
2689# }
2690#
2691# }
2692# }
2693#
2694# Arguments
2695# id: The application ID
2696application(id: ID!): Application
2697
2698# Retrieve a list of schemas for structured data ingestions\
2699# Example:
2700# Request:
2701# query {
2702#
2703# schemas(limit: 2) {
2704#
2705# records {
2706#
2707# id
2708#
2709# organizationId
2710#
2711# }
2712#
2713# }
2714# }
2715# Response:
2716# {
2717#
2718# "data": {
2719#
2720# "schemas": {
2721#
2722# "records": [
2723#
2724# {
2725#
2726# "id": "21a08123-45dc-497e-b329-360d9f3fcaac",
2727#
2728# "organizationId": "35521"
2729#
2730# },
2731#
2732# {
2733#
2734# "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112",
2735#
2736# "organizationId": "35521"
2737#
2738# }
2739#
2740# ]
2741#
2742# }
2743#
2744# }
2745# }
2746#
2747# Arguments
2748# id: Id of a schema to retrieve
2749# ids: Ids of schemas to retrieve
2750# dataRegistryId: Specify the id of the DataRegistry to get
2751# schemas
2752# status: Specify one or more statuses to filter by schema status
2753# majorVersion: Specify a major version to filter schemas
2754# name: Specify a data registry name to filter schemas
2755# nameMatch: The strategy used to find data registry name
2756# limit: Limit
2757# offset: Offset
2758# orderBy: Specify one or more fields and direction to order
2759# results
2760schemas(
2761id: ID,
2762ids: [ID!],
2763dataRegistryId: ID,
2764status: [SchemaStatus!],
2765majorVersion: Int,
2766name: String,
2767nameMatch: StringMatch,
2768limit: Int,
2769offset: Int,
2770orderBy: [SchemaOrder]
2771): SchemaList
2772
2773# Retrieve a schema for structured data ingestions
2774# Example:
2775# Request:
2776# query {
2777#
2778# schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") {
2779#
2780# definition
2781#
2782# status
2783#
2784# }
2785# }
2786# Response:
2787# {
2788#
2789# "data": {
2790#
2791# "schema": {
2792#
2793# "definition": {
2794#
2795# "example": "example value"
2796#
2797# },
2798#
2799# "status": "draft"
2800#
2801# }
2802#
2803# }
2804# }
2805#
2806# Arguments
2807# id: Supply the ID of the schema to retrieve
2808schema(id: ID!): Schema
2809
2810# Example:
2811# Request:
2812# query {
2813#
2814# schemaProperties(limit: 2) {
2815#
2816# records {
2817#
2818# type
2819#
2820# dataRegistryId
2821#
2822# }
2823#
2824# }
2825# }
2826# Response:
2827# {
2828#
2829# "data": {
2830#
2831# "schemaProperties": {
2832#
2833# "records": [
2834#
2835# {
2836#
2837# "type": "string",
2838#
2839# "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6"
2840#
2841# },
2842#
2843# {
2844#
2845# "type": "string",
2846#
2847# "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c"
2848#
2849# }
2850#
2851# ]
2852#
2853# }
2854#
2855# }
2856# }
2857#
2858# Arguments
2859# limit: Limit
2860# offset: Offset
2861schemaProperties(
2862dataRegistryVersion: [DataRegistryVersion!],
2863search: String,
2864limit: Int,
2865offset: Int
2866): SchemaPropertyList
2867
2868# Retrieve a structured data object
2869# Example:
2870# Request:
2871# query {
2872#
2873# structuredData(
2874#
2875# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2876#
2877# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2878#
2879# data
2880#
2881# }
2882# }
2883# Response:
2884# {
2885#
2886# "data": {
2887#
2888# "structuredData": {
2889#
2890# "data": {
2891#
2892# "example": "example"
2893#
2894# }
2895#
2896# }
2897#
2898# }
2899# }
2900#
2901# Arguments
2902# id: Supply the ID of the structured data object to retrieve.
2903# This will override filters.
2904# schemaId: Schema Id for the structured data object to retrieve
2905structuredData(id: ID!, schemaId: ID!): StructuredData
2906
2907# Retrieve a structured data object
2908# Example:
2909# Request:
2910# query {
2911#
2912# structuredDataObject(
2913#
2914# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2915#
2916# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2917#
2918# data
2919#
2920# }
2921# }
2922# Response:
2923# {
2924#
2925# "data": {
2926#
2927# "structuredDataObject": {
2928#
2929# "data": {
2930#
2931# "example": "example"
2932#
2933# }
2934#
2935# }
2936#
2937# }
2938# }
2939#
2940# Arguments
2941# id: Supply the ID of the structured data object to retrieve.
2942# This will override filters.
2943# schemaId: Schema Id for the structured data object to retrieve
2944structuredDataObject(id: ID!, schemaId: ID!): StructuredData
2945
2946# Retrieve a paginated list of structured data object
2947# Example:
2948# Request:
2949# query {
2950#
2951# structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2952#
2953# records {
2954#
2955# id
2956#
2957# data
2958#
2959# }
2960#
2961# }
2962# }
2963# Response:
2964# {
2965#
2966# "data": {
2967#
2968# "structuredDataObjects": {
2969#
2970# "records": [
2971#
2972# {
2973#
2974# "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2975#
2976# "data": {
2977#
2978# "example": "example"
2979#
2980# }
2981#
2982# },
2983#
2984# {
2985#
2986# "id": "f914eafe-ed9b-46b1-a48d-effd5575764a",
2987#
2988# "data": {
2989#
2990# "example": "example"
2991#
2992# }
2993#
2994# }
2995#
2996# ]
2997#
2998# }
2999#
3000# }
3001# }
3002#
3003# Arguments
3004# id: Supply the ID of the structured data object to retrieve.
3005# This will override filters.
3006# ids: List of Ids of the structured data objects to retrieve.
3007# This will override filters.
3008# schemaId: Schema Id for the structured data object to retrieve
3009# filter: Query to filter SDO. Supports operations such as and,
3010# or, eq, gt, lt, etc.
3011# TODO link to syntax documentation
3012structuredDataObjects(
3013id: ID,
3014ids: [ID!],
3015schemaId: ID!,
3016orderBy: [StructuredDataOrderBy!],
3017limit: Int,
3018offset: Int,
3019owned: Boolean,
3020filter: JSONData
3021): StructuredDataList
3022
3023# Returns information about the GraphQL server, useful
3024# for diagnostics. This data is primarily used by Veritone
3025# development, and some fields may be restricted to Veritone administrators.
3026graphqlServiceInfo: GraphQLServiceInfo
3027
3028# Returns a signed writable S3 URL. A client can then
3029# upload to this URL with an HTTP PUT without providing
3030# any additional authorization (_note_: it must be a PUT.
3031# A POST will fail.)
3032# Example:
3033# Request:
3034# query {
3035#
3036# getSignedWritableUrl(type: "preview") {
3037#
3038# bucket
3039#
3040# key
3041#
3042# url
3043#
3044# }
3045# }
3046# Response:
3047# {
3048#
3049# "data": {
3050#
3051# "getSignedWritableUrl": {
3052#
3053# "bucket": "prod-api.veritone.com",
3054#
3055# "key":
3056# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3057#
3058# "url":
3059# "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"
3060#
3061# }
3062#
3063# }
3064# }
3065#
3066# Arguments
3067# key: Optional key of the object to generate a writable
3068# URL for. If not provided, a new, unique key will
3069# be generated. If a key is provided and resembles a file name
3070# (with extension delimited by .), a UUID will be inserted
3071# into the file name, leaving the extension intact.
3072# If a key is provided and does not resemble
3073# a file name, a UUID will be appended.
3074# type: Optional type of resource, such as `asset`, `thumbnail`,
3075# `discovery-analytics` or `preview`
3076# path: Optional extended path information. If the uploaded
3077# content will be contained
3078# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3079# (for `entityIdentifier`), the ID of the object should be provided here.
3080# expiresInSeconds: Optional expiresInSeconds custom expiration
3081# to signedUrlExpires
3082# Max expiresInSeconds up to 604800
3083# organizationId: Optional organization ID. Normally this value
3084# is computed by the server
3085# based on the authorization token used for the request.
3086# Is is used only by Veritone platform components.
3087getSignedWritableUrl(
3088key: String,
3089type: String,
3090path: String,
3091expiresInSeconds: Int,
3092organizationId: ID
3093): WritableUrlInfo
3094
3095# Return writable storage URLs in bulk.
3096# A maximum of 1000 can be created in one call.
3097# See `getSignedWritableUrl` for details on usage of the
3098# response contents.
3099# Example:
3100# Request:
3101# query {
3102#
3103# getSignedWritableUrls(number: 2) {
3104#
3105# bucket
3106#
3107# key
3108#
3109# url
3110#
3111# }
3112# }
3113# Response:
3114# {
3115#
3116# "data": {
3117#
3118# "getSignedWritableUrls": [
3119#
3120# {
3121#
3122# "bucket": "prod-api.veritone.com",
3123#
3124# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3125#
3126# "url":
3127# "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"
3128#
3129# },
3130#
3131# {
3132#
3133# "bucket": "prod-api.veritone.com",
3134#
3135# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3136#
3137# "url":
3138# "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"
3139#
3140# }
3141#
3142# ]
3143#
3144# }
3145# }
3146#
3147# Arguments
3148# number: Number of signed URLs to return
3149# type: Optional type of resource, such as `asset`, `thumbnail`,
3150# or `preview`
3151# path: Optional extended path information. If the uploaded
3152# content will be contained
3153# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3154# (for `entityIdentifier`), the ID of the object should be provided here.
3155# organizationId: Optional organization ID. Normally this value
3156# is computed by the server
3157# based on the authorization token used for the request.
3158# Is is used only by Veritone platform components.
3159getSignedWritableUrls(
3160number: Int!,
3161type: String,
3162path: String,
3163organizationId: ID
3164): [WritableUrlInfo!]!
3165
3166# Retrieve the rights of the current user
3167# Example:
3168# Request:
3169# query {
3170#
3171# myRights {
3172#
3173# resources
3174#
3175# operations
3176#
3177# }
3178# }
3179# Response:
3180# {
3181#
3182# "data": {
3183#
3184# "myRights": {
3185#
3186# "resources": {},
3187#
3188# "operations": [
3189#
3190# "admin.access",
3191#
3192# "admin.org.read",
3193#
3194# "admin.org.update",
3195#
3196# "admin.user.create",
3197#
3198# "admin.user.read",
3199#
3200# "admin.user.update",
3201#
3202# "admin.user.delete",
3203#
3204# ...
3205#
3206# ]
3207#
3208# }
3209#
3210# }
3211# }
3212myRights: RightsListing
3213
3214# Retrieve the shared folders for an organization
3215# Example:
3216# Request:
3217# query {
3218#
3219# sharedFolders {
3220#
3221# id
3222#
3223# }
3224# }
3225# Response:
3226# {
3227#
3228# "data": {
3229#
3230# "sharedFolders": []
3231#
3232# }
3233# }
3234sharedFolders: [Folder]
3235
3236# Retrieve multiple watchlists
3237# Example:
3238# Request:
3239# query {
3240#
3241# watchlists(limit: 2) {
3242#
3243# records {
3244#
3245# id
3246#
3247# name
3248#
3249# }
3250#
3251# }
3252# }
3253# Response:
3254# {
3255#
3256# "data": {
3257#
3258# "watchlists": {
3259#
3260# "records": [
3261#
3262# {
3263#
3264# "id": "326916",
3265#
3266# "name": "example"
3267#
3268# },
3269#
3270# {
3271#
3272# "id": "325791",
3273#
3274# "name": "example"
3275#
3276# }
3277#
3278# ]
3279#
3280# }
3281#
3282# }
3283# }
3284#
3285# Arguments
3286# isDisabled: Set `true` to include only disabled watchlist or
3287# `false` to include only enabled watchlists. By default,
3288# both are included.
3289# names: Provide a list of names to filter folders
3290watchlists(
3291id: ID,
3292maxStopDateTime: DateTime,
3293minStopDateTime: DateTime,
3294minStartDateTime: DateTime,
3295maxStartDateTime: DateTime,
3296name: String,
3297offset: Int,
3298limit: Int,
3299orderBy: WatchlistOrderBy,
3300orderDirection: OrderDirection,
3301isDisabled: Boolean,
3302names: [String],
3303nameMatch: StringMatch
3304): WatchlistList
3305
3306# Retrieve a single watchlist by id
3307# Example:
3308# Request:
3309# query {
3310#
3311# watchlist(id: "325791") {
3312#
3313# name
3314#
3315# watchlistType
3316#
3317# }
3318# }
3319# Response:
3320# {
3321#
3322# "data": {
3323#
3324# "watchlist": {
3325#
3326# "name": "example",
3327#
3328# "watchlistType": "tracking"
3329#
3330# }
3331#
3332# }
3333# }
3334watchlist(id: ID!): Watchlist
3335
3336# Example:
3337# Request:
3338# query {
3339#
3340# mentionStatusOptions {
3341#
3342# id
3343#
3344# name
3345#
3346# }
3347# }
3348# Response:
3349# {
3350#
3351# "data": {
3352#
3353# "mentionStatusOptions": [
3354#
3355# {
3356#
3357# "id": "7",
3358#
3359# "name": "Auto Verified"
3360#
3361# },
3362#
3363# {
3364#
3365# "id": "5",
3366#
3367# "name": "Invalid"
3368#
3369# },
3370#
3371# {
3372#
3373# "id": "3",
3374#
3375# "name": "Needs Review"
3376#
3377# },
3378#
3379# {
3380#
3381# "id": "1",
3382#
3383# "name": "Pending Verification"
3384#
3385# },
3386#
3387# {
3388#
3389# "id": "6",
3390#
3391# "name": "Processing Verification"
3392#
3393# },
3394#
3395# {
3396#
3397# "id": "4",
3398#
3399# "name": "Request Bonus"
3400#
3401# },
3402#
3403# {
3404#
3405# "id": "2",
3406#
3407# "name": "Verified"
3408#
3409# }
3410#
3411# ]
3412#
3413# }
3414# }
3415mentionStatusOptions: [MentionStatus!]!
3416
3417# Retrieve multiple data registries
3418# Example:
3419# Request:
3420# query {
3421#
3422# dataRegistries(limit: 2) {
3423#
3424# records {
3425#
3426# id
3427#
3428# name
3429#
3430# }
3431#
3432# }
3433# }
3434# Response:
3435# {
3436#
3437# "data": {
3438#
3439# "dataRegistries": {
3440#
3441# "records": [
3442#
3443# {
3444#
3445# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
3446#
3447# "name": "example"
3448#
3449# },
3450#
3451# {
3452#
3453# "id": "317c941d-30d0-455e-882b-34a26e513364",
3454#
3455# "name": "example"
3456#
3457# }
3458#
3459# ]
3460#
3461# }
3462#
3463# }
3464# }
3465dataRegistries(
3466id: ID,
3467ids: [ID!],
3468name: String,
3469nameMatch: StringMatch,
3470offset: Int,
3471limit: Int,
3472orderBy: DataRegistryOrderBy,
3473orderDirection: OrderDirection,
3474filterByOwnership: SchemaOwnership
3475): DataRegistryList
3476
3477# Retrieve a single data registry
3478# Example:
3479# Request:
3480# query {
3481#
3482# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
3483#
3484# name
3485#
3486# organizationId
3487#
3488# source
3489#
3490# }
3491# }
3492# Response:
3493# {
3494#
3495# "data": {
3496#
3497# "dataRegistry": {
3498#
3499# "name": "example",
3500#
3501# "organizationId": "35521",
3502#
3503# "source": "veritone-35521.datasets"
3504#
3505# }
3506#
3507# }
3508# }
3509dataRegistry(id: ID!): DataRegistry
3510
3511# Retrieve a subscription by id
3512# Example:
3513# Request:
3514# query {
3515#
3516# subscription(id: "275818") {
3517#
3518# isActive
3519#
3520# jsondata
3521#
3522# }
3523# }
3524# Response:
3525# {
3526#
3527# "data": {
3528#
3529# "subscription": {
3530#
3531# "isActive": true,
3532#
3533# "jsondata": {
3534#
3535# "tracking_unit_id": "325791",
3536#
3537# "creator_email": "example email",
3538#
3539# "unsubscribe_hash":
3540# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
3541#
3542# }
3543#
3544# }
3545#
3546# }
3547# }
3548subscription(id: ID!): Subscription!
3549
3550cognitiveSearch(id: ID!): CognitiveSearch!
3551
3552# Retrieve multiple collections
3553# Example:
3554# Request:
3555# query {
3556#
3557# collections {
3558#
3559# records {
3560#
3561# id
3562#
3563# name
3564#
3565# }
3566#
3567# }
3568# }
3569# Response:
3570# {
3571#
3572# "data": {
3573#
3574# "collections": {
3575#
3576# "records": [
3577#
3578# {
3579#
3580# "id": "241121",
3581#
3582# "name": "example"
3583#
3584# },
3585#
3586# {
3587#
3588# "id": "242599",
3589#
3590# "name": "example"
3591#
3592# },
3593#
3594# {
3595#
3596# "id": "243625",
3597#
3598# "name": "example"
3599#
3600# }
3601#
3602# ]
3603#
3604# }
3605#
3606# }
3607# }
3608collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
3609
3610# Retrieve a collection by id
3611# Example:
3612# Request:
3613# query {
3614#
3615# collection(id: "241121") {
3616#
3617# name
3618#
3619# isActive
3620#
3621# }
3622# }
3623# Response:
3624# {
3625#
3626# "data": {
3627#
3628# "collection": {
3629#
3630# "name": "example",
3631#
3632# "isActive": true
3633#
3634# }
3635#
3636# }
3637# }
3638collection(id: ID!): Collection!
3639
3640collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
3641
3642# Retrieve a list of collection mentions
3643# Specify at least one of folderId or mentionId
3644collectionMentions(
3645folderId: ID,
3646mentionId: ID,
3647orderBy: CollectionMentionOrderBy,
3648limit: Int,
3649offset: Int
3650): CollectionMentionList!
3651
3652# Retrieve multiple mentions
3653# Example:
3654# Request:
3655# query {
3656#
3657# mentions {
3658#
3659# records {
3660#
3661# id
3662#
3663# }
3664#
3665# }
3666# }
3667# Response:
3668# {
3669#
3670# "data": {
3671#
3672# "mentions": {
3673#
3674# "records": []
3675#
3676# }
3677#
3678# }
3679# }
3680#
3681# Arguments
3682# watchlistId: Get mentions created from the specified watchlist
3683# sourceId: Get mentions associated with the specified source
3684# sourceTypeId: Get mentions associated with sources of the
3685# specified source type
3686# tdoId: Get mentions associated directly with the specific TDO
3687# dateTimeFilter: Specify date/time filters against mention
3688# fields.
3689# Querying for mentions can be expensive. If the query does not
3690# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
3691# a user-provided `dateTimeFilter`, a default filter of the
3692# past 7 days is applied.
3693# orderBy: Set order information on the query. Multiple fields
3694# are supported.
3695# folderId: Provide a folder ID to filter by collection
3696mentions(
3697id: ID,
3698watchlistId: ID,
3699sourceId: ID,
3700sourceTypeId: ID,
3701tdoId: ID,
3702dateTimeFilter: [MentionDateTimeFilter!],
3703orderBy: [MentionOrderBy!],
3704offset: Int,
3705limit: Int,
3706folderId: ID
3707): MentionList
3708
3709# Retrieves engine results by TDO and engine ID or by job ID.
3710# Example:
3711# Request:
3712# query {
3713#
3714# engineResults(
3715#
3716# tdoId: "1580507556",
3717#
3718# engineIds: "4") {
3719#
3720# sourceId
3721#
3722# records {
3723#
3724# tdoId
3725#
3726# }
3727#
3728# }
3729# }
3730# Response:
3731# {
3732#
3733# "data": {
3734#
3735# "engineResults": {
3736#
3737# "sourceId": null,
3738#
3739# "records": []
3740#
3741# }
3742#
3743# }
3744# }
3745#
3746# Arguments
3747# tdoId: Provide the ID of the TDO containing engine results to
3748# retrieve.
3749# If this parameter is used, engineIds or engineCategoryIds must also be set.
3750# Results for _only_ the specified TDO will be returned.
3751# sourceId: Provide the ID of the Source containing engine
3752# results to retrieve.
3753# If this parameter is used, engineIds or engineCategoryIds must also be set.
3754# This takes priority over tdoId.
3755# engineIds: Provide one or more engine IDs to retrieve engine
3756# results by
3757# ID. This parameter is mandatory if tdoId is used, but optional
3758# if jobId or engineCategory is used.
3759# engineCategoryIds: Provide one or more category IDs to get all
3760# results from that categroy.
3761# jobId: Provide a job ID to retrieve engine results for the job.
3762# mentionId: Provide a mention ID to retrieve engine results for
3763# the mention.
3764# startOffsetMs: Start offset ms for the results.
3765# stopOffsetMs: End offset ms for the results.
3766# startDate: Start date for the results. Takes priority over
3767# startOffsetMs.
3768# stopDate: End date for the results. Takes priority over
3769# stopOffsetMs.
3770# ignoreUserEdited: Whether or not to exclude user edited engine
3771# results. Defaults to false.
3772# fallbackTdoId: A TDO ID can be provided for use if the provided
3773# `sourceId` and/or
3774# `mentionId` parameters do not resolve to a logical set of TDOs.
3775# Depending on parameter settings and available data,
3776# results from other TDOs can be included in the response.
3777engineResults(
3778tdoId: ID,
3779sourceId: ID,
3780engineIds: [ID!],
3781engineCategoryIds: [ID!],
3782jobId: ID,
3783mentionId: ID,
3784startOffsetMs: Int,
3785stopOffsetMs: Int,
3786startDate: DateTime,
3787stopDate: DateTime,
3788ignoreUserEdited: Boolean,
3789fallbackTdoId: ID
3790): EngineResultList
3791
3792# Retrieve a trigger by id
3793# Example:
3794# Request:
3795# query {
3796#
3797# trigger(id: "2998") {
3798#
3799# target
3800#
3801# createdDateTime
3802#
3803# }
3804# }
3805# Response:
3806# {
3807#
3808# "data": {
3809#
3810# "trigger": {
3811#
3812# "target": "Email",
3813#
3814# "createdDateTime": "2021-06-18T13:35:08.631Z"
3815#
3816# }
3817#
3818# }
3819# }
3820trigger(id: ID!): Trigger
3821
3822# Retrieve triggers
3823# Example:
3824# Request:
3825# query {
3826#
3827# triggers {
3828#
3829# id
3830#
3831# }
3832# }
3833# Response:
3834# {
3835#
3836# "data": {
3837#
3838# "triggers": [
3839#
3840# {
3841#
3842# "id": "2998"
3843#
3844# }
3845#
3846# ]
3847#
3848# }
3849# }
3850triggers: [Trigger]
3851
3852# Fetch all saved searches that the current user has made
3853# Fetch all saved searches that have been shared with
3854# the current users organization
3855# Include any saved searches that the user has created
3856# Example:
3857# Request:
3858# query {
3859#
3860# savedSearches {
3861#
3862# records {
3863#
3864# id
3865#
3866# name
3867#
3868# }
3869#
3870# }
3871# }
3872# Response:
3873# {
3874#
3875# "data": {
3876#
3877# "savedSearches": {
3878#
3879# "records": [
3880#
3881# {
3882#
3883# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
3884#
3885# "name": "example"
3886#
3887# }
3888#
3889# ]
3890#
3891# }
3892#
3893# }
3894# }
3895savedSearches(
3896offset: Int,
3897limit: Int,
3898includeShared: Boolean,
3899filterByName: String,
3900orderBy: SavedSearchOrderBy,
3901orderDirection: OrderDirection
3902): SavedSearchList!
3903
3904# Retrieve a list of export requests
3905# Example:
3906# Request:
3907# query {
3908#
3909# exportRequests(limit: 2) {
3910#
3911# records {
3912#
3913# id
3914#
3915# organizationId
3916#
3917# }
3918#
3919# }
3920# }
3921# Response:
3922# {
3923#
3924# "data": {
3925#
3926# "exportRequests": {
3927#
3928# "records": [
3929#
3930# {
3931#
3932# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
3933#
3934# "organizationId": "35521"
3935#
3936# }
3937#
3938# ]
3939#
3940# }
3941#
3942# }
3943# }
3944#
3945# Arguments
3946# id: Provide an ID to retrieve a single export request
3947# offset: Provide an offset to skip to a certain element in the
3948# result, for paging.
3949# limit: Specify maximum number of results to retrieve in this
3950# result. Page size.
3951# status: Provide a list of status options to filter by status
3952# event: Provide an event to retrieve export request. Should be
3953# 'exportRequest' or 'mentionExportRequest'
3954# Default value is 'exportRequest'
3955exportRequests(
3956id: ID,
3957offset: Int,
3958limit: Int,
3959status: [ExportRequestStatus!],
3960event: ExportRequestEvent
3961): ExportRequestList!
3962
3963# Retrieve a single export request by id
3964# Example:
3965# Request:
3966# query {
3967#
3968# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
3969#
3970# id
3971#
3972# organizationId
3973#
3974# requestorId
3975#
3976# status
3977#
3978# }
3979# }
3980# Response:
3981# {
3982#
3983# "data": {
3984#
3985# "exportRequest": {
3986#
3987# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
3988#
3989# "organizationId": "35521",
3990#
3991# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
3992#
3993# "status": "complete"
3994#
3995# }
3996#
3997# }
3998# }
3999#
4000# Arguments
4001# event: Provide an event to retrieve export request. Should be
4002# 'exportRequest' or 'mentionExportRequest'
4003# Default value is 'exportRequest'
4004exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4005
4006# Retrieve a event by id
4007# Example:
4008# Request:
4009# query {
4010#
4011# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4012#
4013# eventName
4014#
4015# eventType
4016#
4017# description
4018#
4019# }
4020# }
4021# Response:
4022# {
4023#
4024# "data": {
4025#
4026# "event": {
4027#
4028# "eventName": "example",
4029#
4030# "eventType": "example",
4031#
4032# "description": "new example description"
4033#
4034# }
4035#
4036# }
4037# }
4038event(id: ID!): Event!
4039
4040# Retrieve a list of events by application
4041# Example:
4042# Request:
4043# query {
4044#
4045# events(
4046#
4047# application: "system",
4048#
4049# limit: 2) {
4050#
4051# records {
4052#
4053# id
4054#
4055# eventName
4056#
4057# }
4058#
4059# }
4060# }
4061# Response:
4062# {
4063#
4064# "data": {
4065#
4066# "events": {
4067#
4068# "records": [
4069#
4070# {
4071#
4072# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4073#
4074# "eventName": "ActionTokenForbidden"
4075#
4076# },
4077#
4078# {
4079#
4080# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4081#
4082# "eventName": "ActionUserForbidden"
4083#
4084# }
4085#
4086# ]
4087#
4088# }
4089#
4090# }
4091# }
4092#
4093# Arguments
4094# application: Provide an application to retrieve all its events.
4095# Use 'system' to list all public system events.
4096# offset: Provide an offset to skip to a certain element in the
4097# result, for paging.
4098# limit: Specify maximum number of results to retrieve in this
4099# result. Page size.
4100events(application: String!, offset: Int, limit: Int): EventList!
4101
4102# Retrieve a list of subscriptions by organization
4103# Example:
4104# Request:
4105# query {
4106#
4107# eventSubscriptions(limit: 2) {
4108#
4109# records {
4110#
4111# id
4112#
4113# eventName
4114#
4115# }
4116#
4117# }
4118# }
4119# Response:
4120# {
4121#
4122# "data": {
4123#
4124# "eventSubscriptions": {
4125#
4126# "records": [
4127#
4128# {
4129#
4130# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4131#
4132# "eventName": "LibraryTrainingComplete"
4133#
4134# },
4135#
4136# {
4137#
4138# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4139#
4140# "eventName": "LibraryTrainingComplete"
4141#
4142# }
4143#
4144# ]
4145#
4146# }
4147#
4148# }
4149# }
4150#
4151# Arguments
4152# ids: The event subscription ids
4153# eventName: The name of the event
4154# eventType: The type of event, such as `mention`, `job`,
4155# `engine`.
4156# offset: Provide an offset to skip to a certain element in the
4157# result, for paging.
4158# limit: Specify maximum number of results to retrieve in this
4159# result. Page size.
4160eventSubscriptions(
4161ids: [ID!],
4162eventName: String,
4163eventType: String,
4164offset: Int,
4165limit: Int
4166): EventSubscriptionList!
4167
4168# Retrieve a subscription by id
4169# Example:
4170# Request:
4171# query {
4172#
4173# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4174#
4175# id
4176#
4177# organizationId
4178#
4179# eventName
4180#
4181# targetName
4182#
4183# }
4184# }
4185# Response:
4186# {
4187#
4188# "data": {
4189#
4190# "eventSubscription": {
4191#
4192# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4193#
4194# "organizationId": "35521",
4195#
4196# "eventName": "LibraryTrainingComplete",
4197#
4198# "targetName": "NotificationMailbox"
4199#
4200# }
4201#
4202# }
4203# }
4204eventSubscription(id: ID!): EventSubscription!
4205
4206# Example:
4207# Request:
4208# query {
4209#
4210# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4211#
4212# organizationId
4213#
4214# actionType
4215#
4216# name
4217#
4218# }
4219# }
4220# Response:
4221# {
4222#
4223# "data": {
4224#
4225# "eventActionTemplate": {
4226#
4227# "organizationId": "35521",
4228#
4229# "actionType": "job",
4230#
4231# "name": "example"
4232#
4233# }
4234#
4235# }
4236# }
4237eventActionTemplate(id: ID!): EventActionTemplate
4238
4239# Example:
4240# Request:
4241# query {
4242#
4243# eventActionTemplates(
4244#
4245# inputType: event,
4246#
4247# actionType: job
4248#
4249# limit:2) {
4250#
4251# records {
4252#
4253# id
4254#
4255# name
4256#
4257# }
4258#
4259# }
4260# }
4261# Response:
4262# {
4263#
4264# "data": {
4265#
4266# "eventActionTemplates": {
4267#
4268# "records": [
4269#
4270# {
4271#
4272# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4273#
4274# "name": "example"
4275#
4276# },
4277#
4278# {
4279#
4280# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4281#
4282# "name": "example"
4283#
4284# }
4285#
4286# ]
4287#
4288# }
4289#
4290# }
4291# }
4292#
4293# Arguments
4294# ownerApplicationId: The application id
4295# inputType: use "event" for now. In the future, we allow
4296# additional input_type types. For example, a schedule or a tweet.
4297# actionType: Either "job", "webhook", "sms", "email". Future
4298# action_type could be "gql" where action is purely a function call.
4299# offset: Provide an offset to skip to a certain element in the
4300# result, for paging.
4301# limit: Specify maximum number of results to retrieve in this
4302# result. Page size.
4303eventActionTemplates(
4304ownerApplicationId: ID,
4305inputType: EventActionTemplateInputType,
4306actionType: EventActionTemplateActionType,
4307offset: Int,
4308limit: Int
4309): EventActionTemplateList!
4310
4311# Example:
4312# Request:
4313# query {
4314#
4315# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4316#
4317# name
4318#
4319# eventName
4320#
4321# description
4322#
4323# }
4324# }
4325# Response:
4326# {
4327#
4328# "data": {
4329#
4330# "eventCustomRule": {
4331#
4332# "name": "example",
4333#
4334# "eventName": "example",
4335#
4336# "description": "example description"
4337#
4338# }
4339#
4340# }
4341# }
4342eventCustomRule(id: ID!): EventCustomRule
4343
4344# Example:
4345# Request:
4346# query {
4347#
4348# eventCustomRules(limit: 2) {
4349#
4350# records {
4351#
4352# id
4353#
4354# name
4355#
4356# }
4357#
4358# }
4359# }
4360# Response:
4361# {
4362#
4363# "data": {
4364#
4365# "eventCustomRules": {
4366#
4367# "records": [
4368#
4369# {
4370#
4371# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
4372#
4373# "name": "example"
4374#
4375# }
4376#
4377# ]
4378#
4379# }
4380#
4381# }
4382# }
4383#
4384# Arguments
4385# offset: the offset to skip to a certain element in the result
4386# limit: the maximum number of rows in the results
4387eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
4388
4389# This query returns information about time zones recognized by this
4390#
4391# server. The information is static and does not change.
4392#
4393# Example:
4394#
4395# Request:
4396#
4397# query {
4398#
4399# timeZones {
4400#
4401# name
4402#
4403# abbreviations{
4404#
4405# name
4406#
4407# }
4408#
4409# }
4410# }
4411# Response:
4412# {
4413#
4414# "data": {
4415#
4416# "timeZones": [
4417#
4418# {
4419#
4420# "name": "Africa/Abidjan",
4421#
4422# "abbreviations": [
4423#
4424# {
4425#
4426# "name": "GMT"
4427#
4428# }
4429#
4430# ]
4431#
4432# },
4433#
4434# {
4435#
4436# "name": "Africa/Accra",
4437#
4438# "abbreviations": [
4439#
4440# {
4441#
4442# "name": "GMT"
4443#
4444# },
4445#
4446# {
4447#
4448# "name": "+0020"
4449#
4450# }
4451#
4452# ]
4453#
4454# },
4455#
4456# {
4457#
4458# "name": "Africa/Lagos",
4459#
4460# "abbreviations": [
4461#
4462# {
4463#
4464# "name": "WAT"
4465#
4466# }
4467#
4468# ]
4469#
4470# },
4471#
4472# ...
4473#
4474# ...
4475#
4476# ]
4477#
4478# }
4479#
4480# ]
4481#
4482# }
4483# }
4484timeZones: [TimeZone!]!
4485
4486# Examine entries from the audit log. All operations that modify data are
4487# written to the audit log. Only entries for the user's own organization
4488# can be queried.
4489# All queries are bracketed by a time window. A default time window is applied
4490# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
4491# The maximum time window length is 30 days.
4492# Only Veritone and organization administrators can use this query.
4493# Example:
4494# Request:
4495# query {
4496#
4497# auditLog(limit: 2) {
4498#
4499# records {
4500#
4501# id
4502#
4503# objectId
4504#
4505# description
4506#
4507# }
4508#
4509# }
4510# }
4511# Response:
4512# {
4513#
4514# "data": {
4515#
4516# "auditLog": {
4517#
4518# "records": [
4519#
4520# {
4521#
4522# "id": "735915311",
4523#
4524# "objectId": "*********",
4525#
4526# "description": "Changed password"
4527#
4528# },
4529#
4530# {
4531#
4532# "id": "735915307",
4533#
4534# "objectId": "********",
4535#
4536# "description": "Changed password"
4537#
4538# }
4539#
4540# ]
4541#
4542# }
4543#
4544# }
4545# }
4546#
4547# Arguments
4548# toDateTime: Date/time up to which entries will be returned. In
4549# other words, the
4550# end of the query time window.
4551# Defaults to the current time.
4552# fromDateTime: Date/time from which entries will be returned. In
4553# other words, the
4554# start of the query time window.
4555# Defaults to the `toDateTime` minus 7 days.
4556# organizationId: Organization ID to query records for. This