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# offset: Provide an offset to skip to a certain element in the
1356# result, for paging.
1357# limit: Specify maximum number of results to retrieve in this
1358# result. Page size.
1359applications(
1360id: ID,
1361status: ApplicationStatus,
1362owned: Boolean,
1363orgId: ID,
1364offset: Int,
1365limit: Int
1366): ApplicationList
1367
1368# Retrieve organizations
1369# Example:
1370# Request:
1371# query {
1372#
1373# organizations(limit:2) {
1374#
1375# records {
1376#
1377# id
1378#
1379# name
1380#
1381# }
1382#
1383# }
1384# }
1385# Response:
1386# {
1387#
1388# "data": {
1389#
1390# "organizations": {
1391#
1392# "records": [
1393#
1394# {
1395#
1396# "id": "35521",
1397#
1398# "name": "WTS API Docs Org"
1399#
1400# }
1401#
1402# ]
1403#
1404# }
1405#
1406# }
1407# }
1408#
1409# Arguments
1410# id: Provide an ID to retrieve a single specific organization.
1411# offset: Provide an offset to skip to a certain element in the
1412# result, for paging.
1413# limit: Specify maximum number of results to retrieve in this
1414# result. Page size.
1415# kvpProperty: Provide a property from the organization kvp to
1416# filter the organization list.
1417# kvpValue: Provide value to for the kvpFeature filter.
1418# If not present the filter becomes kvpProperty existence filter
1419# name: Optionally, supply a string for string match
1420# nameMatch: Supply the type of string match to apply.
1421organizations(
1422id: ID,
1423offset: Int,
1424limit: Int,
1425kvpProperty: String,
1426kvpValue: String,
1427name: String,
1428nameMatch: StringMatch
1429): OrganizationList
1430
1431# Retrieve a single organization
1432# Example:
1433# Request:
1434# query {
1435#
1436# organization(id: "35521") {
1437#
1438# status
1439#
1440# }
1441# }
1442# Response:
1443# {
1444#
1445# "data": {
1446#
1447# "organization": {
1448#
1449# "status": "active"
1450#
1451# }
1452#
1453# }
1454# }
1455#
1456# Arguments
1457# id: The organization ID
1458# TODO take application ID as well as org ID
1459organization(id: ID!): Organization
1460
1461# Retrieve organizations to which the user belongs
1462# Example:
1463# Request:
1464# query {
1465#
1466# myOrganizations {
1467#
1468# records {
1469#
1470# id
1471#
1472# name
1473#
1474# }
1475#
1476# }
1477# }
1478# Response:
1479# {
1480#
1481# "data": {
1482#
1483# "myOrganizations": {
1484#
1485# "records": [
1486#
1487# {
1488#
1489# "id": "35521",
1490#
1491# "name": "WTS API Docs Org"
1492#
1493# }
1494#
1495# ]
1496#
1497# }
1498#
1499# }
1500# }
1501#
1502# Arguments
1503# userName: User name to uniquely identify a user
1504# offset: Provide an offset to skip to a certain element in the
1505# result, for paging.
1506# limit: Specify maximum number of results to retrieve in this
1507# result. Page size.
1508myOrganizations(userName: String, offset: Int, limit: Int): OrganizationList
1509
1510# Retrieve permissions
1511# Example:
1512# Request:
1513# query {
1514#
1515# permissions(limit:5) {
1516#
1517# records {
1518#
1519# id
1520#
1521# name
1522#
1523# }
1524#
1525# }
1526# }
1527#
1528# Response:
1529# {
1530#
1531# "data": {
1532#
1533# "permissions": {
1534#
1535# "records": [
1536#
1537# {
1538#
1539# "id": "2",
1540#
1541# "name": "admin.access"
1542#
1543# },
1544#
1545# {
1546#
1547# "id": "9",
1548#
1549# "name": "admin.group.create"
1550#
1551# },
1552#
1553# {
1554#
1555# "id": "12",
1556#
1557# "name": "admin.group.delete"
1558#
1559# },
1560#
1561# {
1562#
1563# "id": "10",
1564#
1565# "name": "admin.group.read"
1566#
1567# },
1568#
1569# {
1570#
1571# "id": "11",
1572#
1573# "name": "admin.group.update"
1574#
1575# }
1576#
1577# ]
1578#
1579# }
1580#
1581# }
1582# }
1583#
1584# Arguments
1585# id: Provide an ID to retrieve a single specific permission.
1586# offset: Provide an offset to skip to a certain element in the
1587# result, for paging.
1588# limit: Specify maximum number of results to retrieve in this
1589# result. Page size.
1590permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
1591
1592# Retrieve users
1593# Example:
1594# Request:
1595# query {
1596#
1597# users(
1598#
1599# organizationIds:"35521",
1600#
1601# limit: 2) {
1602#
1603# records {
1604#
1605# id
1606#
1607# name
1608#
1609# }
1610#
1611# }
1612# }
1613# Response:
1614# {
1615#
1616# "data": {
1617#
1618# "users": {
1619#
1620# "records": [
1621#
1622# {
1623#
1624# "id": "267de7e1-efb2-444a-a524-210328b78503",
1625#
1626# "name": "example"
1627#
1628# },
1629#
1630# {
1631#
1632# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066",
1633#
1634# "name": "example1"
1635#
1636# }
1637#
1638# ]
1639#
1640# }
1641#
1642# }
1643# }
1644#
1645# Arguments
1646# id: Provide an ID to retrieve a single specific user.
1647# A user ID is a string in UUID format.
1648# ids: Provide IDs to retrieve multiple users by ID.
1649# name: Provide a name, or part of one, to search by name.
1650# organizationIds: Provide a list of organization IDs to filter
1651# your search by organization.
1652# offset: Provide an offset to skip to a certain element in the
1653# result, for paging.
1654# limit: Specify maximum number of results to retrieve in this
1655# result. Page size.
1656# includeAllOrgUsers: Include all organization users.
1657# dateTimeFilter: Filter by date/time field
1658# status: Filter by account status
1659users(
1660id: ID,
1661ids: [ID],
1662name: String,
1663organizationIds: [ID],
1664offset: Int,
1665limit: Int,
1666includeAllOrgUsers: Boolean,
1667dateTimeFilter: [UsersDateTimeFilter!],
1668status: UserStatus
1669): UserList
1670
1671# Retrieve an individual user
1672# Example:
1673# Request:
1674# query {
1675#
1676# user(id: "267de7e1-efb2-444a-a524-210328b78503") {
1677#
1678# name
1679#
1680# status
1681#
1682# }
1683# }
1684# Response:
1685# {
1686#
1687# "data": {
1688#
1689# "user": {
1690#
1691# "name": "example",
1692#
1693# "status": "deleted"
1694#
1695# }
1696#
1697# }
1698# }
1699#
1700# Arguments
1701# id: The user ID.
1702# A user ID is a string in UUID format.
1703user(id: ID!, organizationIds: [ID]): User
1704
1705# Retrieve user's organization API tokens
1706# Example:
1707# Request:
1708# query {
1709#
1710# tokens {
1711#
1712# id
1713#
1714# applicationId
1715#
1716# }
1717# }
1718# Response:
1719# {
1720#
1721# "data": {
1722#
1723# "tokens": []
1724#
1725# }
1726# }
1727tokens: [Token]
1728
1729# Retrieve information for the current logged-in user
1730# Example:
1731# Request:
1732# query {
1733#
1734# me {
1735#
1736# id
1737#
1738# organizationId
1739#
1740# }
1741# }
1742# Response:
1743# {
1744#
1745# "data": {
1746#
1747# "me": {
1748#
1749# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008",
1750#
1751# "organizationId": "35521"
1752#
1753# }
1754#
1755# }
1756# }
1757me: User
1758
1759# Retrieve groups
1760# Example:
1761# Request:
1762# query {
1763#
1764# groups {
1765#
1766# records {
1767#
1768# id
1769#
1770# name
1771#
1772# }
1773#
1774# }
1775# }
1776# Response:
1777# {
1778#
1779# "data": {
1780#
1781# "groups": {
1782#
1783# "records": [
1784#
1785# {
1786#
1787# "id": "8db639c1-c926-4f83-90de-d86c2ae5973d",
1788#
1789# "name": "WTS API Docs Org"
1790#
1791# }
1792#
1793# ]
1794#
1795# }
1796#
1797# }
1798# }
1799#
1800# Arguments
1801# id: Provide an ID to retrieve a specific group by ID
1802# ids: Provide IDs to retrieve multiple groups by ID
1803# name: Provide a name, or part of one, to search for groups by
1804# name
1805# organizationIds: "
1806# Provide a list of organization IDs to retrieve groups defined
1807# within certain organizations.
1808# offset: Provide an offset to skip to a certain element in the
1809# result, for paging.
1810# limit: Specify maximum number of results to retrieve in this
1811# result. Page size.
1812groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
1813
1814# Retrieve a single mention
1815#
1816# Arguments
1817# mentionId: The mention ID
1818# limit: Comments pagination - limit
1819# offset: Comments pagination - limit
1820# userId: The user who owns the mention.
1821mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
1822
1823# Retrieve a shared mention
1824#
1825# Arguments
1826# shareId: share token
1827sharedMention(shareId: ID!): SharedMention
1828
1829# Search for mentions across an index.
1830# This query requires a user token.
1831# Known Issues:
1832# - Offset can not go past 10,000. To get around this, the best practice is to
1833# keep updating the start time of the query based on the last mention you have
1834# processed.
1835# Example:
1836# Request:
1837# query{
1838#
1839# searchMentions(search:{
1840#
1841# offset: 0
1842#
1843# limit: 1
1844#
1845# index: ["mine"]
1846#
1847# query:{
1848#
1849# operator: "and"
1850#
1851# conditions: [{
1852#
1853# operator: "term"
1854#
1855# field: "trackingUnitName"
1856#
1857# value: "Dallas Cowboys Super Bowl"
1858#
1859# },
1860#
1861# {
1862#
1863# operator: "term"
1864#
1865# field: "mentionStatusId"
1866#
1867# value: "1"
1868#
1869# }]
1870#
1871# }
1872#
1873# }) {
1874#
1875# jsondata
1876#
1877# }
1878# }
1879# Response:
1880# {
1881#
1882# "data": {
1883#
1884# "searchMentions": {
1885#
1886# "jsondata": {
1887#
1888# "results": [
1889#
1890# {
1891#
1892# "id": 47569938,
1893#
1894# "programFormatName": "Information and News",
1895#
1896# "mentionDate": "2017-01-31T07:59:18.000Z",
1897#
1898# "mediaStartTime": "2017-01-31T07:45:01.000Z",
1899#
1900# "mediaId": 20017455,
1901#
1902# "metadata": {
1903#
1904# "filename": "AM-RADIO",
1905#
1906# "veritone-file": {
1907#
1908# "size": 0,
1909#
1910# "filename": "AM-RADIO",
1911#
1912# "mimetype": "audio/mpeg"
1913#
1914# },
1915#
1916# "veritone-media-source": {
1917#
1918# "mediaSourceId": "14326",
1919#
1920# "mediaSourceTypeId": "1"
1921#
1922# },
1923#
1924# "veritone-program": {
1925#
1926# "programId": "3828",
1927#
1928# "programName": "AM-RADIO Morning Talk",
1929#
1930# "programImage":
1931# "https://s3.amazonaws.com/veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
1932#
1933# "programLiveImage":
1934# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG"
1935#
1936# }
1937#
1938# },
1939#
1940# "fileLocation":
1941# "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",
1942#
1943# "fileType": "audio/mpeg",
1944#
1945# "snippets": [
1946#
1947# {
1948#
1949# "startTime": 857.62,
1950#
1951# "endTime": 887.33,
1952#
1953# "text": "eighty first women's Australian Open final Monica Seles beat Steffi
1954# Graf four six six three six two in one thousand nine hundred twenty eight the
1955# Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back
1956# Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the
1957# Cowboys twenty sixteen at the one hundred fourth women's Australian Open final
1958# six three six six four that time capsule your",
1959#
1960# "hits": [
1961#
1962# {
1963#
1964# "startTime": 865.7,
1965#
1966# "endTime": 865.929,
1967#
1968# "queryTerm": "Dallas"
1969#
1970# },
1971#
1972# {
1973#
1974# "startTime": 865.93,
1975#
1976# "endTime": 866.07,
1977#
1978# "queryTerm": "Cowboys"
1979#
1980# },
1981#
1982# {
1983#
1984# "startTime": 872.74,
1985#
1986# "endTime": 873.31,
1987#
1988# "queryTerm": "Super"
1989#
1990# },
1991#
1992# {
1993#
1994# "startTime": 873.31,
1995#
1996# "endTime": 873.43,
1997#
1998# "queryTerm": "Bowl"
1999#
2000# }
2001#
2002# ]
2003#
2004# }
2005#
2006# ],
2007#
2008# "userSnippets": null,
2009#
2010# "advertiserId": 0,
2011#
2012# "advertiserName": "",
2013#
2014# "brandId": 0,
2015#
2016# "brandImage": "",
2017#
2018# "brandName": "",
2019#
2020# "campaignId": 0,
2021#
2022# "campaignName": "",
2023#
2024# "organizationId": 7295,
2025#
2026# "organizationName": "Demo Organization",
2027#
2028# "trackingUnitId": 10032,
2029#
2030# "trackingUnitName": "Dallas Cowboys Super Bowl",
2031#
2032# "mentionStatusId": 1,
2033#
2034# "mediaSourceTypeId": 1,
2035#
2036# "mediaSourceTypeName": "Audio",
2037#
2038# "mediaSourceId": 14326,
2039#
2040# "mediaSourceName": "AM-RADIO Morning Talk",
2041#
2042# "isNational": true,
2043#
2044# "spotTypeId": null,
2045#
2046# "spotTypeName": null,
2047#
2048# "programId": 3828,
2049#
2050# "programName": "AM-RADIO",
2051#
2052# "programImage":
2053# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2054#
2055# "programLiveImage":
2056# "https://s3.amazonaws.com/veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG",
2057#
2058# "impressions": 1894,
2059#
2060# "audience": [
2061#
2062# {
2063#
2064# "gender": "men",
2065#
2066# "age_group": "35-44",
2067#
2068# "audience": 11,
2069#
2070# "isTargetMatch": true
2071#
2072# },
2073#
2074# {
2075#
2076# "gender": "men",
2077#
2078# "age_group": "45-49",
2079#
2080# "audience": 121,
2081#
2082# "isTargetMatch": true
2083#
2084# },
2085#
2086# {
2087#
2088# "gender": "men",
2089#
2090# "age_group": "50-54",
2091#
2092# "audience": 474,
2093#
2094# "isTargetMatch": true
2095#
2096# },
2097#
2098# {
2099#
2100# "gender": "men",
2101#
2102# "age_group": "65+",
2103#
2104# "audience": 95,
2105#
2106# "isTargetMatch": true
2107#
2108# },
2109#
2110# {
2111#
2112# "gender": "women",
2113#
2114# "age_group": "50-54",
2115#
2116# "audience": 19,
2117#
2118# "isTargetMatch": false
2119#
2120# },
2121#
2122# {
2123#
2124# "gender": "women",
2125#
2126# "age_group": "65+",
2127#
2128# "audience": 693,
2129#
2130# "isTargetMatch": false
2131#
2132# },
2133#
2134# {
2135#
2136# "gender": "men",
2137#
2138# "age_group": "55-64",
2139#
2140# "audience": 481,
2141#
2142# "isTargetMatch": true
2143#
2144# }
2145#
2146# ],
2147#
2148# "targetAudience": {
2149#
2150# "gender": 1,
2151#
2152# "genderName": "M",
2153#
2154# "ageGroup": [
2155#
2156# 0,
2157#
2158# 5
2159#
2160# ],
2161#
2162# "ageGroupMin": 18,
2163#
2164# "ageGroupMax": 0,
2165#
2166# "impressions": 1182
2167#
2168# },
2169#
2170# "audienceMarketCount": 3,
2171#
2172# "audienceAffiliateCount": 1,
2173#
2174# "rating": null,
2175#
2176# "ratings": null,
2177#
2178# "comments": null,
2179#
2180# "markets": [
2181#
2182# {
2183#
2184# "marketId": 54,
2185#
2186# "marketName": "Des Moines-Ames, IA"
2187#
2188# }
2189#
2190# ],
2191#
2192# "marketId": null,
2193#
2194# "marketName": null,
2195#
2196# "hourOfDay": 7,
2197#
2198# "dayOfWeek": 2,
2199#
2200# "dayOfMonth": 31,
2201#
2202# "month": 1,
2203#
2204# "year": 2017,
2205#
2206# "isMatch": true,
2207#
2208# "mentionStatusName": "Pending Verification",
2209#
2210# "complianceStatusId": null,
2211#
2212# "cognitiveEngineResults": null,
2213#
2214# "hits": 4
2215#
2216# }
2217#
2218# ],
2219#
2220# "totalResults": 579,
2221#
2222# "limit": 1,
2223#
2224# "from": 0,
2225#
2226# "to": 0,
2227#
2228# "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e",
2229#
2230# "timestamp": 1513371071
2231#
2232# }
2233#
2234# }
2235#
2236# }
2237# }
2238#
2239# Arguments
2240# search: JSON structure containing the search query.
2241# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2242# search query syntax
2243searchMentions(search: JSONData!): SearchResult
2244
2245# Search for media across an index.
2246# This query requires a user token.
2247# Example:
2248# Request:
2249# query{
2250#
2251# searchMedia(search:{
2252#
2253# offset: 0
2254#
2255# limit: 1
2256#
2257# index: ["mine"]
2258#
2259# query:{
2260#
2261# operator: "query_string"
2262#
2263# field: "transcript.transcript"
2264#
2265# value: "paris NOT \"las vegas\""
2266#
2267# }
2268#
2269# }) {
2270#
2271# jsondata
2272#
2273# }
2274# }
2275# Response:
2276# {
2277#
2278# "data": {
2279#
2280# "searchMedia": {
2281#
2282# "jsondata": {
2283#
2284# "results": [
2285#
2286# {
2287#
2288# "recording": {
2289#
2290# "recordingId": "43033727",
2291#
2292# "fileLocation":
2293# "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",
2294#
2295# "fileType": "video/mp4",
2296#
2297# "programId": "-1",
2298#
2299# "programName": "Weekly Talkshow",
2300#
2301# "programLiveImage":
2302# "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg",
2303#
2304# "mediaSourceId": "-1",
2305#
2306# "mediaSourceTypeId": "5",
2307#
2308# "sliceTime": 1512682022,
2309#
2310# "mediaStartTime": 1512681992,
2311#
2312# "aibDuration": 90,
2313#
2314# "isOwn": true,
2315#
2316# "hitStartTime": 1512682022,
2317#
2318# "hitEndTime": 1512682082
2319#
2320# },
2321#
2322# "startDateTime": 1512682022,
2323#
2324# "stopDateTime": 1512682082,
2325#
2326# "hits": [
2327#
2328# {
2329#
2330# "veritone-file": {
2331#
2332# "filename": "Veritone_v06.mp4",
2333#
2334# "mimetype": "video/mp4",
2335#
2336# "size": 162533502
2337#
2338# }
2339#
2340# }
2341#
2342# ]
2343#
2344# }
2345#
2346# ],
2347#
2348# "totalResults": 733275,
2349#
2350# "limit": 1,
2351#
2352# "from": 0,
2353#
2354# "to": 0,
2355#
2356# "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7",
2357#
2358# "timestamp": 1513361576
2359#
2360# }
2361#
2362# }
2363#
2364# }
2365# }
2366#
2367# Arguments
2368# search: JSON structure containing the search query.
2369# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2370# search query syntax
2371searchMedia(search: JSONData!): SearchResult
2372
2373# Retrieve the root folders for an organization
2374# Example:
2375# Request:
2376# query {
2377#
2378# rootFolders {
2379#
2380# id
2381#
2382# typeId
2383#
2384# }
2385# }
2386# Response:
2387# {
2388#
2389# "data": {
2390#
2391# "rootFolders": [
2392#
2393# {
2394#
2395# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2396#
2397# "typeId": 4
2398#
2399# },
2400#
2401# {
2402#
2403# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
2404#
2405# "typeId": 4
2406#
2407# }
2408#
2409# ]
2410#
2411# }
2412# }
2413#
2414# Arguments
2415# type: The type of root folder to retrieve
2416rootFolders(type: RootFolderType): [Folder]
2417
2418# Retrieve a single folder. Used to navigate the folder tree structure.
2419# Example:
2420# Request:
2421# query {
2422#
2423# folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") {
2424#
2425# typeId
2426#
2427# treeObjectId
2428#
2429# childFolders{
2430#
2431# records{
2432#
2433# id
2434#
2435# }
2436#
2437# }
2438#
2439# }
2440# }
2441# Response:
2442# {
2443#
2444# "data": {
2445#
2446# "folder": {
2447#
2448# "typeId": 4,
2449#
2450# "treeObjectId": "3104f61f-4bd1-4175-9fe6-27436d591c54",
2451#
2452# "childFolders": {
2453#
2454# "records": [
2455#
2456# {
2457#
2458# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
2459#
2460# },
2461#
2462# {
2463#
2464# "id": "a347319d-72da-43a2-93fc-e677876aca80"
2465#
2466# }
2467#
2468# ]
2469#
2470# }
2471#
2472# }
2473#
2474# }
2475# }
2476#
2477# Arguments
2478# id: Provide an ID to retrieve a single specific user.
2479folder(id: ID!): Folder
2480
2481# Example:
2482# Request:
2483# query {
2484#
2485# auditEvents(limit: 2) {
2486#
2487# records {
2488#
2489# id
2490#
2491# application
2492#
2493# }
2494#
2495# }
2496# }
2497# Response:
2498# {
2499#
2500# "data": {
2501#
2502# "auditEvents": {
2503#
2504# "records": [
2505#
2506# {
2507#
2508# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f",
2509#
2510# "application": ""
2511#
2512# }
2513#
2514# ]
2515#
2516# }
2517#
2518# }
2519# }
2520#
2521# Arguments
2522# query: An elastic query for audit events
2523# application: Filter logs by a specific application
2524# terms: Term filters to filter documents by properties in the
2525# payload
2526auditEvents(
2527query: JSONData,
2528orderDirection: OrderDirection,
2529application: String,
2530terms: [JSONData!],
2531limit: Int,
2532offset: Int
2533): AuditEventList!
2534
2535# Retrieve a folder overview
2536# Example:
2537# Request:
2538# query {
2539#
2540# folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") {
2541#
2542# childFoldersCount
2543#
2544# childNonFolderObjectsCount
2545#
2546# }
2547# }
2548# Response:
2549# {
2550#
2551# "data": {
2552#
2553# "folderOverview": {
2554#
2555# "childFoldersCount": 3,
2556#
2557# "childNonFolderObjectsCount": 0
2558#
2559# }
2560#
2561# }
2562# }
2563#
2564# Arguments
2565# ids: Tree Object Ids
2566folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
2567
2568# Example:
2569# Request:
2570# query {
2571#
2572# folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") {
2573#
2574# id
2575#
2576# typeId
2577#
2578# }
2579# }
2580# Response:
2581# {
2582#
2583# "data": {
2584#
2585# "folderSummaryDetails": [
2586#
2587# {
2588#
2589# "id": "1580701928",
2590#
2591# "typeId": 5
2592#
2593# },
2594#
2595# {
2596#
2597# "id": "1580388995",
2598#
2599# "typeId": 5
2600#
2601# },
2602#
2603# {
2604#
2605# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2606#
2607# "typeId": 4
2608#
2609# },
2610#
2611# {
2612#
2613# "id": "243625",
2614#
2615# "typeId": 3
2616#
2617# },
2618#
2619# {
2620#
2621# "id": "242599",
2622#
2623# "typeId": 3
2624#
2625# },
2626#
2627# {
2628#
2629# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
2630#
2631# "typeId": 1
2632#
2633# },
2634#
2635# {
2636#
2637# "id": "a347319d-72da-43a2-93fc-e677876aca80",
2638#
2639# "typeId": 1
2640#
2641# },
2642#
2643# {
2644#
2645# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320",
2646#
2647# "typeId": 1
2648#
2649# }
2650#
2651# ]
2652#
2653# }
2654# }
2655#
2656# Arguments
2657# ids: Tree Object Ids
2658folderSummaryDetails(
2659ids: [ID!]!,
2660rootFolderType: RootFolderType
2661): [FolderSummaryDetail]
2662
2663# Retrieve a single application
2664# Example:
2665# Request:
2666# query {
2667#
2668# application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
2669#
2670# name
2671#
2672# key
2673#
2674# }
2675# }
2676# Response:
2677# {
2678#
2679# "data": {
2680#
2681# "application": {
2682#
2683# "name": "appexamplebill",
2684#
2685# "key": "appexamplebill"
2686#
2687# }
2688#
2689# }
2690# }
2691#
2692# Arguments
2693# id: The application ID
2694application(id: ID!): Application
2695
2696# Retrieve a list of schemas for structured data ingestions\
2697# Example:
2698# Request:
2699# query {
2700#
2701# schemas(limit: 2) {
2702#
2703# records {
2704#
2705# id
2706#
2707# organizationId
2708#
2709# }
2710#
2711# }
2712# }
2713# Response:
2714# {
2715#
2716# "data": {
2717#
2718# "schemas": {
2719#
2720# "records": [
2721#
2722# {
2723#
2724# "id": "21a08123-45dc-497e-b329-360d9f3fcaac",
2725#
2726# "organizationId": "35521"
2727#
2728# },
2729#
2730# {
2731#
2732# "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112",
2733#
2734# "organizationId": "35521"
2735#
2736# }
2737#
2738# ]
2739#
2740# }
2741#
2742# }
2743# }
2744#
2745# Arguments
2746# id: Id of a schema to retrieve
2747# ids: Ids of schemas to retrieve
2748# dataRegistryId: Specify the id of the DataRegistry to get
2749# schemas
2750# status: Specify one or more statuses to filter by schema status
2751# majorVersion: Specify a major version to filter schemas
2752# name: Specify a data registry name to filter schemas
2753# nameMatch: The strategy used to find data registry name
2754# limit: Limit
2755# offset: Offset
2756# orderBy: Specify one or more fields and direction to order
2757# results
2758schemas(
2759id: ID,
2760ids: [ID!],
2761dataRegistryId: ID,
2762status: [SchemaStatus!],
2763majorVersion: Int,
2764name: String,
2765nameMatch: StringMatch,
2766limit: Int,
2767offset: Int,
2768orderBy: [SchemaOrder]
2769): SchemaList
2770
2771# Retrieve a schema for structured data ingestions
2772# Example:
2773# Request:
2774# query {
2775#
2776# schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") {
2777#
2778# definition
2779#
2780# status
2781#
2782# }
2783# }
2784# Response:
2785# {
2786#
2787# "data": {
2788#
2789# "schema": {
2790#
2791# "definition": {
2792#
2793# "example": "example value"
2794#
2795# },
2796#
2797# "status": "draft"
2798#
2799# }
2800#
2801# }
2802# }
2803#
2804# Arguments
2805# id: Supply the ID of the schema to retrieve
2806schema(id: ID!): Schema
2807
2808# Example:
2809# Request:
2810# query {
2811#
2812# schemaProperties(limit: 2) {
2813#
2814# records {
2815#
2816# type
2817#
2818# dataRegistryId
2819#
2820# }
2821#
2822# }
2823# }
2824# Response:
2825# {
2826#
2827# "data": {
2828#
2829# "schemaProperties": {
2830#
2831# "records": [
2832#
2833# {
2834#
2835# "type": "string",
2836#
2837# "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6"
2838#
2839# },
2840#
2841# {
2842#
2843# "type": "string",
2844#
2845# "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c"
2846#
2847# }
2848#
2849# ]
2850#
2851# }
2852#
2853# }
2854# }
2855#
2856# Arguments
2857# limit: Limit
2858# offset: Offset
2859schemaProperties(
2860dataRegistryVersion: [DataRegistryVersion!],
2861search: String,
2862limit: Int,
2863offset: Int
2864): SchemaPropertyList
2865
2866# Retrieve a structured data object
2867# Example:
2868# Request:
2869# query {
2870#
2871# structuredData(
2872#
2873# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2874#
2875# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2876#
2877# data
2878#
2879# }
2880# }
2881# Response:
2882# {
2883#
2884# "data": {
2885#
2886# "structuredData": {
2887#
2888# "data": {
2889#
2890# "example": "example"
2891#
2892# }
2893#
2894# }
2895#
2896# }
2897# }
2898#
2899# Arguments
2900# id: Supply the ID of the structured data object to retrieve.
2901# This will override filters.
2902# schemaId: Schema Id for the structured data object to retrieve
2903structuredData(id: ID!, schemaId: ID!): StructuredData
2904
2905# Retrieve a structured data object
2906# Example:
2907# Request:
2908# query {
2909#
2910# structuredDataObject(
2911#
2912# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2913#
2914# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2915#
2916# data
2917#
2918# }
2919# }
2920# Response:
2921# {
2922#
2923# "data": {
2924#
2925# "structuredDataObject": {
2926#
2927# "data": {
2928#
2929# "example": "example"
2930#
2931# }
2932#
2933# }
2934#
2935# }
2936# }
2937#
2938# Arguments
2939# id: Supply the ID of the structured data object to retrieve.
2940# This will override filters.
2941# schemaId: Schema Id for the structured data object to retrieve
2942structuredDataObject(id: ID!, schemaId: ID!): StructuredData
2943
2944# Retrieve a paginated list of structured data object
2945# Example:
2946# Request:
2947# query {
2948#
2949# structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
2950#
2951# records {
2952#
2953# id
2954#
2955# data
2956#
2957# }
2958#
2959# }
2960# }
2961# Response:
2962# {
2963#
2964# "data": {
2965#
2966# "structuredDataObjects": {
2967#
2968# "records": [
2969#
2970# {
2971#
2972# "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf",
2973#
2974# "data": {
2975#
2976# "example": "example"
2977#
2978# }
2979#
2980# },
2981#
2982# {
2983#
2984# "id": "f914eafe-ed9b-46b1-a48d-effd5575764a",
2985#
2986# "data": {
2987#
2988# "example": "example"
2989#
2990# }
2991#
2992# }
2993#
2994# ]
2995#
2996# }
2997#
2998# }
2999# }
3000#
3001# Arguments
3002# id: Supply the ID of the structured data object to retrieve.
3003# This will override filters.
3004# ids: List of Ids of the structured data objects to retrieve.
3005# This will override filters.
3006# schemaId: Schema Id for the structured data object to retrieve
3007# filter: Query to filter SDO. Supports operations such as and,
3008# or, eq, gt, lt, etc.
3009# TODO link to syntax documentation
3010structuredDataObjects(
3011id: ID,
3012ids: [ID!],
3013schemaId: ID!,
3014orderBy: [StructuredDataOrderBy!],
3015limit: Int,
3016offset: Int,
3017owned: Boolean,
3018filter: JSONData
3019): StructuredDataList
3020
3021# Returns information about the GraphQL server, useful
3022# for diagnostics. This data is primarily used by Veritone
3023# development, and some fields may be restricted to Veritone administrators.
3024graphqlServiceInfo: GraphQLServiceInfo
3025
3026# Returns a signed writable S3 URL. A client can then
3027# upload to this URL with an HTTP PUT without providing
3028# any additional authorization (_note_: it must be a PUT.
3029# A POST will fail.)
3030# Example:
3031# Request:
3032# query {
3033#
3034# getSignedWritableUrl(type: "preview") {
3035#
3036# bucket
3037#
3038# key
3039#
3040# url
3041#
3042# }
3043# }
3044# Response:
3045# {
3046#
3047# "data": {
3048#
3049# "getSignedWritableUrl": {
3050#
3051# "bucket": "prod-api.veritone.com",
3052#
3053# "key":
3054# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3055#
3056# "url":
3057# "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"
3058#
3059# }
3060#
3061# }
3062# }
3063#
3064# Arguments
3065# key: Optional key of the object to generate a writable
3066# URL for. If not provided, a new, unique key will
3067# be generated. If a key is provided and resembles a file name
3068# (with extension delimited by .), a UUID will be inserted
3069# into the file name, leaving the extension intact.
3070# If a key is provided and does not resemble
3071# a file name, a UUID will be appended.
3072# type: Optional type of resource, such as `asset`, `thumbnail`,
3073# `discovery-analytics` or `preview`
3074# path: Optional extended path information. If the uploaded
3075# content will be contained
3076# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3077# (for `entityIdentifier`), the ID of the object should be provided here.
3078# expiresInSeconds: Optional expiresInSeconds custom expiration
3079# to signedUrlExpires
3080# Max expiresInSeconds up to 604800
3081# organizationId: Optional organization ID. Normally this value
3082# is computed by the server
3083# based on the authorization token used for the request.
3084# Is is used only by Veritone platform components.
3085getSignedWritableUrl(
3086key: String,
3087type: String,
3088path: String,
3089expiresInSeconds: Int,
3090organizationId: ID
3091): WritableUrlInfo
3092
3093# Return writable storage URLs in bulk.
3094# A maximum of 1000 can be created in one call.
3095# See `getSignedWritableUrl` for details on usage of the
3096# response contents.
3097# Example:
3098# Request:
3099# query {
3100#
3101# getSignedWritableUrls(number: 2) {
3102#
3103# bucket
3104#
3105# key
3106#
3107# url
3108#
3109# }
3110# }
3111# Response:
3112# {
3113#
3114# "data": {
3115#
3116# "getSignedWritableUrls": [
3117#
3118# {
3119#
3120# "bucket": "prod-api.veritone.com",
3121#
3122# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3123#
3124# "url":
3125# "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"
3126#
3127# },
3128#
3129# {
3130#
3131# "bucket": "prod-api.veritone.com",
3132#
3133# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3134#
3135# "url":
3136# "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"
3137#
3138# }
3139#
3140# ]
3141#
3142# }
3143# }
3144#
3145# Arguments
3146# number: Number of signed URLs to return
3147# type: Optional type of resource, such as `asset`, `thumbnail`,
3148# or `preview`
3149# path: Optional extended path information. If the uploaded
3150# content will be contained
3151# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3152# (for `entityIdentifier`), the ID of the object should be provided here.
3153# organizationId: Optional organization ID. Normally this value
3154# is computed by the server
3155# based on the authorization token used for the request.
3156# Is is used only by Veritone platform components.
3157getSignedWritableUrls(
3158number: Int!,
3159type: String,
3160path: String,
3161organizationId: ID
3162): [WritableUrlInfo!]!
3163
3164# Retrieve the rights of the current user
3165# Example:
3166# Request:
3167# query {
3168#
3169# myRights {
3170#
3171# resources
3172#
3173# operations
3174#
3175# }
3176# }
3177# Response:
3178# {
3179#
3180# "data": {
3181#
3182# "myRights": {
3183#
3184# "resources": {},
3185#
3186# "operations": [
3187#
3188# "admin.access",
3189#
3190# "admin.org.read",
3191#
3192# "admin.org.update",
3193#
3194# "admin.user.create",
3195#
3196# "admin.user.read",
3197#
3198# "admin.user.update",
3199#
3200# "admin.user.delete",
3201#
3202# ...
3203#
3204# ]
3205#
3206# }
3207#
3208# }
3209# }
3210myRights: RightsListing
3211
3212# Retrieve the shared folders for an organization
3213# Example:
3214# Request:
3215# query {
3216#
3217# sharedFolders {
3218#
3219# id
3220#
3221# }
3222# }
3223# Response:
3224# {
3225#
3226# "data": {
3227#
3228# "sharedFolders": []
3229#
3230# }
3231# }
3232sharedFolders: [Folder]
3233
3234# Retrieve multiple watchlists
3235# Example:
3236# Request:
3237# query {
3238#
3239# watchlists(limit: 2) {
3240#
3241# records {
3242#
3243# id
3244#
3245# name
3246#
3247# }
3248#
3249# }
3250# }
3251# Response:
3252# {
3253#
3254# "data": {
3255#
3256# "watchlists": {
3257#
3258# "records": [
3259#
3260# {
3261#
3262# "id": "326916",
3263#
3264# "name": "example"
3265#
3266# },
3267#
3268# {
3269#
3270# "id": "325791",
3271#
3272# "name": "example"
3273#
3274# }
3275#
3276# ]
3277#
3278# }
3279#
3280# }
3281# }
3282#
3283# Arguments
3284# isDisabled: Set `true` to include only disabled watchlist or
3285# `false` to include only enabled watchlists. By default,
3286# both are included.
3287watchlists(
3288id: ID,
3289maxStopDateTime: DateTime,
3290minStopDateTime: DateTime,
3291minStartDateTime: DateTime,
3292maxStartDateTime: DateTime,
3293name: String,
3294offset: Int,
3295limit: Int,
3296orderBy: WatchlistOrderBy,
3297orderDirection: OrderDirection,
3298isDisabled: Boolean
3299): WatchlistList
3300
3301# Retrieve a single watchlist by id
3302# Example:
3303# Request:
3304# query {
3305#
3306# watchlist(id: "325791") {
3307#
3308# name
3309#
3310# watchlistType
3311#
3312# }
3313# }
3314# Response:
3315# {
3316#
3317# "data": {
3318#
3319# "watchlist": {
3320#
3321# "name": "example",
3322#
3323# "watchlistType": "tracking"
3324#
3325# }
3326#
3327# }
3328# }
3329watchlist(id: ID!): Watchlist
3330
3331# Example:
3332# Request:
3333# query {
3334#
3335# mentionStatusOptions {
3336#
3337# id
3338#
3339# name
3340#
3341# }
3342# }
3343# Response:
3344# {
3345#
3346# "data": {
3347#
3348# "mentionStatusOptions": [
3349#
3350# {
3351#
3352# "id": "7",
3353#
3354# "name": "Auto Verified"
3355#
3356# },
3357#
3358# {
3359#
3360# "id": "5",
3361#
3362# "name": "Invalid"
3363#
3364# },
3365#
3366# {
3367#
3368# "id": "3",
3369#
3370# "name": "Needs Review"
3371#
3372# },
3373#
3374# {
3375#
3376# "id": "1",
3377#
3378# "name": "Pending Verification"
3379#
3380# },
3381#
3382# {
3383#
3384# "id": "6",
3385#
3386# "name": "Processing Verification"
3387#
3388# },
3389#
3390# {
3391#
3392# "id": "4",
3393#
3394# "name": "Request Bonus"
3395#
3396# },
3397#
3398# {
3399#
3400# "id": "2",
3401#
3402# "name": "Verified"
3403#
3404# }
3405#
3406# ]
3407#
3408# }
3409# }
3410mentionStatusOptions: [MentionStatus!]!
3411
3412# Retrieve multiple data registries
3413# Example:
3414# Request:
3415# query {
3416#
3417# dataRegistries(limit: 2) {
3418#
3419# records {
3420#
3421# id
3422#
3423# name
3424#
3425# }
3426#
3427# }
3428# }
3429# Response:
3430# {
3431#
3432# "data": {
3433#
3434# "dataRegistries": {
3435#
3436# "records": [
3437#
3438# {
3439#
3440# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
3441#
3442# "name": "example"
3443#
3444# },
3445#
3446# {
3447#
3448# "id": "317c941d-30d0-455e-882b-34a26e513364",
3449#
3450# "name": "example"
3451#
3452# }
3453#
3454# ]
3455#
3456# }
3457#
3458# }
3459# }
3460dataRegistries(
3461id: ID,
3462ids: [ID!],
3463name: String,
3464nameMatch: StringMatch,
3465offset: Int,
3466limit: Int,
3467orderBy: DataRegistryOrderBy,
3468orderDirection: OrderDirection,
3469filterByOwnership: SchemaOwnership
3470): DataRegistryList
3471
3472# Retrieve a single data registry
3473# Example:
3474# Request:
3475# query {
3476#
3477# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
3478#
3479# name
3480#
3481# organizationId
3482#
3483# source
3484#
3485# }
3486# }
3487# Response:
3488# {
3489#
3490# "data": {
3491#
3492# "dataRegistry": {
3493#
3494# "name": "example",
3495#
3496# "organizationId": "35521",
3497#
3498# "source": "veritone-35521.datasets"
3499#
3500# }
3501#
3502# }
3503# }
3504dataRegistry(id: ID!): DataRegistry
3505
3506# Retrieve a subscription by id
3507# Example:
3508# Request:
3509# query {
3510#
3511# subscription(id: "275818") {
3512#
3513# isActive
3514#
3515# jsondata
3516#
3517# }
3518# }
3519# Response:
3520# {
3521#
3522# "data": {
3523#
3524# "subscription": {
3525#
3526# "isActive": true,
3527#
3528# "jsondata": {
3529#
3530# "tracking_unit_id": "325791",
3531#
3532# "creator_email": "example email",
3533#
3534# "unsubscribe_hash":
3535# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
3536#
3537# }
3538#
3539# }
3540#
3541# }
3542# }
3543subscription(id: ID!): Subscription!
3544
3545cognitiveSearch(id: ID!): CognitiveSearch!
3546
3547# Retrieve multiple collections
3548# Example:
3549# Request:
3550# query {
3551#
3552# collections {
3553#
3554# records {
3555#
3556# id
3557#
3558# name
3559#
3560# }
3561#
3562# }
3563# }
3564# Response:
3565# {
3566#
3567# "data": {
3568#
3569# "collections": {
3570#
3571# "records": [
3572#
3573# {
3574#
3575# "id": "241121",
3576#
3577# "name": "example"
3578#
3579# },
3580#
3581# {
3582#
3583# "id": "242599",
3584#
3585# "name": "example"
3586#
3587# },
3588#
3589# {
3590#
3591# "id": "243625",
3592#
3593# "name": "example"
3594#
3595# }
3596#
3597# ]
3598#
3599# }
3600#
3601# }
3602# }
3603collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
3604
3605# Retrieve a collection by id
3606# Example:
3607# Request:
3608# query {
3609#
3610# collection(id: "241121") {
3611#
3612# name
3613#
3614# isActive
3615#
3616# }
3617# }
3618# Response:
3619# {
3620#
3621# "data": {
3622#
3623# "collection": {
3624#
3625# "name": "example",
3626#
3627# "isActive": true
3628#
3629# }
3630#
3631# }
3632# }
3633collection(id: ID!): Collection!
3634
3635collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
3636
3637# Retrieve a list of collection mentions
3638# Specify at least one of folderId or mentionId
3639collectionMentions(
3640folderId: ID,
3641mentionId: ID,
3642orderBy: CollectionMentionOrderBy,
3643limit: Int,
3644offset: Int
3645): CollectionMentionList!
3646
3647# Retrieve multiple mentions
3648# Example:
3649# Request:
3650# query {
3651#
3652# mentions {
3653#
3654# records {
3655#
3656# id
3657#
3658# }
3659#
3660# }
3661# }
3662# Response:
3663# {
3664#
3665# "data": {
3666#
3667# "mentions": {
3668#
3669# "records": []
3670#
3671# }
3672#
3673# }
3674# }
3675#
3676# Arguments
3677# watchlistId: Get mentions created from the specified watchlist
3678# sourceId: Get mentions associated with the specified source
3679# sourceTypeId: Get mentions associated with sources of the
3680# specified source type
3681# tdoId: Get mentions associated directly with the specific TDO
3682# dateTimeFilter: Specify date/time filters against mention
3683# fields.
3684# Querying for mentions can be expensive. If the query does not
3685# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
3686# a user-provided `dateTimeFilter`, a default filter of the
3687# past 7 days is applied.
3688# orderBy: Set order information on the query. Multiple fields
3689# are supported.
3690# folderId: Provide a folder ID to filter by collection
3691mentions(
3692id: ID,
3693watchlistId: ID,
3694sourceId: ID,
3695sourceTypeId: ID,
3696tdoId: ID,
3697dateTimeFilter: [MentionDateTimeFilter!],
3698orderBy: [MentionOrderBy!],
3699offset: Int,
3700limit: Int,
3701folderId: ID
3702): MentionList
3703
3704# Retrieves engine results by TDO and engine ID or by job ID.
3705# Example:
3706# Request:
3707# query {
3708#
3709# engineResults(
3710#
3711# tdoId: "1580507556",
3712#
3713# engineIds: "4") {
3714#
3715# sourceId
3716#
3717# records {
3718#
3719# tdoId
3720#
3721# }
3722#
3723# }
3724# }
3725# Response:
3726# {
3727#
3728# "data": {
3729#
3730# "engineResults": {
3731#
3732# "sourceId": null,
3733#
3734# "records": []
3735#
3736# }
3737#
3738# }
3739# }
3740#
3741# Arguments
3742# tdoId: Provide the ID of the TDO containing engine results to
3743# retrieve.
3744# If this parameter is used, engineIds or engineCategoryIds must also be set.
3745# Results for _only_ the specified TDO will be returned.
3746# sourceId: Provide the ID of the Source containing engine
3747# results to retrieve.
3748# If this parameter is used, engineIds or engineCategoryIds must also be set.
3749# This takes priority over tdoId.
3750# engineIds: Provide one or more engine IDs to retrieve engine
3751# results by
3752# ID. This parameter is mandatory if tdoId is used, but optional
3753# if jobId or engineCategory is used.
3754# engineCategoryIds: Provide one or more category IDs to get all
3755# results from that categroy.
3756# jobId: Provide a job ID to retrieve engine results for the job.
3757# mentionId: Provide a mention ID to retrieve engine results for
3758# the mention.
3759# startOffsetMs: Start offset ms for the results.
3760# stopOffsetMs: End offset ms for the results.
3761# startDate: Start date for the results. Takes priority over
3762# startOffsetMs.
3763# stopDate: End date for the results. Takes priority over
3764# stopOffsetMs.
3765# ignoreUserEdited: Whether or not to exclude user edited engine
3766# results. Defaults to false.
3767# fallbackTdoId: A TDO ID can be provided for use if the provided
3768# `sourceId` and/or
3769# `mentionId` parameters do not resolve to a logical set of TDOs.
3770# Depending on parameter settings and available data,
3771# results from other TDOs can be included in the response.
3772engineResults(
3773tdoId: ID,
3774sourceId: ID,
3775engineIds: [ID!],
3776engineCategoryIds: [ID!],
3777jobId: ID,
3778mentionId: ID,
3779startOffsetMs: Int,
3780stopOffsetMs: Int,
3781startDate: DateTime,
3782stopDate: DateTime,
3783ignoreUserEdited: Boolean,
3784fallbackTdoId: ID
3785): EngineResultList
3786
3787# Retrieve a trigger by id
3788# Example:
3789# Request:
3790# query {
3791#
3792# trigger(id: "2998") {
3793#
3794# target
3795#
3796# createdDateTime
3797#
3798# }
3799# }
3800# Response:
3801# {
3802#
3803# "data": {
3804#
3805# "trigger": {
3806#
3807# "target": "Email",
3808#
3809# "createdDateTime": "2021-06-18T13:35:08.631Z"
3810#
3811# }
3812#
3813# }
3814# }
3815trigger(id: ID!): Trigger
3816
3817# Retrieve triggers
3818# Example:
3819# Request:
3820# query {
3821#
3822# triggers {
3823#
3824# id
3825#
3826# }
3827# }
3828# Response:
3829# {
3830#
3831# "data": {
3832#
3833# "triggers": [
3834#
3835# {
3836#
3837# "id": "2998"
3838#
3839# }
3840#
3841# ]
3842#
3843# }
3844# }
3845triggers: [Trigger]
3846
3847# Fetch all saved searches that the current user has made
3848# Fetch all saved searches that have been shared with
3849# the current users organization
3850# Include any saved searches that the user has created
3851# Example:
3852# Request:
3853# query {
3854#
3855# savedSearches {
3856#
3857# records {
3858#
3859# id
3860#
3861# name
3862#
3863# }
3864#
3865# }
3866# }
3867# Response:
3868# {
3869#
3870# "data": {
3871#
3872# "savedSearches": {
3873#
3874# "records": [
3875#
3876# {
3877#
3878# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
3879#
3880# "name": "example"
3881#
3882# }
3883#
3884# ]
3885#
3886# }
3887#
3888# }
3889# }
3890savedSearches(
3891offset: Int,
3892limit: Int,
3893includeShared: Boolean,
3894filterByName: String,
3895orderBy: SavedSearchOrderBy,
3896orderDirection: OrderDirection
3897): SavedSearchList!
3898
3899# Retrieve a list of export requests
3900# Example:
3901# Request:
3902# query {
3903#
3904# exportRequests(limit: 2) {
3905#
3906# records {
3907#
3908# id
3909#
3910# organizationId
3911#
3912# }
3913#
3914# }
3915# }
3916# Response:
3917# {
3918#
3919# "data": {
3920#
3921# "exportRequests": {
3922#
3923# "records": [
3924#
3925# {
3926#
3927# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
3928#
3929# "organizationId": "35521"
3930#
3931# }
3932#
3933# ]
3934#
3935# }
3936#
3937# }
3938# }
3939#
3940# Arguments
3941# id: Provide an ID to retrieve a single export request
3942# offset: Provide an offset to skip to a certain element in the
3943# result, for paging.
3944# limit: Specify maximum number of results to retrieve in this
3945# result. Page size.
3946# status: Provide a list of status options to filter by status
3947# event: Provide an event to retrieve export request. Should be
3948# 'exportRequest' or 'mentionExportRequest'
3949# Default value is 'exportRequest'
3950exportRequests(
3951id: ID,
3952offset: Int,
3953limit: Int,
3954status: [ExportRequestStatus!],
3955event: ExportRequestEvent
3956): ExportRequestList!
3957
3958# Retrieve a single export request by id
3959# Example:
3960# Request:
3961# query {
3962#
3963# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
3964#
3965# id
3966#
3967# organizationId
3968#
3969# requestorId
3970#
3971# status
3972#
3973# }
3974# }
3975# Response:
3976# {
3977#
3978# "data": {
3979#
3980# "exportRequest": {
3981#
3982# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
3983#
3984# "organizationId": "35521",
3985#
3986# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
3987#
3988# "status": "complete"
3989#
3990# }
3991#
3992# }
3993# }
3994#
3995# Arguments
3996# event: Provide an event to retrieve export request. Should be
3997# 'exportRequest' or 'mentionExportRequest'
3998# Default value is 'exportRequest'
3999exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4000
4001# Retrieve a event by id
4002# Example:
4003# Request:
4004# query {
4005#
4006# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4007#
4008# eventName
4009#
4010# eventType
4011#
4012# description
4013#
4014# }
4015# }
4016# Response:
4017# {
4018#
4019# "data": {
4020#
4021# "event": {
4022#
4023# "eventName": "example",
4024#
4025# "eventType": "example",
4026#
4027# "description": "new example description"
4028#
4029# }
4030#
4031# }
4032# }
4033event(id: ID!): Event!
4034
4035# Retrieve a list of events by application
4036# Example:
4037# Request:
4038# query {
4039#
4040# events(
4041#
4042# application: "system",
4043#
4044# limit: 2) {
4045#
4046# records {
4047#
4048# id
4049#
4050# eventName
4051#
4052# }
4053#
4054# }
4055# }
4056# Response:
4057# {
4058#
4059# "data": {
4060#
4061# "events": {
4062#
4063# "records": [
4064#
4065# {
4066#
4067# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4068#
4069# "eventName": "ActionTokenForbidden"
4070#
4071# },
4072#
4073# {
4074#
4075# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4076#
4077# "eventName": "ActionUserForbidden"
4078#
4079# }
4080#
4081# ]
4082#
4083# }
4084#
4085# }
4086# }
4087#
4088# Arguments
4089# application: Provide an application to retrieve all its events.
4090# Use 'system' to list all public system events.
4091# offset: Provide an offset to skip to a certain element in the
4092# result, for paging.
4093# limit: Specify maximum number of results to retrieve in this
4094# result. Page size.
4095events(application: String!, offset: Int, limit: Int): EventList!
4096
4097# Retrieve a list of subscriptions by organization
4098# Example:
4099# Request:
4100# query {
4101#
4102# eventSubscriptions(limit: 2) {
4103#
4104# records {
4105#
4106# id
4107#
4108# eventName
4109#
4110# }
4111#
4112# }
4113# }
4114# Response:
4115# {
4116#
4117# "data": {
4118#
4119# "eventSubscriptions": {
4120#
4121# "records": [
4122#
4123# {
4124#
4125# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4126#
4127# "eventName": "LibraryTrainingComplete"
4128#
4129# },
4130#
4131# {
4132#
4133# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4134#
4135# "eventName": "LibraryTrainingComplete"
4136#
4137# }
4138#
4139# ]
4140#
4141# }
4142#
4143# }
4144# }
4145#
4146# Arguments
4147# ids: The event subscription ids
4148# eventName: The name of the event
4149# eventType: The type of event, such as `mention`, `job`,
4150# `engine`.
4151# offset: Provide an offset to skip to a certain element in the
4152# result, for paging.
4153# limit: Specify maximum number of results to retrieve in this
4154# result. Page size.
4155eventSubscriptions(
4156ids: [ID!],
4157eventName: String,
4158eventType: String,
4159offset: Int,
4160limit: Int
4161): EventSubscriptionList!
4162
4163# Retrieve a subscription by id
4164# Example:
4165# Request:
4166# query {
4167#
4168# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4169#
4170# id
4171#
4172# organizationId
4173#
4174# eventName
4175#
4176# targetName
4177#
4178# }
4179# }
4180# Response:
4181# {
4182#
4183# "data": {
4184#
4185# "eventSubscription": {
4186#
4187# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4188#
4189# "organizationId": "35521",
4190#
4191# "eventName": "LibraryTrainingComplete",
4192#
4193# "targetName": "NotificationMailbox"
4194#
4195# }
4196#
4197# }
4198# }
4199eventSubscription(id: ID!): EventSubscription!
4200
4201# Example:
4202# Request:
4203# query {
4204#
4205# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4206#
4207# organizationId
4208#
4209# actionType
4210#
4211# name
4212#
4213# }
4214# }
4215# Response:
4216# {
4217#
4218# "data": {
4219#
4220# "eventActionTemplate": {
4221#
4222# "organizationId": "35521",
4223#
4224# "actionType": "job",
4225#
4226# "name": "example"
4227#
4228# }
4229#
4230# }
4231# }
4232eventActionTemplate(id: ID!): EventActionTemplate
4233
4234# Example:
4235# Request:
4236# query {
4237#
4238# eventActionTemplates(
4239#
4240# inputType: event,
4241#
4242# actionType: job
4243#
4244# limit:2) {
4245#
4246# records {
4247#
4248# id
4249#
4250# name
4251#
4252# }
4253#
4254# }
4255# }
4256# Response:
4257# {
4258#
4259# "data": {
4260#
4261# "eventActionTemplates": {
4262#
4263# "records": [
4264#
4265# {
4266#
4267# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4268#
4269# "name": "example"
4270#
4271# },
4272#
4273# {
4274#
4275# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4276#
4277# "name": "example"
4278#
4279# }
4280#
4281# ]
4282#
4283# }
4284#
4285# }
4286# }
4287#
4288# Arguments
4289# ownerApplicationId: The application id
4290# inputType: use "event" for now. In the future, we allow
4291# additional input_type types. For example, a schedule or a tweet.
4292# actionType: Either "job", "webhook", "sms", "email". Future
4293# action_type could be "gql" where action is purely a function call.
4294# offset: Provide an offset to skip to a certain element in the
4295# result, for paging.
4296# limit: Specify maximum number of results to retrieve in this
4297# result. Page size.
4298eventActionTemplates(
4299ownerApplicationId: ID,
4300inputType: EventActionTemplateInputType,
4301actionType: EventActionTemplateActionType,
4302offset: Int,
4303limit: Int
4304): EventActionTemplateList!
4305
4306# Example:
4307# Request:
4308# query {
4309#
4310# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4311#
4312# name
4313#
4314# eventName
4315#
4316# description
4317#
4318# }
4319# }
4320# Response:
4321# {
4322#
4323# "data": {
4324#
4325# "eventCustomRule": {
4326#
4327# "name": "example",
4328#
4329# "eventName": "example",
4330#
4331# "description": "example description"
4332#
4333# }
4334#
4335# }
4336# }
4337eventCustomRule(id: ID!): EventCustomRule
4338
4339# Example:
4340# Request:
4341# query {
4342#
4343# eventCustomRules(limit: 2) {
4344#
4345# records {
4346#
4347# id
4348#
4349# name
4350#
4351# }
4352#
4353# }
4354# }
4355# Response:
4356# {
4357#
4358# "data": {
4359#
4360# "eventCustomRules": {
4361#
4362# "records": [
4363#
4364# {
4365#
4366# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
4367#
4368# "name": "example"
4369#
4370# }
4371#
4372# ]
4373#
4374# }
4375#
4376# }
4377# }
4378#
4379# Arguments
4380# offset: the offset to skip to a certain element in the result
4381# limit: the maximum number of rows in the results
4382eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
4383
4384# This query returns information about time zones recognized by this
4385#
4386# server. The information is static and does not change.
4387#
4388# Example:
4389#
4390# Request:
4391#
4392# query {
4393#
4394# timeZones {
4395#
4396# name
4397#
4398# abbreviations{
4399#
4400# name
4401#
4402# }
4403#
4404# }
4405# }
4406# Response:
4407# {
4408#
4409# "data": {
4410#
4411# "timeZones": [
4412#
4413# {
4414#
4415# "name": "Africa/Abidjan",
4416#
4417# "abbreviations": [
4418#
4419# {
4420#
4421# "name": "GMT"
4422#
4423# }
4424#
4425# ]
4426#
4427# },
4428#
4429# {
4430#
4431# "name": "Africa/Accra",
4432#
4433# "abbreviations": [
4434#
4435# {
4436#
4437# "name": "GMT"
4438#
4439# },
4440#
4441# {
4442#
4443# "name": "+0020"
4444#
4445# }
4446#
4447# ]
4448#
4449# },
4450#
4451# {
4452#
4453# "name": "Africa/Lagos",
4454#
4455# "abbreviations": [
4456#
4457# {
4458#
4459# "name": "WAT"
4460#
4461# }
4462#
4463# ]
4464#
4465# },
4466#
4467# ...
4468#
4469# ...
4470#
4471# ]
4472#
4473# }
4474#
4475# ]
4476#
4477# }
4478# }
4479timeZones: [TimeZone!]!
4480
4481# Examine entries from the audit log. All operations that modify data are
4482# written to the audit log. Only entries for the user's own organization
4483# can be queried.
4484# All queries are bracketed by a time window. A default time window is applied
4485# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
4486# The maximum time window length is 30 days.
4487# Only Veritone and organization administrators can use this query.
4488# Example:
4489# Request:
4490# query {
4491#
4492# auditLog(limit: 2) {
4493#
4494# records {
4495#
4496# id
4497#
4498# objectId
4499#
4500# description
4501#
4502# }
4503#
4504# }
4505# }
4506# Response:
4507# {
4508#
4509# "data": {
4510#
4511# "auditLog": {
4512#
4513# "records": [
4514#
4515# {
4516#
4517# "id": "735915311",
4518#
4519# "objectId": "*********",
4520#
4521# "description": "Changed password"
4522#
4523# },
4524#
4525# {
4526#
4527# "id": "735915307",
4528#
4529# "objectId": "********",
4530#
4531# "description": "Changed password"
4532#
4533# }
4534#
4535# ]
4536#
4537# }
4538#
4539# }
4540# }
4541#
4542# Arguments
4543# toDateTime: Date/time up to which entries will be returned. In
4544# other words, the
4545# end of the query time window.
4546# Defaults to the current time.
4547# fromDateTime: Date/time from which entries will be returned. In
4548# other words, the
4549# start of the query time window.
4550# Defaults to the `toDateTime` minus 7 days.
4551# organizationId: Organization ID to query records for. This
4552# value can only be used by
4553# Veritone administrators. Any value provided by user administrators will
4554# be ignored.
4555# userName: User name on audit entry. Must be exact match.
4556# clientIpAddress: IP address of the client that generated the
4557# audit action. Must be exact match.
4558# clientUserAgent: HTTP user agent of the client that generated
4559# the audit action. Must be exact match.
4560# eventType: The event type, such as `Create`, `Update`, or
4561# `Delete`.
4562# Must be exact match.
4563# objectId: The ID of the object involved in the audit action.
4564# The format of this ID
4565# varies by object type. Must be exact match.
4566# objectType: The type of the object involved in the audit
4567# action, such as `Watchlist`
4568# or `TemporalDataObject`. Must be exact match.
4569# success: Whether or not the action was successful.
4570# id: The unique ID of an audit log entry. Multiple values can be
4571# provided.
4572# offset: Offset into result set, for paging.
4573# limit: Limit on result size, for paging (page size). Audit
4574# queries are
4575# lightweight so the default of 100 is higher than the default offset
4576# used elsewhere in the API.
4577# orderBy: Order information. Default is order by
4578# `createdDateTime` descending.
4579auditLog(
4580toDateTime: DateTime,
4581fromDateTime: DateTime,
4582organizationId: ID,
4583userName: String,
4584clientIpAddress: String,
4585clientUserAgent: String,
4586eventType: String,
4587objectId: ID,
4588objectType: String,
4589success: Boolean,
4590id: [ID!],
4591offset: Int,
4592limit: Int,
4593orderBy: [AuditLogOrderBy!]
4594): AuditLogEntryList!
4595
4596# Get the media share by media shareId
4597mediaShare(id: ID!): MediaShare!
4598
4599# Retrieve a shared collection
4600#
4601# Arguments
4602# shareId: share token
4603sharedCollection(shareId: ID!): SharedCollection