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