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 a list of IDs to retrieve the specific TDOs.
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,
92ids: [ID],
93offset: Int,
94limit: Int,
95sourceId: ID,
96programId: ID,
97scheduledJobId: ID,
98sampleMedia: Boolean,
99includePublic: Boolean,
100orderBy: TemporalDataObjectOrderBy,
101orderDirection: OrderDirection,
102dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
103mentionId: ID
104): TDOList
105
106# Retrieve a single temporal data object
107# Example:
108# Request:
109# query {
110#
111# temporalDataObject(
112#
113# id: 1570654874) {
114#
115# id
116#
117# name
118#
119# }
120# }
121# Response:
122# {
123#
124# "data": {
125#
126# "temporalDataObject": {
127#
128# "id": "1570654874",
129#
130# "name": "example"
131#
132# }
133#
134# }
135# }
136#
137# Arguments
138# id: the TDO ID
139temporalDataObject(id: ID!): TemporalDataObject
140
141# Retrieve a single Asset
142# Example:
143# Request:
144# query {
145#
146# asset(
147#
148# id: "1570654874_4hJtNKSUXD") {
149#
150# id
151#
152# name
153#
154# description
155#
156# }
157# }
158# Response:
159# {
160#
161# "data": {
162#
163# "asset": {
164#
165# "id": "1570654874_4hJtNKSUXD",
166#
167# "name": "example",
168#
169# "description": "example"
170#
171# }
172#
173# }
174# }
175#
176# Arguments
177# id: The asset ID
178asset(id: ID!): Asset
179
180# Retrieve multiple assets
181# Example:
182# Request:
183# query {
184#
185# assets(
186#
187# ids:["1570654874_4hJtNKSUXD"],
188#
189# contentTypes:[],
190#
191# assetTypes:["text"],
192#
193# sourceEngineIds:[],
194#
195# createdDateFilter:null,
196#
197# scrollId: null){
198#
199# assets{
200#
201# records{id}
202#
203# count
204#
205# }
206#
207# scrollId
208#
209# }
210# }
211# Response:
212# {
213#
214# "data": {
215#
216# "assets": {
217#
218# "assets": {
219#
220# "records": [],
221#
222# "count": 0
223#
224# },
225#
226# "scrollId": ""
227#
228# }
229#
230# }
231# }
232#
233# Arguments
234# ids: List of asset ids
235# contentTypes: Filter assets with content type included in the
236# list
237# See https://www.iana.org/assignments/media-types/media-types.xhtml
238# assetTypes: Filter assets with assetType included in the list
239# See https://support.veritone.com/s/article/000003943 for list of values.
240# sourceEngineIds: Filter by source engine.
241# Not all assets have associated engineId, ex. media assets
242# createdDateFilter: Filter by created date
243# Note createdDateFilter.filter is required, but currently ignored
244# offset: Offset to skip to a certain element in the result, for
245# paging.
246# limit: Maximum number of results to retrieve in this result.
247# Page size.
248# scrollId: Use this field when sequentially iterating over the
249# assets list
250# This is required for when offset + limit exceeds 10000.
251# The value of this field is set from the response of the first/previous
252# assets query
253assets(
254ids: [ID!],
255contentTypes: [String!],
256assetTypes: [String!],
257sourceEngineIds: [String!],
258createdDateFilter: TemporalDataObjectDateTimeFilter,
259offset: Int,
260limit: Int,
261scrollId: String
262): AssetScrollList
263
264# Retrieve a single Widget
265# Example:
266# Request:
267# query {
268#
269# widget(
270#
271# id: "KOIFUT_rT_Oy3Ev9zfKT6A") {
272#
273# collection{
274#
275# id
276#
277# }
278#
279# }
280# }
281# Response:
282# {
283#
284# "data": {
285#
286# "widget": {
287#
288# "collection": {
289#
290# "id": "243625"
291#
292# }
293#
294# }
295#
296# }
297# }
298#
299# Arguments
300# id: The widget ID
301widget(id: ID!): Widget
302
303# Retrieve clone job entries
304# Example:
305# Request:
306# query {
307#
308# cloneRequests {
309#
310# records{
311#
312# id
313#
314# }
315#
316# }
317# }
318#
319# Response:
320#
321# {
322#
323# "data": {
324#
325# "cloneRequests": {
326#
327# "records": []
328#
329# }
330#
331# }
332# }
333#
334# Arguments
335# id: Provide an ID to retrieve a single specific clone request.
336# applicationId: Application ID to get clone requests for.
337# Defaults to the user's own application.
338cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
339
340# Retrieve most recent builds
341# Example:
342# Request:
343# query {
344#
345# recentBuilds(limit:2) {
346#
347# records{
348#
349# id
350#
351# name
352#
353# }
354#
355# }
356# }
357# Response:
358# {
359#
360# "data": {
361#
362# "recentBuilds": {
363#
364# "records": [
365#
366# {
367#
368# "id": "44193f81-57b4-47dd-9fe0-be95000776d9",
369#
370# "name": "example Version 5"
371#
372# },
373#
374# {
375#
376# "id": "bae12129-2724-40c3-abd2-6bb4021f21ae",
377#
378# "name": "example Version 4"
379#
380# }
381#
382# ]
383#
384# }
385#
386# }
387# }
388#
389# Arguments
390# buildStatus: Engine build status:
391# offset: Specify maximum number of results to retrieve in this
392# result. Page size.
393# limit: Specify maximum number of results to retrieve in this
394# result.
395# orderBy: Set order information on the query. Multiple fields
396# are supported.
397# Default order by modifiedDateTime desc
398recentBuilds(
399buildStatus: [BuildStatus!],
400offset: Int,
401limit: Int,
402orderBy: [EngineBuildOrderBy!]
403): BuildList
404
405# Retrieve engine overview
406# Example:
407# Request:
408# query {
409#
410# engineOverview {
411#
412# ready
413#
414# }
415# }
416#
417# Response:
418#
419# {
420#
421# "data": {
422#
423# "engineOverview": {
424#
425# "ready": 7
426#
427# }
428#
429# }
430# }
431engineOverview: EngineOverview
432
433# Retrieve engines
434# Example:
435# Request:
436# query {
437#
438# engines(limit:2) {
439#
440# records{
441#
442# id
443#
444# state
445#
446# }
447#
448# }
449# }
450# Response:
451# {
452#
453# "data": {
454#
455# "engines": {
456#
457# "records": [
458#
459# {
460#
461# "id": "2",
462#
463# "state": "pending"
464#
465# },
466#
467# {
468#
469# "id": "1",
470#
471# "state": "pending"
472#
473# }
474#
475# ]
476#
477# }
478#
479# }
480# }
481#
482# Arguments
483# id: Provide an ID to retrieve a single specific engine.
484# categoryId: Provide a category ID to filter by engine category.
485# category: provide a category name or ID to filter by engine
486# category
487# state: Provide a list of states to filter by engine state.
488# owned: If true, return only engines owned by the user's
489# organization.
490# libraryRequired: If true, return only engines that require a
491# library.
492# createsTDO: If true, return only engines that create their own
493# TDO.
494# If false, return only engines that do not create a TDO.
495# If not set, return either.
496# name: Provide a name, or part of a name, to search by engine
497# name. If `filter.name` is also provided
498# then the value of this field will be ignored.
499# offset: Specify maximum number of results to retrieve in this
500# result. Page size.
501# limit: Specify maximum number of results to retrieve in this
502# result.
503# filter: Filters for engine attributes
504# orderBy: Provide a list of EngineSortField to sort by.
505# edgeVersion: Edge version to filter
506engines(
507id: ID,
508ids: [ID!],
509categoryId: String,
510category: String,
511state: [EngineState],
512owned: Boolean,
513libraryRequired: Boolean,
514createsTDO: Boolean,
515name: String,
516offset: Int,
517limit: Int,
518filter: EngineFilter,
519orderBy: [EngineSortField],
520edgeVersion: Int
521): EngineList
522
523# Retrieve a single engine by ID
524# Example:
525# Request:
526# query {
527#
528# engine(id:1) {
529#
530# name
531#
532# state
533#
534# }
535# }
536# Response:
537# {
538#
539# "data": {
540#
541# "engine": {
542#
543# "name": "example",
544#
545# "state": "pending"
546#
547# }
548#
549# }
550# }
551#
552# Arguments
553# id: Provide the engine ID
554engine(id: ID!): Engine
555
556# Retrieve an engine build
557# Example:
558# Request:
559# query {
560#
561# engineBuild(id: "2a1a1b58-6983-4002-b9ed-7b7f325f621a"){
562#
563# name
564#
565# engineId
566#
567# }
568# }
569#
570# Response:
571# {
572#
573# "data": {
574#
575# "engineBuild": {
576#
577# "name": "example Version 1",
578#
579# "engineId": "1"
580#
581# }
582#
583# }
584# }
585#
586# Arguments
587# id: Provide the build ID
588engineBuild(id: ID!): Build
589
590# Retrieve engine categories
591# Example:
592# Request:
593# query {
594#
595# engineCategories(limit:2) {
596#
597# records {
598#
599# id
600#
601# type {
602#
603# name
604#
605# }
606#
607# name
608#
609# }
610#
611# }
612# }
613# Response:
614# {
615#
616# "data": {
617#
618# "engineCategories": {
619#
620# "records": [
621#
622# {
623#
624# "id": "581dbb32-ea5b-4458-bd15-8094942345e3",
625#
626# "type": {
627#
628# "name": "Cognition"
629#
630# },
631#
632# "name": "Transcode"
633#
634# },
635#
636# {
637#
638# "id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182",
639#
640# "type": {
641#
642# "name": "Cognition"
643#
644# },
645#
646# "name": "Transcription"
647#
648# }
649#
650# ]
651#
652# }
653#
654# }
655# }
656#
657# Arguments
658# id: Provide an ID to retrieve a single specific engine
659# category.
660# ids: Provide multiple IDs to retrieve engine categories
661# name: Provide a name, or part of one, to search by category
662# name
663# type: Return all categories of an engine type
664# offset: Specify maximum number of results to retrieve in this
665# result. Page size.
666# limit: Specify maximum number of results to retrieve in this
667# result.
668engineCategories(
669id: ID,
670ids: [ID!],
671name: String,
672type: String,
673offset: Int,
674limit: Int
675): EngineCategoryList
676
677# Retrieve a specific engine category\
678# Example:
679# Request:
680# query {
681#
682# engineCategory(id: "581dbb32-ea5b-4458-bd15-8094942345e3") {
683#
684# name
685#
686# type{
687#
688# name
689#
690# }
691#
692# }
693# }
694# Response:
695# {
696#
697# "data": {
698#
699# "engineCategory": {
700#
701# "name": "Transcode",
702#
703# "type": {
704#
705# "name": "Cognition"
706#
707# }
708#
709# }
710#
711# }
712# }
713#
714# Arguments
715# id: Supply the ID of the engine category to retrieve
716engineCategory(id: ID!): EngineCategory
717
718# Retrieve jobs
719# Example:
720# Request:
721# query {
722#
723# jobs(limit:2) {
724#
725# records{
726#
727# id
728#
729# name
730#
731# }
732#
733# }
734# }
735# Response:
736# {
737#
738# "data": {
739#
740# "jobs": {
741#
742# "records": []
743#
744# }
745#
746# }
747# }
748#
749# Arguments
750# id: Provide an ID to retrieve a single specific job.
751# status: Provide a list of status strings to filter by status
752# offset: Provide an offset to skip to a certain element in the
753# result, for paging.
754# limit: Specify the maximum number of results to included in
755# this response, or page size.
756# applicationId: Provide an application ID to filter jobs for a
757# given application.
758# Defaults to the user's own application.
759# targetId: Provide a target ID to get the set of jobs running
760# against a particular TDO.
761# clusterId: Provide a cluster ID to get the jobs running on a
762# specific cluster
763# scheduledJobIds: Provide a list of scheduled job IDs to get
764# jobs associated with the scheduled jobs
765# hasScheduledJobId: Return only jobs that are (true) or are not
766# (false) associated with a scheduled job
767# orderBy: Provide sort information. The default is to sort by
768# createdDateTime descending.
769# dateTimeFilter: Filter by date/time field
770# applicationIds: Provide list of application IDs to filter jobs.
771# Defaults to the user's own application.
772# engineIds: Provide a list of engine IDs to filter for jobs
773# that contain tasks for the specified engines.
774# engineCategoryIds: Provide a list of engine category IDs to
775# filter for jobs
776# that contain tasks for engines in the specific categories.
777# dagTemplateIds: Provide a list of DAG template IDs to get jobs
778# associated with the DAG templates
779jobs(
780hasTargetTDO: Boolean,
781id: ID,
782status: [JobStatusFilter!],
783applicationStatus: String,
784offset: Int,
785limit: Int,
786applicationId: ID,
787targetId: ID,
788clusterId: ID,
789scheduledJobIds: [ID!],
790hasScheduledJobId: Boolean,
791orderBy: [JobSortField!],
792dateTimeFilter: [JobDateTimeFilter!],
793applicationIds: [ID],
794engineIds: [ID!],
795engineCategoryIds: [ID!],
796dagTemplateIds: [ID]
797): JobList
798
799# Retrieve a single job by ID
800#
801# Arguments
802# id: the job ID.
803job(id: ID!): Job
804
805# Retrieve a single task by ID
806#
807# Arguments
808# id: Provide the task ID.
809task(id: ID!): Task
810
811# Retrieve entity identifier types
812# Example:
813# Request:
814# query {
815#
816# entityIdentifierTypes(limit:2) {
817#
818# records{
819#
820# id
821#
822# label
823#
824# }
825#
826# }
827# }
828# Response:
829# {
830#
831# "data": {
832#
833# "entityIdentifierTypes": {
834#
835# "records": [
836#
837# {
838#
839# "id": "face",
840#
841# "label": "Face"
842#
843# },
844#
845# {
846#
847# "id": "audio-recording",
848#
849# "label": "audio file"
850#
851# }
852#
853# ]
854#
855# }
856#
857# }
858# }
859#
860# Arguments
861# id: Provide an ID to retrieve a single specific entity
862# identifier type.
863# offset: Provide an offset to skip to a certain element in the
864# result, for paging.
865# limit: Specify maximum number of results to retrieve in this
866# result. Page size.
867entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
868
869# Retrieve an entity identifier type
870# Example:
871# Request:
872# query {
873#
874# entityIdentifierType(id:"face") {
875#
876# label
877#
878# entityIdentifierItems {
879#
880# libraryTypeId
881#
882# }
883#
884# }
885# }
886# Response:
887# {
888#
889# "data": {
890#
891# "entityIdentifierType": {
892#
893# "label": "Face",
894#
895# "entityIdentifierItems": [
896#
897# {
898#
899# "libraryTypeId": "people"
900#
901# },
902#
903# {
904#
905# "libraryTypeId": "suspect"
906#
907# },
908#
909# {
910#
911# "libraryTypeId": "people-known-offender"
912#
913# },
914#
915# {
916#
917# "libraryTypeId": "people-of-interest"
918#
919# }
920#
921# ]
922#
923# }
924#
925# }
926# }
927#
928# Arguments
929# id: Provide the entity identifier type ID
930entityIdentifierType(id: ID!): EntityIdentifierType
931
932# Retrieve all library types
933# Example:
934# Request:
935# query {
936#
937# libraryTypes(limit:2) {
938#
939# records{
940#
941# id
942#
943# entityTypeName
944#
945# }
946#
947# }
948# }
949# Response:
950# {
951#
952# "data": {
953#
954# "libraryTypes": {
955#
956# "records": [
957#
958# {
959#
960# "id": "people-known-offender",
961#
962# "entityTypeName": "known offender"
963#
964# },
965#
966# {
967#
968# "id": "dataset",
969#
970# "entityTypeName": "dataset"
971#
972# }
973#
974# ]
975#
976# }
977#
978# }
979# }
980#
981# Arguments
982# id: Provide an ID to retrieve a single specific library type.
983# offset: Provide an offset to skip to a certain element in the
984# result, for paging.
985# limit: Specify maximum number of results to retrieve in this
986# result. Page size.
987libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
988
989# Retrieve a single library type
990# Example:
991# Request:
992# query {
993#
994# libraryType(id: "people-known-offender") {
995#
996# entityTypeName
997#
998# label
999#
1000# }
1001# }
1002# Response:
1003# {
1004#
1005# "data": {
1006#
1007# "libraryType": {
1008#
1009# "entityTypeName": "known offender",
1010#
1011# "label": "IDentify - Known Offender"
1012#
1013# }
1014#
1015# }
1016# }
1017#
1018# Arguments
1019# id: Provide an ID to retrieve a single specific library type.
1020libraryType(id: ID): LibraryType
1021
1022# Retrieve libraries and entities
1023# Example:
1024# Request:
1025# query {
1026#
1027# libraries(limit:2) {
1028#
1029# records {
1030#
1031# id
1032#
1033# name
1034#
1035# libraryTypeId
1036#
1037# }
1038#
1039# }
1040# }
1041# Response:
1042# {
1043#
1044# "data": {
1045#
1046# "libraries": {
1047#
1048# "records": [
1049#
1050# {
1051#
1052# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1053#
1054# "name": "example",
1055#
1056# "libraryTypeId": "123"
1057#
1058# }
1059#
1060# ]
1061#
1062# }
1063#
1064# }
1065# }
1066#
1067# Arguments
1068# id: Provide an ID to retrieve a single specific library.
1069# name: Provide a name string to search by name.
1070# type: Provide the name or ID of a library to search for
1071# libraries
1072# that contain that type.
1073# entityIdentifierTypeIds: Provide the id of an entity identifier
1074# type to search for libraries that correlate
1075# to that type.
1076# includeOwnedOnly: Specify true if only libraries owned by the
1077# user's organization
1078# should be returned. Otherwise, shared libraries will be included.
1079# offset: Provide an offset to skip to a certain element in the
1080# result, for paging.
1081# limit: Specify maximum number of results to retrieve in this
1082# result. Page size.
1083# orderBy: Specify a field to order by
1084# orderDirection: Specify the direction to order by
1085libraries(
1086id: ID,
1087name: String,
1088type: String,
1089entityIdentifierTypeIds: [String!],
1090includeOwnedOnly: Boolean,
1091offset: Int,
1092limit: Int,
1093orderBy: LibraryOrderBy,
1094orderDirection: OrderDirection
1095): LibraryList
1096
1097# Retrieve a specific library
1098# Example:
1099# Request:
1100# query {
1101#
1102# library(id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1103#
1104# name
1105#
1106# organizationId
1107#
1108# }
1109# }
1110# Response:
1111# {
1112#
1113# "data": {
1114#
1115# "library": {
1116#
1117# "name": "example",
1118#
1119# "organizationId": "35521"
1120#
1121# }
1122#
1123# }
1124# }
1125#
1126# Arguments
1127# id: Provide a library ID.
1128library(id: ID!): Library
1129
1130# Retrieve a specific library engine model
1131# Example:
1132# Request:
1133# query {
1134#
1135# libraryEngineModel(id: "87714ca6-8dbd-4da0-9dc0-d9233927b00d") {
1136#
1137# trainStatus
1138#
1139# engineId
1140#
1141# }
1142# }
1143# Response:
1144# {
1145#
1146# "data": {
1147#
1148# "libraryEngineModel": {
1149#
1150# "trainStatus": "pending",
1151#
1152# "engineId": "1"
1153#
1154# }
1155#
1156# }
1157# }
1158#
1159# Arguments
1160# id: Provide the library engine model ID
1161libraryEngineModel(id: ID!): LibraryEngineModel
1162
1163# Retrieve a specific entity
1164# Example:
1165# Request:
1166# query {
1167#
1168# entity(id: "85b700fa-f327-4fea-b94b-ed83054170db") {
1169#
1170# name
1171#
1172# libraryId
1173#
1174# isPublished
1175#
1176# }
1177# }
1178# Response:
1179# {
1180#
1181# "data": {
1182#
1183# "entity": {
1184#
1185# "name": "example",
1186#
1187# "libraryId": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1188#
1189# "isPublished": false
1190#
1191# }
1192#
1193# }
1194# }
1195#
1196# Arguments
1197# id: Provide an entity ID.
1198entity(id: ID!): Entity
1199
1200# Retrieve a list of entities across libraries
1201# Example:
1202# Request:
1203# query {
1204#
1205# entities(libraryIds: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1206#
1207# records {
1208#
1209# id
1210#
1211# name
1212#
1213# isPublished
1214#
1215# }
1216#
1217# }
1218# }
1219# Response:
1220# {
1221#
1222# "data": {
1223#
1224# "entities": {
1225#
1226# "records": [
1227#
1228# {
1229#
1230# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1231#
1232# "name": "example",
1233#
1234# "isPublished": false
1235#
1236# }
1237#
1238# ]
1239#
1240# }
1241#
1242# }
1243# }
1244#
1245# Arguments
1246# ids: Provide a list of entity IDs to retrieve those entities
1247# libraryIds: Provide a list of library IDs to retrieve entities
1248# across
1249# multiple libraries.
1250entities(
1251ids: [ID!],
1252libraryIds: [ID!],
1253isPublished: Boolean,
1254identifierTypeId: ID,
1255name: String,
1256offset: Int,
1257limit: Int,
1258orderBy: LibraryEntityOrderBy,
1259orderDirection: OrderDirection
1260): EntityList
1261
1262# Retrieve library configuration
1263# Example:
1264# Request:
1265# query {
1266#
1267# libraryConfiguration(id:"7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7") {
1268#
1269# confidence{
1270#
1271# min
1272#
1273# max
1274#
1275# }
1276#
1277# }
1278# }
1279# Response:
1280# {
1281#
1282# "data": {
1283#
1284# "libraryConfiguration": {
1285#
1286# "confidence": {
1287#
1288# "min": 0,
1289#
1290# "max": 100
1291#
1292# }
1293#
1294# }
1295#
1296# }
1297# }
1298#
1299# Arguments
1300# id: Provide configuration id
1301libraryConfiguration(id: ID!): LibraryConfiguration
1302
1303# Retrieve applications. These are custom applications integrated into
1304# the Veritone platform using the VDA framework.
1305# Example:
1306# Request:
1307# query {
1308#
1309# applications(limit:2) {
1310#
1311# records {
1312#
1313# id
1314#
1315# name
1316#
1317# }
1318#
1319# }
1320# }
1321# Response:
1322# {
1323#
1324# "data": {
1325#
1326# "applications": {
1327#
1328# "records": [
1329#
1330# {
1331#
1332# "id": "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a",
1333#
1334# "name": "appexamplebill"
1335#
1336# },
1337#
1338# {
1339#
1340# "id": "5908703b-51b4-4291-9787-b54bada73b0a",
1341#
1342# "name": "appexample2"
1343#
1344# }
1345#
1346# ]
1347#
1348# }
1349#
1350# }
1351# }
1352#
1353# Arguments
1354# id: Provide an ID to retrieve a single specific application.
1355# status: Provide a status, such as "draft" or "active"
1356# owned: If true, return only applications owned by the user's
1357# organization.
1358# orgId: For super admin user only, if specified, the query
1359# returns applications for this orgId.
1360# isPublic: Filter applications that are public
1361# excludeViewOnly: Include package grantType==VIEW
1362# filter: Filters for application attributes
1363# offset: Provide an offset to skip to a certain element in the
1364# result, for paging.
1365# limit: Specify maximum number of results to retrieve in this
1366# result. Page size.
1367# orderBy: Provide a list of ApplicationSortField to sort by.
1368# accessScope: Specify one or more access scopes to filter by
1369# accessible applications
1370applications(
1371id: ID,
1372status: ApplicationStatus,
1373owned: Boolean,
1374orgId: ID,
1375isPublic: Boolean,
1376excludeViewOnly: Boolean,
1377filter: ApplicationFilter,
1378offset: Int,
1379limit: Int,
1380orderBy: [ApplicationSortField],
1381accessScope: [AccessScope!]
1382): ApplicationList
1383
1384# Retrieve organizations
1385# Example:
1386# Request:
1387# query {
1388#
1389# organizations(limit:2) {
1390#
1391# records {
1392#
1393# id
1394#
1395# name
1396#
1397# }
1398#
1399# }
1400# }
1401# Response:
1402# {
1403#
1404# "data": {
1405#
1406# "organizations": {
1407#
1408# "records": [
1409#
1410# {
1411#
1412# "id": "35521",
1413#
1414# "name": "WTS API Docs Org"
1415#
1416# }
1417#
1418# ]
1419#
1420# }
1421#
1422# }
1423# }
1424#
1425# Arguments
1426# id: Provide an ID to retrieve a single specific organization.
1427# offset: Provide an offset to skip to a certain element in the
1428# result, for paging.
1429# limit: Specify maximum number of results to retrieve in this
1430# result. Page size.
1431# kvpProperty: Provide a property from the organization kvp to
1432# filter the organization list.
1433# kvpValue: Provide value to for the kvpFeature filter.
1434# If not present the filter becomes kvpProperty existence filter
1435# name: Optionally, supply a string for string match
1436# status: Optionally, filter by Organization's status
1437# nameMatch: Supply the type of string match to apply.
1438organizations(
1439id: ID,
1440offset: Int,
1441limit: Int,
1442kvpProperty: String,
1443kvpValue: String,
1444name: String,
1445status: OrganizationStatus,
1446nameMatch: StringMatch,
1447isHubManaged: Boolean
1448): OrganizationList
1449
1450# Retrieve a single organization
1451# Example:
1452# Request:
1453# query {
1454#
1455# organization(id: "35521") {
1456#
1457# status
1458#
1459# }
1460# }
1461# Response:
1462# {
1463#
1464# "data": {
1465#
1466# "organization": {
1467#
1468# "status": "active"
1469#
1470# }
1471#
1472# }
1473# }
1474#
1475# Arguments
1476# id: The organization ID
1477# TODO take application ID as well as org ID
1478organization(id: ID!): Organization
1479
1480# Retrieve basic organization info about the organizations to which the user
1481# belongs
1482# Example:
1483# Request:
1484# query {
1485#
1486# myOrganizations {
1487#
1488# records {
1489#
1490# id
1491#
1492# name
1493#
1494# }
1495#
1496# }
1497# }
1498# Response:
1499# {
1500#
1501# "data": {
1502#
1503# "myOrganizations": {
1504#
1505# "records": [
1506#
1507# {
1508#
1509# "id": "35521",
1510#
1511# "name": "WTS API Docs Org"
1512#
1513# }
1514#
1515# ]
1516#
1517# }
1518#
1519# }
1520# }
1521#
1522# Arguments
1523# offset: Provide an offset to skip to a certain element in the
1524# result, for paging.
1525# limit: Specify maximum number of results to retrieve in this
1526# result. Page size.
1527# status: Filter by organization status
1528myOrganizations(
1529offset: Int,
1530limit: Int,
1531status: OrganizationStatus,
1532userName: String
1533): OrganizationInfoList
1534
1535# Retrieve the login configuration for an organization
1536# Example:
1537# Request:
1538# query {
1539#
1540# loginConfiguration(slug: "my-organization") {
1541#
1542# organizationInfo {
1543#
1544# id
1545#
1546# name
1547#
1548# }
1549#
1550# }
1551# }
1552# Response:
1553# {
1554#
1555# "data": {
1556#
1557# "loginConfiguration": {
1558#
1559# "organizationInfo": {
1560#
1561# "id": "12345",
1562#
1563# "name": "My Organization"
1564#
1565# }
1566#
1567# }
1568#
1569# }
1570# }
1571#
1572# Arguments
1573# slug: The login slug associated with the login configuration
1574# for an organization
1575loginConfiguration(slug: String!): LoginConfiguration
1576
1577# Retrieve all login configurations for the Instance
1578# Example:
1579# Request:
1580# query {
1581#
1582# instanceLoginConfigurations {
1583#
1584# records {
1585#
1586# slug
1587#
1588# }
1589#
1590# }
1591# }
1592# Response:
1593# {
1594#
1595# "data": {
1596#
1597# "instanceLoginConfigurations": {
1598#
1599# records: [
1600#
1601# {
1602#
1603# "slug": "instance-slug",
1604#
1605# },
1606#
1607# {
1608#
1609# "slug": "other-instance-slug",
1610#
1611# }
1612#
1613# ]
1614#
1615# }
1616#
1617# }
1618# }
1619#
1620# Arguments
1621# offset: Provide an offset to skip to a certain element in the
1622# result, for paging.
1623# limit: Specify maximum number of results to retrieve in this
1624# result. Page size.
1625instanceLoginConfigurations(offset: Int, limit: Int): LoginConfigurationList
1626
1627# Retrieve a single registration configuration
1628#
1629# Example:
1630# Request:
1631# query {
1632#
1633# registrationConfiguration(id: "12345") {
1634#
1635# slug
1636#
1637# }
1638# }
1639# Response:
1640# {
1641#
1642# "data": {
1643#
1644# "registrationConfiguration": {
1645#
1646# "slug": "test"
1647#
1648# }
1649#
1650# }
1651# }
1652#
1653# Arguments
1654# id: The registration configuration ID
1655registrationConfiguration(id: ID!): RegistrationConfiguration
1656
1657# Retrieve a single registration configuration by id:
1658#
1659# Example:
1660# Request:
1661# query {
1662#
1663# registrationConfiguration(id: "12345") {
1664#
1665# slug
1666#
1667# }
1668# }
1669# Response:
1670# {
1671#
1672# "data": {
1673#
1674# "registrationConfiguration": {
1675#
1676# "slug": "test"
1677#
1678# }
1679#
1680# }
1681# }
1682#
1683# Retrieve a registration configuration info by slug:
1684#
1685# Request:
1686# query {
1687#
1688# registrationConfigurationInfo(slug: "test") {
1689#
1690# id
1691#
1692# }
1693# }
1694# Response:
1695# {
1696#
1697# "data": {
1698#
1699# "registrationConfigurationInfo": {
1700#
1701# "id": "12345"
1702#
1703# }
1704#
1705# }
1706# }
1707#
1708# Arguments
1709# id: The registration configuration ID
1710# slug: The registration configuration url slug
1711registrationConfigurationInfo(id: ID, slug: String): RegistrationConfigurationInfo
1712
1713# Retrieve permissions
1714# Example:
1715# Request:
1716# query {
1717#
1718# permissions(limit:5) {
1719#
1720# records {
1721#
1722# id
1723#
1724# name
1725#
1726# }
1727#
1728# }
1729# }
1730#
1731# Response:
1732# {
1733#
1734# "data": {
1735#
1736# "permissions": {
1737#
1738# "records": [
1739#
1740# {
1741#
1742# "id": "2",
1743#
1744# "name": "admin.access"
1745#
1746# },
1747#
1748# {
1749#
1750# "id": "9",
1751#
1752# "name": "admin.group.create"
1753#
1754# },
1755#
1756# {
1757#
1758# "id": "12",
1759#
1760# "name": "admin.group.delete"
1761#
1762# },
1763#
1764# {
1765#
1766# "id": "10",
1767#
1768# "name": "admin.group.read"
1769#
1770# },
1771#
1772# {
1773#
1774# "id": "11",
1775#
1776# "name": "admin.group.update"
1777#
1778# }
1779#
1780# ]
1781#
1782# }
1783#
1784# }
1785# }
1786#
1787# Arguments
1788# id: Provide an ID to retrieve a single specific permission.
1789# offset: Provide an offset to skip to a certain element in the
1790# result, for paging.
1791# limit: Specify maximum number of results to retrieve in this
1792# result. Page size.
1793permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
1794
1795# Retrieve users
1796# Example:
1797# Request:
1798# query {
1799#
1800# users(
1801#
1802# organizationIds:"35521",
1803#
1804# limit: 2) {
1805#
1806# records {
1807#
1808# id
1809#
1810# name
1811#
1812# }
1813#
1814# }
1815# }
1816# Response:
1817# {
1818#
1819# "data": {
1820#
1821# "users": {
1822#
1823# "records": [
1824#
1825# {
1826#
1827# "id": "267de7e1-efb2-444a-a524-210328b78503",
1828#
1829# "name": "example"
1830#
1831# },
1832#
1833# {
1834#
1835# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066",
1836#
1837# "name": "example1"
1838#
1839# }
1840#
1841# ]
1842#
1843# }
1844#
1845# }
1846# }
1847#
1848# Arguments
1849# id: Provide an ID to retrieve a single specific user.
1850# A user ID is a string in UUID format.
1851# ids: Provide IDs to retrieve multiple users by ID.
1852# name: Provide a name, or part of one, to search by name.
1853# organizationIds: Provide a list of organization IDs to filter
1854# your search by organization.
1855# offset: Provide an offset to skip to a certain element in the
1856# result, for paging.
1857# limit: Specify maximum number of results to retrieve in this
1858# result. Page size.
1859# includeAllOrgUsers: Include all organization users.
1860# dateTimeFilter: Filter by date/time field
1861# status: Filter by account status
1862# statuses: Filter by account status list. Status field will take
1863# precedence if used
1864# roleIds: Filter by application roles
1865users(
1866id: ID,
1867ids: [ID],
1868name: String,
1869organizationIds: [ID],
1870offset: Int,
1871limit: Int,
1872includeAllOrgUsers: Boolean,
1873dateTimeFilter: [UsersDateTimeFilter!],
1874status: UserStatus,
1875statuses: [UserStatus!],
1876roleIds: [ID]
1877): UserList
1878
1879# Retrieve an individual user
1880# Example:
1881# Request:
1882# query {
1883#
1884# user(id: "267de7e1-efb2-444a-a524-210328b78503") {
1885#
1886# name
1887#
1888# status
1889#
1890# }
1891# }
1892# Response:
1893# {
1894#
1895# "data": {
1896#
1897# "user": {
1898#
1899# "name": "example",
1900#
1901# "status": "deleted"
1902#
1903# }
1904#
1905# }
1906# }
1907#
1908# Arguments
1909# id: The user ID.
1910# A user ID is a string in UUID format.
1911user(id: ID!, organizationIds: [ID]): User
1912
1913# Retrieve user's organization API tokens
1914# Example:
1915# Request:
1916# query {
1917#
1918# tokens {
1919#
1920# id
1921#
1922# applicationId
1923#
1924# }
1925# }
1926# Response:
1927# {
1928#
1929# "data": {
1930#
1931# "tokens": []
1932#
1933# }
1934# }
1935tokens: [Token]
1936
1937# Retrieve information for the current logged-in user
1938# Example:
1939# Request:
1940# query {
1941#
1942# me {
1943#
1944# id
1945#
1946# organizationId
1947#
1948# }
1949# }
1950# Response:
1951# {
1952#
1953# "data": {
1954#
1955# "me": {
1956#
1957# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008",
1958#
1959# "organizationId": "35521"
1960#
1961# }
1962#
1963# }
1964# }
1965me: User
1966
1967# Retrieve groups
1968# Example:
1969# Request:
1970# query {
1971#
1972# groups {
1973#
1974# records {
1975#
1976# id
1977#
1978# name
1979#
1980# }
1981#
1982# }
1983# }
1984# Response:
1985# {
1986#
1987# "data": {
1988#
1989# "groups": {
1990#
1991# "records": [
1992#
1993# {
1994#
1995# "id": "8db639c1-c926-4f83-90de-d86c2ae5973d",
1996#
1997# "name": "WTS API Docs Org"
1998#
1999# }
2000#
2001# ]
2002#
2003# }
2004#
2005# }
2006# }
2007#
2008# Arguments
2009# id: Provide an ID to retrieve a specific group by ID
2010# ids: Provide IDs to retrieve multiple groups by ID
2011# name: Provide a name, or part of one, to search for groups by
2012# name
2013# organizationIds: "
2014# Provide a list of organization IDs to retrieve groups defined
2015# within certain organizations.
2016# offset: Provide an offset to skip to a certain element in the
2017# result, for paging.
2018# limit: Specify maximum number of results to retrieve in this
2019# result. Page size.
2020groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
2021
2022# Retrieve a single mention
2023#
2024# Arguments
2025# mentionId: The mention ID
2026# limit: Comments pagination - limit
2027# offset: Comments pagination - limit
2028# userId: The user who owns the mention.
2029mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
2030
2031# Retrieve a shared mention
2032#
2033# Arguments
2034# shareId: share token
2035sharedMention(shareId: ID!): SharedMention
2036
2037# Search for mentions across an index.
2038# This query requires a user token.
2039# Known Issues:
2040# - Offset can not go past 10,000. To get around this, the best practice is to
2041# keep updating the start time of the query based on the last mention you have
2042# processed.
2043# Example:
2044# Request:
2045# query{
2046#
2047# searchMentions(search:{
2048#
2049# offset: 0
2050#
2051# limit: 1
2052#
2053# index: ["mine"]
2054#
2055# query:{
2056#
2057# operator: "and"
2058#
2059# conditions: [{
2060#
2061# operator: "term"
2062#
2063# field: "trackingUnitName"
2064#
2065# value: "Dallas Cowboys Super Bowl"
2066#
2067# },
2068#
2069# {
2070#
2071# operator: "term"
2072#
2073# field: "mentionStatusId"
2074#
2075# value: "1"
2076#
2077# }]
2078#
2079# }
2080#
2081# }) {
2082#
2083# jsondata
2084#
2085# }
2086# }
2087# Response:
2088# {
2089#
2090# "data": {
2091#
2092# "searchMentions": {
2093#
2094# "jsondata": {
2095#
2096# "results": [
2097#
2098# {
2099#
2100# "id": 47569938,
2101#
2102# "programFormatName": "Information and News",
2103#
2104# "mentionDate": "2017-01-31T07:59:18.000Z",
2105#
2106# "mediaStartTime": "2017-01-31T07:45:01.000Z",
2107#
2108# "mediaId": 20017455,
2109#
2110# "metadata": {
2111#
2112# "filename": "AM-RADIO",
2113#
2114# "veritone-file": {
2115#
2116# "size": 0,
2117#
2118# "filename": "AM-RADIO",
2119#
2120# "mimetype": "audio/mpeg"
2121#
2122# },
2123#
2124# "veritone-media-source": {
2125#
2126# "mediaSourceId": "14326",
2127#
2128# "mediaSourceTypeId": "1"
2129#
2130# },
2131#
2132# "veritone-program": {
2133#
2134# "programId": "3828",
2135#
2136# "programName": "AM-RADIO Morning Talk",
2137#
2138# "programImage":
2139# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2140#
2141# "programLiveImage":
2142# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG"
2143#
2144# }
2145#
2146# },
2147#
2148# "fileLocation":
2149# "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",
2150#
2151# "fileType": "audio/mpeg",
2152#
2153# "snippets": [
2154#
2155# {
2156#
2157# "startTime": 857.62,
2158#
2159# "endTime": 887.33,
2160#
2161# "text": "eighty first women's Australian Open final Monica Seles beat Steffi
2162# Graf four six six three six two in one thousand nine hundred twenty eight the
2163# Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back
2164# Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the
2165# Cowboys twenty sixteen at the one hundred fourth women's Australian Open final
2166# six three six six four that time capsule your",
2167#
2168# "hits": [
2169#
2170# {
2171#
2172# "startTime": 865.7,
2173#
2174# "endTime": 865.929,
2175#
2176# "queryTerm": "Dallas"
2177#
2178# },
2179#
2180# {
2181#
2182# "startTime": 865.93,
2183#
2184# "endTime": 866.07,
2185#
2186# "queryTerm": "Cowboys"
2187#
2188# },
2189#
2190# {
2191#
2192# "startTime": 872.74,
2193#
2194# "endTime": 873.31,
2195#
2196# "queryTerm": "Super"
2197#
2198# },
2199#
2200# {
2201#
2202# "startTime": 873.31,
2203#
2204# "endTime": 873.43,
2205#
2206# "queryTerm": "Bowl"
2207#
2208# }
2209#
2210# ]
2211#
2212# }
2213#
2214# ],
2215#
2216# "userSnippets": null,
2217#
2218# "advertiserId": 0,
2219#
2220# "advertiserName": "",
2221#
2222# "brandId": 0,
2223#
2224# "brandImage": "",
2225#
2226# "brandName": "",
2227#
2228# "campaignId": 0,
2229#
2230# "campaignName": "",
2231#
2232# "organizationId": 7295,
2233#
2234# "organizationName": "Demo Organization",
2235#
2236# "trackingUnitId": 10032,
2237#
2238# "trackingUnitName": "Dallas Cowboys Super Bowl",
2239#
2240# "mentionStatusId": 1,
2241#
2242# "mediaSourceTypeId": 1,
2243#
2244# "mediaSourceTypeName": "Audio",
2245#
2246# "mediaSourceId": 14326,
2247#
2248# "mediaSourceName": "AM-RADIO Morning Talk",
2249#
2250# "isNational": true,
2251#
2252# "spotTypeId": null,
2253#
2254# "spotTypeName": null,
2255#
2256# "programId": 3828,
2257#
2258# "programName": "AM-RADIO",
2259#
2260# "programImage":
2261# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2262#
2263# "programLiveImage":
2264# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG",
2265#
2266# "impressions": 1894,
2267#
2268# "audience": [
2269#
2270# {
2271#
2272# "gender": "men",
2273#
2274# "age_group": "35-44",
2275#
2276# "audience": 11,
2277#
2278# "isTargetMatch": true
2279#
2280# },
2281#
2282# {
2283#
2284# "gender": "men",
2285#
2286# "age_group": "45-49",
2287#
2288# "audience": 121,
2289#
2290# "isTargetMatch": true
2291#
2292# },
2293#
2294# {
2295#
2296# "gender": "men",
2297#
2298# "age_group": "50-54",
2299#
2300# "audience": 474,
2301#
2302# "isTargetMatch": true
2303#
2304# },
2305#
2306# {
2307#
2308# "gender": "men",
2309#
2310# "age_group": "65+",
2311#
2312# "audience": 95,
2313#
2314# "isTargetMatch": true
2315#
2316# },
2317#
2318# {
2319#
2320# "gender": "women",
2321#
2322# "age_group": "50-54",
2323#
2324# "audience": 19,
2325#
2326# "isTargetMatch": false
2327#
2328# },
2329#
2330# {
2331#
2332# "gender": "women",
2333#
2334# "age_group": "65+",
2335#
2336# "audience": 693,
2337#
2338# "isTargetMatch": false
2339#
2340# },
2341#
2342# {
2343#
2344# "gender": "men",
2345#
2346# "age_group": "55-64",
2347#
2348# "audience": 481,
2349#
2350# "isTargetMatch": true
2351#
2352# }
2353#
2354# ],
2355#
2356# "targetAudience": {
2357#
2358# "gender": 1,
2359#
2360# "genderName": "M",
2361#
2362# "ageGroup": [
2363#
2364# 0,
2365#
2366# 5
2367#
2368# ],
2369#
2370# "ageGroupMin": 18,
2371#
2372# "ageGroupMax": 0,
2373#
2374# "impressions": 1182
2375#
2376# },
2377#
2378# "audienceMarketCount": 3,
2379#
2380# "audienceAffiliateCount": 1,
2381#
2382# "rating": null,
2383#
2384# "ratings": null,
2385#
2386# "comments": null,
2387#
2388# "markets": [
2389#
2390# {
2391#
2392# "marketId": 54,
2393#
2394# "marketName": "Des Moines-Ames, IA"
2395#
2396# }
2397#
2398# ],
2399#
2400# "marketId": null,
2401#
2402# "marketName": null,
2403#
2404# "hourOfDay": 7,
2405#
2406# "dayOfWeek": 2,
2407#
2408# "dayOfMonth": 31,
2409#
2410# "month": 1,
2411#
2412# "year": 2017,
2413#
2414# "isMatch": true,
2415#
2416# "mentionStatusName": "Pending Verification",
2417#
2418# "complianceStatusId": null,
2419#
2420# "cognitiveEngineResults": null,
2421#
2422# "hits": 4
2423#
2424# }
2425#
2426# ],
2427#
2428# "totalResults": 579,
2429#
2430# "limit": 1,
2431#
2432# "from": 0,
2433#
2434# "to": 0,
2435#
2436# "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e",
2437#
2438# "timestamp": 1513371071
2439#
2440# }
2441#
2442# }
2443#
2444# }
2445# }
2446#
2447# Arguments
2448# search: JSON structure containing the search query.
2449# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2450# search query syntax
2451searchMentions(search: JSONData!): SearchResult
2452
2453# Search for media across an index.
2454# This query requires a user token.
2455# Example:
2456# Request:
2457# query{
2458#
2459# searchMedia(search:{
2460#
2461# offset: 0
2462#
2463# limit: 1
2464#
2465# index: ["mine"]
2466#
2467# query:{
2468#
2469# operator: "query_string"
2470#
2471# field: "transcript.transcript"
2472#
2473# value: "paris NOT \"las vegas\""
2474#
2475# }
2476#
2477# }) {
2478#
2479# jsondata
2480#
2481# }
2482# }
2483# Response:
2484# {
2485#
2486# "data": {
2487#
2488# "searchMedia": {
2489#
2490# "jsondata": {
2491#
2492# "results": [
2493#
2494# {
2495#
2496# "recording": {
2497#
2498# "recordingId": "43033727",
2499#
2500# "fileLocation":
2501# "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",
2502#
2503# "fileType": "video/mp4",
2504#
2505# "programId": "-1",
2506#
2507# "programName": "Weekly Talkshow",
2508#
2509# "programLiveImage":
2510# "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg",
2511#
2512# "mediaSourceId": "-1",
2513#
2514# "mediaSourceTypeId": "5",
2515#
2516# "sliceTime": 1512682022,
2517#
2518# "mediaStartTime": 1512681992,
2519#
2520# "aibDuration": 90,
2521#
2522# "isOwn": true,
2523#
2524# "hitStartTime": 1512682022,
2525#
2526# "hitEndTime": 1512682082
2527#
2528# },
2529#
2530# "startDateTime": 1512682022,
2531#
2532# "stopDateTime": 1512682082,
2533#
2534# "hits": [
2535#
2536# {
2537#
2538# "veritone-file": {
2539#
2540# "filename": "Veritone_v06.mp4",
2541#
2542# "mimetype": "video/mp4",
2543#
2544# "size": 162533502
2545#
2546# }
2547#
2548# }
2549#
2550# ]
2551#
2552# }
2553#
2554# ],
2555#
2556# "totalResults": 733275,
2557#
2558# "limit": 1,
2559#
2560# "from": 0,
2561#
2562# "to": 0,
2563#
2564# "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7",
2565#
2566# "timestamp": 1513361576
2567#
2568# }
2569#
2570# }
2571#
2572# }
2573# }
2574#
2575# Arguments
2576# search: JSON structure containing the search query.
2577# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2578# search query syntax
2579searchMedia(search: JSONData!): SearchResult
2580
2581# Retrieve the root folders for an organization
2582# Example:
2583# Request:
2584# query {
2585#
2586# rootFolders {
2587#
2588# id
2589#
2590# typeId
2591#
2592# }
2593# }
2594# Response:
2595# {
2596#
2597# "data": {
2598#
2599# "rootFolders": [
2600#
2601# {
2602#
2603# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2604#
2605# "typeId": 4
2606#
2607# },
2608#
2609# {
2610#
2611# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
2612#
2613# "typeId": 4
2614#
2615# }
2616#
2617# ]
2618#
2619# }
2620# }
2621#
2622# Arguments
2623# type: The type of root folder to retrieve
2624rootFolders(type: RootFolderType): [Folder]
2625
2626# Retrieve a single folder. Used to navigate the folder tree structure.
2627# Example:
2628# Request:
2629# query {
2630#
2631# folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") {
2632#
2633# typeId
2634#
2635# id
2636#
2637# childFolders{
2638#
2639# records{
2640#
2641# id
2642#
2643# }
2644#
2645# }
2646#
2647# }
2648# }
2649# Response:
2650# {
2651#
2652# "data": {
2653#
2654# "folder": {
2655#
2656# "typeId": 4,
2657#
2658# "id": "3104f61f-4bd1-4175-9fe6-27436d591c54",
2659#
2660# "childFolders": {
2661#
2662# "records": [
2663#
2664# {
2665#
2666# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
2667#
2668# },
2669#
2670# {
2671#
2672# "id": "a347319d-72da-43a2-93fc-e677876aca80"
2673#
2674# }
2675#
2676# ]
2677#
2678# }
2679#
2680# }
2681#
2682# }
2683# }
2684#
2685# Arguments
2686# id: Provide an ID to retrieve a single specific user.
2687folder(id: ID!): Folder
2688
2689# Retrieve the current platform information.
2690# Example:
2691# Request:
2692# query {
2693#
2694# platformInfo {
2695#
2696# properties
2697#
2698# aiWAREVersion {
2699#
2700# currentVersion {
2701#
2702# version
2703#
2704# }
2705#
2706# previousVersion {
2707#
2708# version
2709#
2710# }
2711#
2712# nextVersion {
2713#
2714# version
2715#
2716# }
2717#
2718# }
2719#
2720# aiWAREVersionHistory(offset: 0, limit: 30) {
2721#
2722# platformVersion {
2723#
2724# id
2725#
2726# version
2727#
2728# }
2729#
2730# id
2731#
2732# },
2733#
2734# aiWAREVersionList (orderBy: version, orderDirection: desc) {
2735#
2736# count
2737#
2738# records {
2739#
2740# id
2741#
2742# version
2743#
2744# }
2745#
2746# }
2747#
2748# }
2749# }
2750# Response:
2751# {
2752#
2753# "data": {
2754#
2755# "platformInfo": {
2756#
2757# "properties": {
2758#
2759# "Environment": "US West",
2760#
2761# "ClusterSize": "small"
2762#
2763# }
2764#
2765# "aiWAREVersion": {
2766#
2767# "currentVersion": {
2768#
2769# "version": "1.1.0"
2770#
2771# },
2772#
2773# "previousVersion": {
2774#
2775# "version": "1.0.0"
2776#
2777# },
2778#
2779# "nextVersion": {
2780#
2781# "version": "1.2.0"
2782#
2783# }
2784#
2785# },
2786#
2787# "aiWAREVersionHistory": [
2788#
2789# {
2790#
2791# platformVersion:
2792#
2793# {
2794#
2795# "id": "c7a91281-6a1e-46d4-9f2c-7f8b4a1fc493",
2796#
2797# "version": "1.3.0"
2798#
2799# },
2800#
2801# "id": "30c9c2a2-ae6a-4be2-b80c-6893d8b56780"
2802#
2803# },
2804#
2805# {
2806#
2807# platformVersion:
2808#
2809# {
2810#
2811# "id": "f785bc56-2d43-472e-8629-99f9b9a5c57e",
2812#
2813# "version": "1.3.0"
2814#
2815# },
2816#
2817# "id": "7b8a2ab2-00de-4f1b-9fb1-99e7a9cd108f"
2818#
2819# },
2820#
2821# {
2822#
2823# platformVersion:
2824#
2825# {
2826#
2827# "id": "3c4c0b46-1a61-45ab-9f3e-b8f7a14bfaa7",
2828#
2829# "version": "1.3.0"
2830#
2831# },
2832#
2833# "id": "d3499a78-efc7-4a72-a12d-852f53231e33"
2834#
2835# }
2836#
2837# ],
2838#
2839# "aiWAREVersionList": {
2840#
2841# "count": 3,
2842#
2843# "records": [
2844#
2845# {
2846#
2847# "id": "799150bb-8d67-4cd1-b204-d9346e012588",
2848#
2849# "version": "1.0.11"
2850#
2851# },
2852#
2853# {
2854#
2855# "id": "2892e80d-e0bf-4ffc-be17-4bb173d6ad29",
2856#
2857# "version": "1.0.2"
2858#
2859# },
2860#
2861# {
2862#
2863# "id": "095b9558-6fc1-4775-9696-082b9f098c47",
2864#
2865# "version": "1.0.1"
2866#
2867# },
2868#
2869# ]
2870#
2871# }
2872#
2873# }
2874#
2875# }
2876# }
2877platformInfo: PlatformInfo!
2878
2879# Example:
2880# Request:
2881# query {
2882#
2883# auditEvents(limit: 2) {
2884#
2885# records {
2886#
2887# id
2888#
2889# application
2890#
2891# }
2892#
2893# }
2894# }
2895# Response:
2896# {
2897#
2898# "data": {
2899#
2900# "auditEvents": {
2901#
2902# "records": [
2903#
2904# {
2905#
2906# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f",
2907#
2908# "application": ""
2909#
2910# }
2911#
2912# ]
2913#
2914# }
2915#
2916# }
2917# }
2918#
2919# Arguments
2920# query: An elastic query for audit events
2921# application: Filter logs by a specific application
2922# terms: Term filters to filter documents by properties in the
2923# payload
2924auditEvents(
2925query: JSONData,
2926orderDirection: OrderDirection,
2927application: String,
2928terms: [JSONData!],
2929limit: Int,
2930offset: Int
2931): AuditEventList!
2932
2933# Retrieve a folder overview
2934# Example:
2935# Request:
2936# query {
2937#
2938# folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") {
2939#
2940# childFoldersCount
2941#
2942# childNonFolderObjectsCount
2943#
2944# }
2945# }
2946# Response:
2947# {
2948#
2949# "data": {
2950#
2951# "folderOverview": {
2952#
2953# "childFoldersCount": 3,
2954#
2955# "childNonFolderObjectsCount": 0
2956#
2957# }
2958#
2959# }
2960# }
2961#
2962# Arguments
2963# ids: Tree Object Ids
2964folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
2965
2966# Example:
2967# Request:
2968# query {
2969#
2970# folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") {
2971#
2972# id
2973#
2974# typeId
2975#
2976# }
2977# }
2978# Response:
2979# {
2980#
2981# "data": {
2982#
2983# "folderSummaryDetails": [
2984#
2985# {
2986#
2987# "id": "1580701928",
2988#
2989# "typeId": 5
2990#
2991# },
2992#
2993# {
2994#
2995# "id": "1580388995",
2996#
2997# "typeId": 5
2998#
2999# },
3000#
3001# {
3002#
3003# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3004#
3005# "typeId": 4
3006#
3007# },
3008#
3009# {
3010#
3011# "id": "243625",
3012#
3013# "typeId": 3
3014#
3015# },
3016#
3017# {
3018#
3019# "id": "242599",
3020#
3021# "typeId": 3
3022#
3023# },
3024#
3025# {
3026#
3027# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3028#
3029# "typeId": 1
3030#
3031# },
3032#
3033# {
3034#
3035# "id": "a347319d-72da-43a2-93fc-e677876aca80",
3036#
3037# "typeId": 1
3038#
3039# },
3040#
3041# {
3042#
3043# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320",
3044#
3045# "typeId": 1
3046#
3047# }
3048#
3049# ]
3050#
3051# }
3052# }
3053#
3054# Arguments
3055# ids: Tree Object Ids
3056folderSummaryDetails(
3057ids: [ID!]!,
3058rootFolderType: RootFolderType
3059): [FolderSummaryDetail]
3060
3061# Retrieve configs for a given application
3062# Example:
3063# Request:
3064# query {
3065#
3066# applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3067#
3068# records: {
3069#
3070# configType
3071#
3072# configLevel
3073#
3074# }
3075#
3076# offset: 0
3077#
3078# limit: 1
3079#
3080# }
3081# }
3082# Response:
3083# {
3084#
3085# "data": {
3086#
3087# "applicationConfig": {
3088#
3089# "records": {
3090#
3091# "configType": "String",
3092#
3093# "configLevel": "Organization"
3094#
3095# }
3096#
3097# }
3098#
3099# }
3100# }
3101#
3102# Arguments
3103# orgId: Optional. Organization ID.
3104#
3105# If not specified, this will be the user's organization
3106# userId: Optional. If specified, returned the configs for this
3107# user and organization combo
3108# includeDefaults: If true, include defaults not specified
3109# configKeyRegexp: If specified, filter the configKey
3110# offset: Specify maximum number of results to retrieve in this
3111# result. Page size.
3112# limit: Specify maximum number of results to retrieve in this
3113# result.
3114applicationConfig(
3115appId: ID!,
3116orgId: ID,
3117userId: ID,
3118includeDefaults: Boolean,
3119configKeyRegexp: String,
3120offset: Int,
3121limit: Int
3122): ApplicationConfigList!
3123
3124# Retrieve config definitions for a given application
3125# Example:
3126# Request:
3127# query {
3128#
3129# applicationConfigDefinition(applicationId:
3130# "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') {
3131#
3132# records: {
3133#
3134# configType
3135#
3136# defaultValue
3137#
3138# }
3139#
3140# offset: 0
3141#
3142# limit: 1
3143#
3144# }
3145# }
3146# Response:
3147# {
3148#
3149# "data": {
3150#
3151# "applicationConfigDefinition": {
3152#
3153# "records": [{
3154#
3155# "configType": Boolean,
3156#
3157# "defaultValue": true,
3158#
3159# }]
3160#
3161# }
3162#
3163# }
3164# }
3165#
3166# Arguments
3167# configKey: If specified, grab definition for this config key
3168# offset: Specify maximum number of results to retrieve in this
3169# result. Page size.
3170# limit: Specify maximum number of results to retrieve in this
3171# result.
3172applicationConfigDefinition(
3173appId: ID!,
3174configKey: String,
3175offset: Int,
3176limit: Int
3177): ApplicationConfigDefinitionList!
3178
3179# Retrieve a single application
3180# Example:
3181# Request:
3182# query {
3183#
3184# application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3185#
3186# name
3187#
3188# key
3189#
3190# }
3191# }
3192# Response:
3193# {
3194#
3195# "data": {
3196#
3197# "application": {
3198#
3199# "name": "appexamplebill",
3200#
3201# "key": "appexamplebill"
3202#
3203# }
3204#
3205# }
3206# }
3207#
3208# Arguments
3209# id: The application ID
3210# excludeViewOnly: Only retrieve package grantType=VIEW when
3211# explicitly enter false
3212application(id: ID!, excludeViewOnly: Boolean): Application
3213
3214# Retrieve headerbar information for an application
3215# Example:
3216# Request:
3217# query {
3218#
3219# applicationHeaderbar(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3220#
3221# name
3222#
3223# config {
3224#
3225# title
3226#
3227# }
3228#
3229# }
3230# }
3231# Response:
3232# {
3233#
3234# "data": {
3235#
3236# "applicationHeaderbar": {
3237#
3238# "name": "APP_BAR",
3239#
3240# "config": {
3241#
3242# "title": "Library"
3243#
3244# }
3245#
3246# }
3247#
3248# }
3249# }
3250#
3251# Arguments
3252# appId: The application ID
3253# orgId: Optional organization ID. Normally this value is
3254# computed by the server
3255# based on the authorization token used for the request.
3256applicationHeaderbar(appId: ID!, orgId: ID): ApplicationHeaderbar
3257
3258# Retrieve a list of schemas for structured data ingestions\
3259# Example:
3260# Request:
3261# query {
3262#
3263# schemas(limit: 2) {
3264#
3265# records {
3266#
3267# id
3268#
3269# organizationId
3270#
3271# }
3272#
3273# }
3274# }
3275# Response:
3276# {
3277#
3278# "data": {
3279#
3280# "schemas": {
3281#
3282# "records": [
3283#
3284# {
3285#
3286# "id": "21a08123-45dc-497e-b329-360d9f3fcaac",
3287#
3288# "organizationId": "35521"
3289#
3290# },
3291#
3292# {
3293#
3294# "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112",
3295#
3296# "organizationId": "35521"
3297#
3298# }
3299#
3300# ]
3301#
3302# }
3303#
3304# }
3305# }
3306#
3307# Arguments
3308# id: Id of a schema to retrieve
3309# ids: Ids of schemas to retrieve
3310# dataRegistryId: Specify the id of the DataRegistry to get
3311# schemas
3312# status: Specify one or more statuses to filter by schema status
3313# majorVersion: Specify a major version to filter schemas
3314# name: Specify a data registry name to filter schemas
3315# nameMatch: The strategy used to find data registry name
3316# accessScope: Specify one or more access scopes to filter by
3317# accessible schemas
3318# limit: Limit
3319# offset: Offset
3320# orderBy: Specify one or more fields and direction to order
3321# results
3322schemas(
3323id: ID,
3324ids: [ID!],
3325dataRegistryId: ID,
3326status: [SchemaStatus!],
3327majorVersion: Int,
3328name: String,
3329nameMatch: StringMatch,
3330accessScope: [AccessScope!],
3331limit: Int,
3332offset: Int,
3333orderBy: [SchemaOrder]
3334): SchemaList
3335
3336# Retrieve a schema for structured data ingestions
3337# Example:
3338# Request:
3339# query {
3340#
3341# schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") {
3342#
3343# definition
3344#
3345# status
3346#
3347# }
3348# }
3349# Response:
3350# {
3351#
3352# "data": {
3353#
3354# "schema": {
3355#
3356# "definition": {
3357#
3358# "example": "example value"
3359#
3360# },
3361#
3362# "status": "draft"
3363#
3364# }
3365#
3366# }
3367# }
3368#
3369# Arguments
3370# id: Supply the ID of the schema to retrieve
3371schema(id: ID!): Schema
3372
3373# Example:
3374# Request:
3375# query {
3376#
3377# schemaProperties(limit: 2) {
3378#
3379# records {
3380#
3381# type
3382#
3383# dataRegistryId
3384#
3385# }
3386#
3387# }
3388# }
3389# Response:
3390# {
3391#
3392# "data": {
3393#
3394# "schemaProperties": {
3395#
3396# "records": [
3397#
3398# {
3399#
3400# "type": "string",
3401#
3402# "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6"
3403#
3404# },
3405#
3406# {
3407#
3408# "type": "string",
3409#
3410# "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c"
3411#
3412# }
3413#
3414# ]
3415#
3416# }
3417#
3418# }
3419# }
3420#
3421# Arguments
3422# limit: Limit
3423# offset: Offset
3424schemaProperties(
3425dataRegistryVersion: [DataRegistryVersion!],
3426search: String,
3427limit: Int,
3428offset: Int
3429): SchemaPropertyList
3430
3431# Retrieve a structured data object
3432# Example:
3433# Request:
3434# query {
3435#
3436# structuredData(
3437#
3438# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3439#
3440# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3441#
3442# data
3443#
3444# }
3445# }
3446# Response:
3447# {
3448#
3449# "data": {
3450#
3451# "structuredData": {
3452#
3453# "data": {
3454#
3455# "example": "example"
3456#
3457# }
3458#
3459# }
3460#
3461# }
3462# }
3463#
3464# Arguments
3465# id: Supply the ID of the structured data object to retrieve.
3466# This will override filters.
3467# schemaId: Schema Id for the structured data object to retrieve
3468structuredData(id: ID!, schemaId: ID!): StructuredData
3469
3470# Retrieve a structured data object
3471# Example:
3472# Request:
3473# query {
3474#
3475# structuredDataObject(
3476#
3477# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3478#
3479# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3480#
3481# data
3482#
3483# }
3484# }
3485# Response:
3486# {
3487#
3488# "data": {
3489#
3490# "structuredDataObject": {
3491#
3492# "data": {
3493#
3494# "example": "example"
3495#
3496# }
3497#
3498# }
3499#
3500# }
3501# }
3502#
3503# Arguments
3504# id: Supply the ID of the structured data object to retrieve.
3505# This will override filters.
3506# schemaId: Schema Id for the structured data object to retrieve
3507structuredDataObject(id: ID!, schemaId: ID!): StructuredData
3508
3509# Retrieve a paginated list of structured data object
3510# Example:
3511# Request:
3512# query {
3513#
3514# structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3515#
3516# records {
3517#
3518# id
3519#
3520# data
3521#
3522# }
3523#
3524# }
3525# }
3526# Response:
3527# {
3528#
3529# "data": {
3530#
3531# "structuredDataObjects": {
3532#
3533# "records": [
3534#
3535# {
3536#
3537# "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3538#
3539# "data": {
3540#
3541# "example": "example"
3542#
3543# }
3544#
3545# },
3546#
3547# {
3548#
3549# "id": "f914eafe-ed9b-46b1-a48d-effd5575764a",
3550#
3551# "data": {
3552#
3553# "example": "example"
3554#
3555# }
3556#
3557# }
3558#
3559# ]
3560#
3561# }
3562#
3563# }
3564# }
3565#
3566# Arguments
3567# id: Supply the ID of the structured data object to retrieve.
3568# This will override filters.
3569# ids: List of Ids of the structured data objects to retrieve.
3570# This will override filters.
3571# schemaId: Schema Id for the structured data object to retrieve
3572# filter: Passing id or ids argument will override the filter.
3573# Any field in the SDO's data column can be used as a filter with 'exact match'
3574# comparison.
3575# E.g.:
3576#
3577# filter: {
3578#
3579# name: "This is an example"
3580#
3581# }
3582structuredDataObjects(
3583id: ID,
3584ids: [ID!],
3585schemaId: ID!,
3586orderBy: [StructuredDataOrderBy!],
3587limit: Int,
3588offset: Int,
3589owned: Boolean,
3590filter: JSONData,
3591dateTimeFilter: SdoDateTimeFilter
3592): StructuredDataList
3593
3594# Returns information about the GraphQL server, useful
3595# for diagnostics. This data is primarily used by Veritone
3596# development, and some fields may be restricted to Veritone administrators.
3597graphqlServiceInfo: GraphQLServiceInfo
3598
3599# Returns a signed writable S3 URL. A client can then
3600# upload to this URL with an HTTP PUT without providing
3601# any additional authorization (_note_: it must be a PUT.
3602# A POST will fail.)
3603# Example:
3604# Request:
3605# query {
3606#
3607# getSignedWritableUrl(type: "preview") {
3608#
3609# bucket
3610#
3611# key
3612#
3613# url
3614#
3615# }
3616# }
3617# Response:
3618# {
3619#
3620# "data": {
3621#
3622# "getSignedWritableUrl": {
3623#
3624# "bucket": "prod-api.veritone.com",
3625#
3626# "key":
3627# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3628#
3629# "url":
3630# "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"
3631#
3632# }
3633#
3634# }
3635# }
3636#
3637# Arguments
3638# key: Optional key of the object to generate a writable
3639# URL for. If not provided, a new, unique key will
3640# be generated. If a key is provided and resembles a file name
3641# (with extension delimited by .), a UUID will be inserted
3642# into the file name, leaving the extension intact.
3643# If a key is provided and does not resemble
3644# a file name, a UUID will be appended.
3645# type: Optional type of resource, such as `asset`, `thumbnail`,
3646# `discovery-analytics` or `preview`
3647# path: Optional extended path information. If the uploaded
3648# content will be contained
3649# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3650# (for `entityIdentifier`), the ID of the object should be provided here.
3651# expiresInSeconds: Optional expiresInSeconds custom expiration
3652# to signedUrlExpires
3653# Max expiresInSeconds up to 604800
3654# organizationId: Optional organization ID. Normally this value
3655# is computed by the server
3656# based on the authorization token used for the request.
3657# Is is used only by Veritone platform components.
3658getSignedWritableUrl(
3659key: String,
3660type: String,
3661path: String,
3662expiresInSeconds: Int,
3663organizationId: ID
3664): WritableUrlInfo
3665
3666# Return writable storage URLs in bulk.
3667# A maximum of 1000 can be created in one call.
3668# See `getSignedWritableUrl` for details on usage of the
3669# response contents.
3670# Example:
3671# Request:
3672# query {
3673#
3674# getSignedWritableUrls(number: 2) {
3675#
3676# bucket
3677#
3678# key
3679#
3680# url
3681#
3682# }
3683# }
3684# Response:
3685# {
3686#
3687# "data": {
3688#
3689# "getSignedWritableUrls": [
3690#
3691# {
3692#
3693# "bucket": "prod-api.veritone.com",
3694#
3695# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3696#
3697# "url":
3698# "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"
3699#
3700# },
3701#
3702# {
3703#
3704# "bucket": "prod-api.veritone.com",
3705#
3706# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3707#
3708# "url":
3709# "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"
3710#
3711# }
3712#
3713# ]
3714#
3715# }
3716# }
3717#
3718# Arguments
3719# number: Number of signed URLs to return
3720# type: Optional type of resource, such as `asset`, `thumbnail`,
3721# or `preview`
3722# path: Optional extended path information. If the uploaded
3723# content will be contained
3724# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3725# (for `entityIdentifier`), the ID of the object should be provided here.
3726# organizationId: Optional organization ID. Normally this value
3727# is computed by the server
3728# based on the authorization token used for the request.
3729# Is is used only by Veritone platform components.
3730getSignedWritableUrls(
3731number: Int!,
3732type: String,
3733path: String,
3734organizationId: ID
3735): [WritableUrlInfo!]!
3736
3737# Return the overall status for a PUT request, reporting any failures that might
3738# have occurred.
3739# Example:
3740# Request:
3741#
3742# query {
3743#
3744# getUploadStatus(input: {
3745#
3746# key:
3747#
3748# }) {
3749#
3750# status
3751#
3752# message
3753#
3754# totalBytesReceived
3755#
3756# missingChunkNumbers
3757#
3758# failures {
3759#
3760# records {
3761#
3762# chunkNumber
3763#
3764# status
3765#
3766# message
3767#
3768# }
3769#
3770# }
3771#
3772# }
3773#
3774# }
3775# Response:
3776#
3777# {
3778#
3779# "data": {
3780#
3781# "getUploadStatus":
3782#
3783# {
3784#
3785# "status": "processing",
3786#
3787# "message": "test message",
3788#
3789# "totalBytesReceived": 124000000
3790#
3791# "missingChunkNumbers": 2
3792#
3793# "faiulures": [
3794#
3795# {
3796#
3797# "chunkNumber": 4
3798#
3799# "status": "failed"
3800#
3801# "message": "error message"
3802#
3803# }
3804#
3805# ]
3806#
3807# }
3808#
3809# }
3810#
3811# }
3812#
3813# Arguments
3814# input: UploadStatus input
3815getUploadStatus(input: UploadStatusInput!): UploadStatus!
3816
3817# Retrieve the rights of the current user
3818# Example:
3819# Request:
3820# query {
3821#
3822# myRights {
3823#
3824# resources
3825#
3826# operations
3827#
3828# }
3829# }
3830# Response:
3831# {
3832#
3833# "data": {
3834#
3835# "myRights": {
3836#
3837# "resources": {},
3838#
3839# "operations": [
3840#
3841# "admin.access",
3842#
3843# "admin.org.read",
3844#
3845# "admin.org.update",
3846#
3847# "admin.user.create",
3848#
3849# "admin.user.read",
3850#
3851# "admin.user.update",
3852#
3853# "admin.user.delete",
3854#
3855# ...
3856#
3857# ]
3858#
3859# }
3860#
3861# }
3862# }
3863myRights: RightsListing
3864
3865# Retrieve the shared folders for an organization
3866# Example:
3867# Request:
3868# query {
3869#
3870# sharedFolders {
3871#
3872# id
3873#
3874# }
3875# }
3876# Response:
3877# {
3878#
3879# "data": {
3880#
3881# "sharedFolders": []
3882#
3883# }
3884# }
3885sharedFolders: [Folder]
3886
3887# Retrieve multiple watchlists
3888# Example:
3889# Request:
3890# query {
3891#
3892# watchlists(limit: 2) {
3893#
3894# records {
3895#
3896# id
3897#
3898# name
3899#
3900# }
3901#
3902# }
3903# }
3904# Response:
3905# {
3906#
3907# "data": {
3908#
3909# "watchlists": {
3910#
3911# "records": [
3912#
3913# {
3914#
3915# "id": "326916",
3916#
3917# "name": "example"
3918#
3919# },
3920#
3921# {
3922#
3923# "id": "325791",
3924#
3925# "name": "example"
3926#
3927# }
3928#
3929# ]
3930#
3931# }
3932#
3933# }
3934# }
3935#
3936# Arguments
3937# isDisabled: Set `true` to include only disabled watchlist or
3938# `false` to include only enabled watchlists. By default,
3939# both are included.
3940# names: Provide a list of names to filter folders
3941watchlists(
3942id: ID,
3943maxStopDateTime: DateTime,
3944minStopDateTime: DateTime,
3945minStartDateTime: DateTime,
3946maxStartDateTime: DateTime,
3947name: String,
3948offset: Int,
3949limit: Int,
3950orderBy: WatchlistOrderBy,
3951orderDirection: OrderDirection,
3952isDisabled: Boolean,
3953names: [String],
3954nameMatch: StringMatch
3955): WatchlistList
3956
3957# Retrieve a single watchlist by id
3958# Example:
3959# Request:
3960# query {
3961#
3962# watchlist(id: "325791") {
3963#
3964# name
3965#
3966# watchlistType
3967#
3968# }
3969# }
3970# Response:
3971# {
3972#
3973# "data": {
3974#
3975# "watchlist": {
3976#
3977# "name": "example",
3978#
3979# "watchlistType": "tracking"
3980#
3981# }
3982#
3983# }
3984# }
3985watchlist(id: ID!): Watchlist
3986
3987# Example:
3988# Request:
3989# query {
3990#
3991# mentionStatusOptions {
3992#
3993# id
3994#
3995# name
3996#
3997# }
3998# }
3999# Response:
4000# {
4001#
4002# "data": {
4003#
4004# "mentionStatusOptions": [
4005#
4006# {
4007#
4008# "id": "7",
4009#
4010# "name": "Auto Verified"
4011#
4012# },
4013#
4014# {
4015#
4016# "id": "5",
4017#
4018# "name": "Invalid"
4019#
4020# },
4021#
4022# {
4023#
4024# "id": "3",
4025#
4026# "name": "Needs Review"
4027#
4028# },
4029#
4030# {
4031#
4032# "id": "1",
4033#
4034# "name": "Pending Verification"
4035#
4036# },
4037#
4038# {
4039#
4040# "id": "6",
4041#
4042# "name": "Processing Verification"
4043#
4044# },
4045#
4046# {
4047#
4048# "id": "4",
4049#
4050# "name": "Request Bonus"
4051#
4052# },
4053#
4054# {
4055#
4056# "id": "2",
4057#
4058# "name": "Verified"
4059#
4060# }
4061#
4062# ]
4063#
4064# }
4065# }
4066mentionStatusOptions: [MentionStatus!]!
4067
4068# Retrieve multiple data registries
4069# Example:
4070# Request:
4071# query {
4072#
4073# dataRegistries(limit: 2) {
4074#
4075# records {
4076#
4077# id
4078#
4079# name
4080#
4081# }
4082#
4083# }
4084# }
4085# Response:
4086# {
4087#
4088# "data": {
4089#
4090# "dataRegistries": {
4091#
4092# "records": [
4093#
4094# {
4095#
4096# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
4097#
4098# "name": "example"
4099#
4100# },
4101#
4102# {
4103#
4104# "id": "317c941d-30d0-455e-882b-34a26e513364",
4105#
4106# "name": "example"
4107#
4108# }
4109#
4110# ]
4111#
4112# }
4113#
4114# }
4115# }
4116dataRegistries(
4117id: ID,
4118ids: [ID!],
4119name: String,
4120nameMatch: StringMatch,
4121offset: Int,
4122limit: Int,
4123orderBy: DataRegistryOrderBy,
4124orderDirection: OrderDirection,
4125filterByOwnership: SchemaOwnership
4126): DataRegistryList
4127
4128# Retrieve a single data registry
4129# Example:
4130# Request:
4131# query {
4132#
4133# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
4134#
4135# name
4136#
4137# organizationId
4138#
4139# source
4140#
4141# }
4142# }
4143# Response:
4144# {
4145#
4146# "data": {
4147#
4148# "dataRegistry": {
4149#
4150# "name": "example",
4151#
4152# "organizationId": "35521",
4153#
4154# "source": "veritone-35521.datasets"
4155#
4156# }
4157#
4158# }
4159# }
4160dataRegistry(id: ID!): DataRegistry
4161
4162# Retrieve a subscription by id
4163# Example:
4164# Request:
4165# query {
4166#
4167# subscription(id: "275818") {
4168#
4169# isActive
4170#
4171# jsondata
4172#
4173# }
4174# }
4175# Response:
4176# {
4177#
4178# "data": {
4179#
4180# "subscription": {
4181#
4182# "isActive": true,
4183#
4184# "jsondata": {
4185#
4186# "tracking_unit_id": "325791",
4187#
4188# "creator_email": "example email",
4189#
4190# "unsubscribe_hash":
4191# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
4192#
4193# }
4194#
4195# }
4196#
4197# }
4198# }
4199subscription(id: ID!): Subscription!
4200
4201cognitiveSearch(id: ID!): CognitiveSearch!
4202
4203# Retrieve multiple collections
4204# Example:
4205# Request:
4206# query {
4207#
4208# collections {
4209#
4210# records {
4211#
4212# id
4213#
4214# name
4215#
4216# }
4217#
4218# }
4219# }
4220# Response:
4221# {
4222#
4223# "data": {
4224#
4225# "collections": {
4226#
4227# "records": [
4228#
4229# {
4230#
4231# "id": "241121",
4232#
4233# "name": "example"
4234#
4235# },
4236#
4237# {
4238#
4239# "id": "242599",
4240#
4241# "name": "example"
4242#
4243# },
4244#
4245# {
4246#
4247# "id": "243625",
4248#
4249# "name": "example"
4250#
4251# }
4252#
4253# ]
4254#
4255# }
4256#
4257# }
4258# }
4259collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
4260
4261# Retrieve a collection by id
4262# Example:
4263# Request:
4264# query {
4265#
4266# collection(id: "241121") {
4267#
4268# name
4269#
4270# isActive
4271#
4272# }
4273# }
4274# Response:
4275# {
4276#
4277# "data": {
4278#
4279# "collection": {
4280#
4281# "name": "example",
4282#
4283# "isActive": true
4284#
4285# }
4286#
4287# }
4288# }
4289collection(id: ID!): Collection!
4290
4291collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
4292
4293# Retrieve a list of collection mentions
4294# Specify at least one of folderId or mentionId
4295collectionMentions(
4296folderId: ID,
4297mentionId: ID,
4298orderBy: CollectionMentionOrderBy,
4299limit: Int,
4300offset: Int
4301): CollectionMentionList!
4302
4303# Retrieve multiple mentions
4304# Example:
4305# Request:
4306# query {
4307#
4308# mentions {
4309#
4310# records {
4311#
4312# id
4313#
4314# }
4315#
4316# }
4317# }
4318# Response:
4319# {
4320#
4321# "data": {
4322#
4323# "mentions": {
4324#
4325# "records": []
4326#
4327# }
4328#
4329# }
4330# }
4331#
4332# Arguments
4333# watchlistId: Get mentions created from the specified watchlist
4334# sourceId: Get mentions associated with the specified source
4335# sourceTypeId: Get mentions associated with sources of the
4336# specified source type
4337# tdoId: Get mentions associated directly with the specific TDO
4338# dateTimeFilter: Specify date/time filters against mention
4339# fields.
4340# Querying for mentions can be expensive. If the query does not
4341# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
4342# a user-provided `dateTimeFilter`, a default filter of the
4343# past 7 days is applied.
4344# orderBy: Set order information on the query. Multiple fields
4345# are supported.
4346# folderId: Provide a folder ID to filter by collection
4347mentions(
4348id: ID,
4349watchlistId: ID,
4350sourceId: ID,
4351sourceTypeId: ID,
4352tdoId: ID,
4353dateTimeFilter: [MentionDateTimeFilter!],
4354orderBy: [MentionOrderBy!],
4355offset: Int,
4356limit: Int,
4357folderId: ID
4358): MentionList
4359
4360# Retrieves engine results by TDO and engine ID or by job ID.
4361# Example:
4362# Request:
4363# query {
4364#
4365# engineResults(
4366#
4367# tdoId: "1580507556",
4368#
4369# engineIds: "4") {
4370#
4371# sourceId
4372#
4373# records {
4374#
4375# tdoId
4376#
4377# }
4378#
4379# }
4380# }
4381# Response:
4382# {
4383#
4384# "data": {
4385#
4386# "engineResults": {
4387#
4388# "sourceId": null,
4389#
4390# "records": []
4391#
4392# }
4393#
4394# }
4395# }
4396#
4397# Arguments
4398# tdoId: Provide the ID of the TDO containing engine results to
4399# retrieve.
4400# If this parameter is used, engineIds or engineCategoryIds must also be set.
4401# Results for _only_ the specified TDO will be returned.
4402# sourceId: Provide the ID of the Source containing engine
4403# results to retrieve.
4404# If this parameter is used, engineIds or engineCategoryIds must also be set.
4405# This takes priority over tdoId.
4406# engineIds: Provide one or more engine IDs to retrieve engine
4407# results by
4408# ID. This parameter is mandatory if tdoId is used, but optional
4409# if jobId or engineCategory is used.
4410# engineCategoryIds: Provide one or more category IDs to get all
4411# results from that categroy.
4412# jobId: Provide a job ID to retrieve engine results for the job.
4413# mentionId: Provide a mention ID to retrieve engine results for
4414# the mention.
4415# startOffsetMs: Start offset ms for the results.
4416# stopOffsetMs: End offset ms for the results.
4417# startDate: Start date for the results. Takes priority over
4418# startOffsetMs.
4419# stopDate: End date for the results. Takes priority over
4420# stopOffsetMs.
4421# ignoreUserEdited: Whether or not to exclude user edited engine
4422# results. Defaults to false.
4423# fallbackTdoId: A TDO ID can be provided for use if the provided
4424# `sourceId` and/or
4425# `mentionId` parameters do not resolve to a logical set of TDOs.
4426# Depending on parameter settings and available data,
4427# results from other TDOs can be included in the response.
4428engineResults(
4429tdoId: ID,
4430sourceId: ID,
4431engineIds: [ID!],
4432engineCategoryIds: [ID!],
4433jobId: ID,
4434mentionId: ID,
4435startOffsetMs: Int,
4436stopOffsetMs: Int,
4437startDate: DateTime,
4438stopDate: DateTime,
4439ignoreUserEdited: Boolean,
4440fallbackTdoId: ID
4441): EngineResultList
4442
4443# Retrieve a trigger by id
4444# Example:
4445# Request:
4446# query {
4447#
4448# trigger(id: "2998") {
4449#
4450# target
4451#
4452# createdDateTime
4453#
4454# }
4455# }
4456# Response:
4457# {
4458#
4459# "data": {
4460#
4461# "trigger": {
4462#
4463# "target": "Email",
4464#
4465# "createdDateTime": "2021-06-18T13:35:08.631Z"
4466#
4467# }
4468#
4469# }
4470# }
4471trigger(id: ID!): Trigger
4472
4473# Retrieve triggers
4474# Example:
4475# Request:
4476# query {
4477#
4478# triggers {
4479#
4480# id
4481#
4482# }
4483# }
4484# Response:
4485# {
4486#
4487# "data": {
4488#
4489# "triggers": [
4490#
4491# {
4492#
4493# "id": "2998"
4494#
4495# }
4496#
4497# ]
4498#
4499# }
4500# }
4501triggers: [Trigger]
4502
4503# Fetch all saved searches that the current user has made
4504# Fetch all saved searches that have been shared with
4505# the current users organization
4506# Include any saved searches that the user has created
4507# Example:
4508# Request:
4509# query {
4510#
4511# savedSearches {
4512#
4513# records {
4514#
4515# id
4516#
4517# name
4518#
4519# }
4520#
4521# }
4522# }
4523# Response:
4524# {
4525#
4526# "data": {
4527#
4528# "savedSearches": {
4529#
4530# "records": [
4531#
4532# {
4533#
4534# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
4535#
4536# "name": "example"
4537#
4538# }
4539#
4540# ]
4541#
4542# }
4543#
4544# }
4545# }
4546savedSearches(
4547offset: Int,
4548limit: Int,
4549includeShared: Boolean,
4550filterByName: String,
4551orderBy: SavedSearchOrderBy,
4552orderDirection: OrderDirection
4553): SavedSearchList!
4554
4555# Retrieve a list of export requests
4556# Example:
4557# Request:
4558# query {
4559#
4560# exportRequests(limit: 2) {
4561#
4562# records {
4563#
4564# id
4565#
4566# organizationId
4567#
4568# }
4569#
4570# }
4571# }
4572# Response:
4573# {
4574#
4575# "data": {
4576#
4577# "exportRequests": {
4578#
4579# "records": [
4580#
4581# {
4582#
4583# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4584#
4585# "organizationId": "35521"
4586#
4587# }
4588#
4589# ]
4590#
4591# }
4592#
4593# }
4594# }
4595#
4596# Arguments
4597# id: Provide an ID to retrieve a single export request
4598# offset: Provide an offset to skip to a certain element in the
4599# result, for paging.
4600# limit: Specify maximum number of results to retrieve in this
4601# result. Page size.
4602# status: Provide a list of status options to filter by status
4603# event: Provide an event to retrieve export request. Should be
4604# 'exportRequest' or 'mentionExportRequest'
4605# Default value is 'exportRequest'
4606exportRequests(
4607id: ID,
4608offset: Int,
4609limit: Int,
4610status: [ExportRequestStatus!],
4611event: ExportRequestEvent
4612): ExportRequestList!
4613
4614# Retrieve a single export request by id
4615# Example:
4616# Request:
4617# query {
4618#
4619# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
4620#
4621# id
4622#
4623# organizationId
4624#
4625# requestorId
4626#
4627# status
4628#
4629# }
4630# }
4631# Response:
4632# {
4633#
4634# "data": {
4635#
4636# "exportRequest": {
4637#
4638# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4639#
4640# "organizationId": "35521",
4641#
4642# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4643#
4644# "status": "complete"
4645#
4646# }
4647#
4648# }
4649# }
4650#
4651# Arguments
4652# event: Provide an event to retrieve export request. Should be
4653# 'exportRequest' or 'mentionExportRequest'
4654# Default value is 'exportRequest'
4655exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4656
4657# Retrieve a event by id
4658# Example:
4659# Request:
4660# query {
4661#
4662# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4663#
4664# eventName
4665#
4666# eventType
4667#
4668# description
4669#
4670# }
4671# }
4672# Response:
4673# {
4674#
4675# "data": {
4676#
4677# "event": {
4678#
4679# "eventName": "example",
4680#
4681# "eventType": "example",
4682#
4683# "description": "new example description"
4684#
4685# }
4686#
4687# }
4688# }
4689event(id: ID!): Event
4690
4691# Retrieve a list of events by application
4692# Example:
4693# Request:
4694# query {
4695#
4696# events(
4697#
4698# application: "system",
4699#
4700# limit: 2) {
4701#
4702# records {
4703#
4704# id
4705#
4706# eventName
4707#
4708# }
4709#
4710# }
4711# }
4712# Response:
4713# {
4714#
4715# "data": {
4716#
4717# "events": {
4718#
4719# "records": [
4720#
4721# {
4722#
4723# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4724#
4725# "eventName": "ActionTokenForbidden"
4726#
4727# },
4728#
4729# {
4730#
4731# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4732#
4733# "eventName": "ActionUserForbidden"
4734#
4735# }
4736#
4737# ]
4738#
4739# }
4740#
4741# }
4742# }
4743#
4744# Arguments
4745# application: Provide an application to retrieve all its events.
4746# Use 'system' to list all public system events.
4747# offset: Provide an offset to skip to a certain element in the
4748# result, for paging.
4749# limit: Specify maximum number of results to retrieve in this
4750# result. Page size.
4751events(application: String!, offset: Int, limit: Int): EventList!
4752
4753# Retrieve a list of subscriptions by organization
4754# Example:
4755# Request:
4756# query {
4757#
4758# eventSubscriptions(limit: 2) {
4759#
4760# records {
4761#
4762# id
4763#
4764# eventName
4765#
4766# }
4767#
4768# }
4769# }
4770# Response:
4771# {
4772#
4773# "data": {
4774#
4775# "eventSubscriptions": {
4776#
4777# "records": [
4778#
4779# {
4780#
4781# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4782#
4783# "eventName": "LibraryTrain"
4784#
4785# },
4786#
4787# {
4788#
4789# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4790#
4791# "eventName": "LibraryTrain"
4792#
4793# }
4794#
4795# ]
4796#
4797# }
4798#
4799# }
4800# }
4801#
4802# Arguments
4803# ids: The event subscription ids
4804# eventName: The name of the event
4805# eventType: The type of event, such as `mention`, `job`,
4806# `engine`.
4807# offset: Provide an offset to skip to a certain element in the
4808# result, for paging.
4809# limit: Specify maximum number of results to retrieve in this
4810# result. Page size.
4811# orgId: The organization ID with which these event subscriptions
4812# are associated.
4813# appId: The application ID with which these event subscriptions
4814# are associated.
4815# scope: Event subscription scope
4816eventSubscriptions(
4817ids: [ID!],
4818eventName: String,
4819eventType: String,
4820offset: Int,
4821limit: Int,
4822orgId: ID,
4823appId: ID,
4824scope: EventSubscriptionScope
4825): EventSubscriptionList!
4826
4827# Retrieve a subscription by id
4828# Example:
4829# Request:
4830# query {
4831#
4832# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4833#
4834# id
4835#
4836# organizationId
4837#
4838# eventName
4839#
4840# targetName
4841#
4842# }
4843# }
4844# Response:
4845# {
4846#
4847# "data": {
4848#
4849# "eventSubscription": {
4850#
4851# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4852#
4853# "organizationId": "35521",
4854#
4855# "eventName": "LibraryTrain",
4856#
4857# "targetName": "NotificationMailbox"
4858#
4859# }
4860#
4861# }
4862# }
4863eventSubscription(id: ID!): EventSubscription!
4864
4865# Example:
4866# Request:
4867# query {
4868#
4869# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4870#
4871# organizationId
4872#
4873# actionType
4874#
4875# name
4876#
4877# }
4878# }
4879# Response:
4880# {
4881#
4882# "data": {
4883#
4884# "eventActionTemplate": {
4885#
4886# "organizationId": "35521",
4887#
4888# "actionType": "job",
4889#
4890# "name": "example"
4891#
4892# }
4893#
4894# }
4895# }
4896eventActionTemplate(id: ID!): EventActionTemplate
4897
4898# Example:
4899# Request:
4900# query {
4901#
4902# eventActionTemplates(
4903#
4904# inputType: event,
4905#
4906# actionType: job
4907#
4908# limit:2) {
4909#
4910# records {
4911#
4912# id
4913#
4914# name
4915#
4916# }
4917#
4918# }
4919# }
4920# Response:
4921# {
4922#
4923# "data": {
4924#
4925# "eventActionTemplates": {
4926#
4927# "records": [
4928#
4929# {
4930#
4931# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4932#
4933# "name": "example"
4934#
4935# },
4936#
4937# {
4938#
4939# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4940#
4941# "name": "example"
4942#
4943# }
4944#
4945# ]
4946#
4947# }
4948#
4949# }
4950# }
4951#
4952# Arguments
4953# ownerApplicationId: The application id
4954# inputType: use "event" for now. In the future, we allow
4955# additional input_type types. For example, a schedule or a tweet.
4956# actionType: Either "job", "webhook", "sms", "email". Future
4957# action_type could be "gql" where action is purely a function call.
4958# offset: Provide an offset to skip to a certain element in the
4959# result, for paging.
4960# limit: Specify maximum number of results to retrieve in this
4961# result. Page size.
4962eventActionTemplates(
4963ownerApplicationId: ID,
4964inputType: EventActionTemplateInputType,
4965actionType: EventActionTemplateActionType,
4966offset: Int,
4967limit: Int
4968): EventActionTemplateList!
4969
4970# Example:
4971# Request:
4972# query {
4973#
4974# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4975#
4976# name
4977#
4978# eventName
4979#
4980# description
4981#
4982# }
4983# }
4984# Response:
4985# {
4986#
4987# "data": {
4988#
4989# "eventCustomRule": {
4990#
4991# "name": "example",
4992#
4993# "eventName": "example",
4994#
4995# "description": "example description"
4996#
4997# }
4998#
4999# }
5000# }
5001eventCustomRule(id: ID!): EventCustomRule
5002
5003# Example:
5004# Request:
5005# query {
5006#
5007# eventCustomRules(limit: 2) {
5008#
5009# records {
5010#
5011# id
5012#
5013# name
5014#
5015# }
5016#
5017# }
5018# }
5019# Response:
5020# {
5021#
5022# "data": {
5023#
5024# "eventCustomRules": {
5025#
5026# "records": [
5027#
5028# {
5029#
5030# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
5031#
5032# "name": "example"
5033#
5034# }
5035#
5036# ]
5037#
5038# }
5039#
5040# }
5041# }
5042#
5043# Arguments
5044# offset: the offset to skip to a certain element in the result
5045# limit: the maximum number of rows in the results
5046eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
5047
5048# This query returns information about time zones recognized by this
5049#
5050# server. The information is static and does not change.
5051#
5052# Example:
5053#
5054# Request:
5055#
5056# query {
5057#
5058# timeZones {
5059#
5060# name
5061#
5062# abbreviations{
5063#
5064# name
5065#
5066# }
5067#
5068# }
5069# }
5070# Response:
5071# {
5072#
5073# "data": {
5074#
5075# "timeZones": [
5076#
5077# {
5078#
5079# "name": "Africa/Abidjan",
5080#
5081# "abbreviations": [
5082#
5083# {
5084#
5085# "name": "GMT"
5086#
5087# }
5088#
5089# ]
5090#
5091# },
5092#
5093# {
5094#
5095# "name": "Africa/Accra",
5096#
5097# "abbreviations": [
5098#
5099# {
5100#
5101# "name": "GMT"
5102#
5103# },
5104#
5105# {
5106#
5107# "name": "+0020"
5108#
5109# }
5110#
5111# ]
5112#
5113# },
5114#
5115# {
5116#
5117# "name": "Africa/Lagos",
5118#
5119# "abbreviations": [
5120#
5121# {
5122#
5123# "name": "WAT"
5124#
5125# }
5126#
5127# ]
5128#
5129# },
5130#
5131# ...
5132#
5133# ...
5134#
5135# ]
5136#
5137# }
5138#
5139# ]
5140#
5141# }
5142# }
5143timeZones: [TimeZone!]!
5144
5145# Examine entries from the audit log. All operations that modify data are
5146# written to the audit log. Only entries for the user's own organization
5147# can be queried.
5148# All queries are bracketed by a time window. A default time window is applied
5149# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
5150# The maximum time window length is 30 days.
5151# Only Veritone and organization administrators can use this query.
5152# Example:
5153# Request:
5154# query {
5155#
5156# auditLog(limit: 2) {
5157#
5158# records {
5159#
5160# id
5161#
5162# objectId
5163#
5164# description
5165#
5166# }
5167#
5168# }
5169# }
5170# Response:
5171# {
5172#
5173# "data": {
5174#
5175# "auditLog": {
5176#
5177# "records": [
5178#
5179# {
5180#
5181# "id": "735915311",
5182#
5183# "objectId": "*********",
5184#
5185# "description": "Changed password"
5186#
5187# },
5188#
5189# {
5190#
5191# "id": "735915307",
5192#
5193# "objectId": "********",
5194#
5195# "description": "Changed password"
5196#
5197# }
5198#
5199# ]
5200#
5201# }
5202#
5203# }
5204# }
5205#
5206# Arguments
5207# toDateTime: Date/time up to which entries will be returned. In
5208# other words, the
5209# end of the query time window.
5210# Defaults to the current time.
5211# fromDateTime: Date/time from which entries will be returned. In
5212# other words, the
5213# start of the query time window.
5214# Defaults to the `toDateTime` minus 7 days.
5215# organizationId: Organization ID to query records for. This
5216# value can only be used by
5217# Veritone administrators. Any value provided by user administrators will
5218# be ignored.
5219# userName: User name on audit entry. Must be exact match.
5220# clientIpAddress: IP address of the client that generated the
5221# audit action. Must be exact match.
5222# clientUserAgent: HTTP user agent of the client that generated
5223# the audit action. Must be exact match.
5224# eventType: The event type, such as `Create`, `Update`, or
5225# `Delete`.
5226# Must be exact match.
5227# objectId: The ID of the object involved in the audit action.
5228# The format of this ID
5229# varies by object type. Must be exact match.
5230# objectType: The type of the object involved in the audit
5231# action, such as `Watchlist`
5232# or `TemporalDataObject`. Must be exact match.
5233# success: Whether or not the action was successful.
5234# id: The unique ID of an audit log entry. Multiple values can be
5235# provided.
5236# offset: Offset into result set, for paging.
5237# limit: Limit on result size, for paging (page size). Audit
5238# queries are
5239# lightweight so the default of 100 is higher than the default offset
5240# used elsewhere in the API.
5241# orderBy: Order information. Default is order by
5242# `createdDateTime` descending.
5243auditLog(
5244toDateTime: DateTime,
5245fromDateTime: DateTime,
5246organizationId: ID,
5247userName: String,
5248clientIpAddress: String,
5249clientUserAgent: String,
5250eventType: String,
5251objectId: ID,
5252objectType: String,
5253success: Boolean,
5254id: [ID!],
5255offset: Int,
5256limit: Int,
5257orderBy: [AuditLogOrderBy!]
5258): AuditLogEntryList! @deprecated( reason: "No longer supported." )
5259
5260# Get the media share by media shareId
5261mediaShare(id: ID!): MediaShare!
5262
5263# Retrieve a shared collection
5264#
5265# Arguments
5266# shareId: share token
5267sharedCollection(shareId: ID!): SharedCollection
5268
5269# Retrieve shared collection history records
5270# Example:
5271# Request:
5272# query {
5273#
5274# sharedCollectionHistory(limit: 2,
5275#
5276# folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") {
5277#
5278# records {
5279#
5280# id
5281#
5282# status
5283#
5284# shareId
5285#
5286# }
5287#
5288# }
5289# }
5290# Response:
5291# {
5292#
5293# "data": {
5294#
5295# "sharedCollectionHistory": {
5296#
5297# "records": []
5298#
5299# }
5300#
5301# }
5302# }
5303#
5304# Arguments
5305# ids: Provide an ID to retrieve a single history record
5306# folderId: Provide a folder ID to filter by collection
5307# shareId: Provide a share ID to filter by share ID
5308# offset: Specify maximum number of results to retrieve in this
5309# result. Page size.
5310# limit: Specify maximum number of results to retrieve in this
5311# result.
5312sharedCollectionHistory(
5313ids: [ID!],
5314folderId: ID,
5315shareId: String,
5316offset: Int,
5317limit: Int
5318): SharedCollectionHistoryList!
5319
5320# Get list process templates by id or current organizationId
5321# Example:
5322# Request:
5323# query {
5324#
5325# processTemplates(limit: 2) {
5326#
5327# records {
5328#
5329# id
5330#
5331# organizationId
5332#
5333# name
5334#
5335# }
5336#
5337# }
5338# }
5339# Response:
5340# {
5341#
5342# "data": {
5343#
5344# "processTemplates": {
5345#
5346# "records": [
5347#
5348# {
5349#
5350# "id": "762",
5351#
5352# "organizationId": "35521",
5353#
5354# "name": "example"
5355#
5356# }
5357#
5358# ]
5359#
5360# }
5361#
5362# }
5363# }
5364processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
5365
5366# Get process templates by id
5367# Example:
5368# Request:
5369# query {
5370#
5371# processTemplate(id: "762") {
5372#
5373# name
5374#
5375# organizationId
5376#
5377# }
5378# }
5379# Response:
5380# {
5381#
5382# "data": {
5383#
5384# "processTemplate": {
5385#
5386# "name": "example",
5387#
5388# "organizationId": "35521"
5389#
5390# }
5391#
5392# }
5393# }
5394processTemplate(id: ID!): ProcessTemplate!
5395
5396# Get creative by id with current organizationId
5397# Example:
5398# Request:
5399# query {
5400#
5401# creative(id: "25209") {
5402#
5403# organizationId
5404#
5405# brandId
5406#
5407# }
5408# }
5409# Response:
5410# {
5411#
5412# "data": {
5413#
5414# "creative": {
5415#
5416# "organizationId": "35521",
5417#
5418# "brandId": null
5419#
5420# }
5421#
5422# }
5423# }
5424creative(id: ID!): Creative!
5425
5426# Retrieve list of engine classes
5427# Example:
5428# Request:
5429# query {
5430#
5431# engineClasses(limit: 2) {
5432#
5433# records {
5434#
5435# id
5436#
5437# name
5438#
5439# description
5440#
5441# }
5442#
5443# }
5444# }
5445# Response:
5446# {
5447#
5448# "data": {
5449#
5450# "engineClasses": {
5451#
5452# "records": [
5453#
5454# {
5455#
5456# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5457#
5458# "name": "audio",
5459#
5460# "description": "The input to engines in the Audio class is an audio or video
5461# file or stream. If your engine processes human speech or voice, it likely
5462# belongs in the Speech class instead. Audio engines may recognize a specific
5463# audio segment, such as an advertisement, identify sounds like that of a crying
5464# baby or detect the presence of audio or music in an audio or video file, for
5465# example."
5466#
5467# },
5468#
5469# {
5470#
5471# "id": "1bcfdd35-1e9b-4694-8273-00b19510d164",
5472#
5473# "name": "biometrics",
5474#
5475# "description": "The input to engines in the Biometrics class may be an image,
5476# speech or other audio or video file or stream. By definition, the Biometrics
5477# class covers cognitive analysis related to data points from the human body.
5478# Biometrics engines may detect or recognize faces, identify face attributes to
5479# estimate a person's age or ethnicity or verify a person based on their unique
5480# iris, for example."
5481#
5482# }
5483#
5484# ]
5485#
5486# }
5487#
5488# }
5489# }
5490#
5491# Arguments
5492# id: Provide an ID to retrieve a single specific engine class.
5493# name: Provide a name, or part of one, to search by class name
5494# offset: Specify maximum number of results to retrieve in this
5495# result. Page size.
5496# limit: Specify maximum number of results to retrieve in this
5497# result.
5498engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
5499
5500# Retrieve a specific engine class
5501# Example:
5502# Request:
5503# query {
5504#
5505# engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") {
5506#
5507# id
5508#
5509# name
5510#
5511# description
5512#
5513# }
5514# }
5515# Response:
5516# {
5517#
5518# "data": {
5519#
5520# "engineClass": {
5521#
5522# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5523#
5524# "name": "audio",
5525#
5526# "description": "The input to engines in the Audio class is an audio or video
5527# file or stream. If your engine processes human speech or voice, it likely
5528# belongs in the Speech class instead. Audio engines may recognize a specific
5529# audio segment, such as an advertisement, identify sounds like that of a crying
5530# baby or detect the presence of audio or music in an audio or video file, for
5531# example."
5532#
5533# }
5534#
5535# }
5536# }
5537#
5538# Arguments
5539# id: Supply the ID of the engine class to retrieve
5540engineClass(id: ID!): EngineClass
5541
5542# Retrieve list entity tags where tag key contains user input
5543# Example:
5544# Request:
5545# query {
5546#
5547# matchEntityTags(input: { tagKey: "test}) {
5548#
5549# records {
5550#
5551# tagKey
5552#
5553# tagValue
5554#
5555# }
5556#
5557# }
5558# }
5559# Response:
5560# {
5561#
5562# "data": {
5563#
5564# "matchEntityTags": {
5565#
5566# "records": [
5567#
5568# {
5569#
5570# "tagKey": "test-tag",
5571#
5572# "tagValue": "test-value"
5573#
5574# },
5575#
5576# {
5577#
5578# "tagKey": "another-testtag",
5579#
5580# "tagValue": ""
5581#
5582# },
5583#
5584# ]
5585#
5586# }
5587#
5588# }
5589# }
5590#
5591# Arguments
5592# input: User provided text and entity type input.
5593# offset: Specify maximum number of results to retrieve in this
5594# result. Page size.
5595# limit: Specify maximum number of results to retrieve in this
5596# result.
5597matchEntityTags(input: MatchEntityTagInput!, offset: Int, limit: Int): MatchedEntityTagsList
5598
5599# Returns all custom dashboards created by user
5600# Example:
5601# Request:
5602# query {
5603#
5604# customDashboards {
5605#
5606# records {
5607#
5608# id
5609#
5610# description
5611#
5612# hostAppId
5613#
5614# }
5615#
5616# }
5617# }
5618# Response:
5619# {
5620#
5621# "data": {
5622#
5623# "customDashboards": {
5624#
5625# "records": [
5626#
5627# {
5628#
5629# "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9",
5630#
5631# "description": "example",
5632#
5633# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f"
5634#
5635# }
5636#
5637# ]
5638#
5639# }
5640#
5641# }
5642# }
5643#
5644# Arguments
5645# offset: Provide an offset to skip to a certain element in the
5646# result, for paging.
5647# limit: Specify maximum number of results to retrieve in this
5648# result. Page size.
5649# hostAppId: Include only dashboards created by specific
5650# host_app_id
5651customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
5652
5653# Returns custom dashboard by id
5654# Example:
5655# Request:
5656# query {
5657#
5658# customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") {
5659#
5660# hostAppId
5661#
5662# name
5663#
5664# }
5665# }
5666# Response:
5667# {
5668#
5669# "data": {
5670#
5671# "customDashboard": {
5672#
5673# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f",
5674#
5675# "name": "example"
5676#
5677# }
5678#
5679# }
5680# }
5681customDashboard(id: ID!): CustomDashboard
5682
5683# Gets engine usage for an organization based on their billing type.
5684# Example:
5685# Request:
5686# query {
5687#
5688# getUsageByTaskType {
5689#
5690# totalDuration
5691#
5692# totalCost
5693#
5694# }
5695# }
5696# Response:
5697# {
5698#
5699# "data": {
5700#
5701# "getUsageByTaskType": {
5702#
5703# "totalDuration": 0,
5704#
5705# "totalCost": "0"
5706#
5707# }
5708#
5709# }
5710# }
5711getUsageByTaskType: UsageByTaskType!
5712
5713# Retrives the specific Dataset
5714#
5715# Arguments
5716# id: Supply the ID of the Dataset to retrieve
5717dataset(id: ID!): Dataset
5718
5719# Retrieve list of Datasets
5720# Example:
5721# Request:
5722# query {
5723#
5724# datasets(limit:2, filter: {operation:OR}) {
5725#
5726# records {
5727#
5728# datasetId
5729#
5730# name
5731#
5732# }
5733#
5734# }
5735# }
5736# Response:
5737# {
5738#
5739# "data": {
5740#
5741# "datasets": {
5742#
5743# "records": []
5744#
5745# }
5746#
5747# }
5748# }
5749#
5750# Arguments
5751# offset: Provide an offset to skip to a certain element in the
5752# result, for paging.
5753# limit: Specify maximum number of results to retrieve in this
5754# result. Page size.
5755# filter: Filters for Dataset attributes
5756datasets(offset: Int, limit: Int, filter: DatasetFilter): DatasetList
5757
5758# Arguments
5759# datasetId: Supply the ID of the Dataset to retrieve
5760# offset: Provide an offset to skip to a certain element in the
5761# result, for paging.
5762# limit: Specify maximum number of results to retrieve in this
5763# result. Page size.
5764# filter: Query to filter SDO. Supports operations such as and,
5765# or, eq, gt, lt, etc.
5766# TODO link to syntax documentation
5767# orderBy: Order by
5768datasetDataQuery(
5769datasetId: ID!,
5770offset: Int,
5771limit: Int,
5772filter: JSONData,
5773orderBy: [StructuredDataOrderBy!]
5774): DatasetEntryList!
5775
5776# Retrive list of Engine Replacement
5777# Example:
5778# Request:
5779# query {
5780#
5781# taskReplacementEngines {
5782#
5783# records {
5784#
5785# sourceEngineId
5786#
5787# replacementEngineId
5788#
5789# }
5790#
5791# }
5792# }
5793# Response:
5794# {
5795#
5796# "data": {
5797#
5798# "taskReplacementEngines": {
5799#
5800# "records": [
5801#
5802# {
5803#
5804# "sourceEngineId": "1",
5805#
5806# "replacementEngineId": "2"
5807#
5808# }
5809#
5810# ]
5811#
5812# }
5813#
5814# }
5815# }
5816#
5817# Arguments
5818# organizationId: Only superadmin can get engine replacement of
5819# other orgs
5820# engineId: Filter by the source engineId
5821# offset: Provide an offset to skip to a certain element in the
5822# result, for paging.
5823# limit: Specify maximum number of results to retrieve in this
5824# result. Page size.
5825taskReplacementEngines(
5826organizationId: ID,
5827engineId: ID,
5828offset: Int,
5829limit: Int
5830): TaskReplacementEngineList
5831
5832# Retrive Notification Mailboxes by list of mailboxIds
5833# Example:
5834# Request:
5835# query {
5836#
5837# notificationMailboxes {
5838#
5839# id
5840#
5841# name
5842#
5843# }
5844# }
5845# Response:
5846# {
5847#
5848# "data": {
5849#
5850# "notificationMailboxes": [
5851#
5852# {
5853#
5854# "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149",
5855#
5856# "name": "example"
5857#
5858# },
5859#
5860# {
5861#
5862# "id": "d20e9f37-a887-41bb-aed0-3268884ecebc",
5863#
5864# "name": "Library training mailbox"
5865#
5866# },
5867#
5868# {
5869#
5870# "id": "2d29533b-560e-4354-b794-84f823d33205",
5871#
5872# "name": "Library training mailbox"
5873#
5874# }
5875#
5876# ]
5877#
5878# }
5879# }
5880notificationMailboxes(ids: [ID!], name: String): [NotificationMailbox!]
5881
5882# Retrive Notification Templates
5883# Example:
5884# Request:
5885# query {
5886#
5887# notificationTemplates(limit: 2) {
5888#
5889# records {
5890#
5891# id
5892#
5893# eventName
5894#
5895# }
5896#
5897# }
5898# }
5899# Response:
5900# {
5901#
5902# "data": {
5903#
5904# "notificationTemplates": {
5905#
5906# "records": [
5907#
5908# {
5909#
5910# "id": "3947b833-2be4-4415-8272-2cee62fbca23",
5911#
5912# "eventName": "example"
5913#
5914# }
5915#
5916# ]
5917#
5918# }
5919#
5920# }
5921# }
5922#
5923# Arguments
5924# ids: Get by array of ids
5925# eventName: Get by eventName
5926# eventType: Get by eventType
5927# application: Get by application
5928# mailboxId: Get by mailboxId
5929# ownerOrganizationId: Only super-admin or orgless token can get
5930# templates by ownerOrganizationId
5931# offset: Provide an offset to skip to a certain element in the
5932# result, for paging.
5933# limit: Specify maximum number of results to retrieve in this
5934# result. Page size.
5935notificationTemplates(
5936ids: [ID],
5937eventName: String,
5938eventType: String,
5939application: String,
5940mailboxId: ID,
5941ownerOrganizationId: ID,
5942offset: Int,
5943limit: Int
5944): NotificationTemplateList
5945
5946# Retrieve Notification Actions
5947# Example:
5948# Request:
5949# query {
5950#
5951# notificationActions {
5952#
5953# records {
5954#
5955# id
5956#
5957# actionName
5958#
5959# }
5960#
5961# }
5962# }
5963# Response:
5964# {
5965#
5966# "data": {
5967#
5968# "notificationActions": {
5969#
5970# "records": [
5971#
5972# {
5973#
5974# "id": "866aad9c-9e68-4c33-b523-373bb332aea2",
5975#
5976# "actionName": "example"
5977#
5978# }
5979#
5980# ]
5981#
5982# }
5983#
5984# }
5985# }
5986#
5987# Arguments
5988# ids: Get by array of ids
5989# eventName: Get by eventName
5990# eventType: Get by eventType
5991# application: Get by application
5992# mailboxId: Get by mailboxId
5993# ownerOrganizationId: Only super-admin or orgless token can get
5994# templates by ownerOrganizationId
5995# offset: Provide an offset to skip to a certain element in the
5996# result, for paging.
5997# limit: Specify maximum number of results to retrieve in this
5998# result. Page size.
5999notificationActions(
6000ids: [ID],
6001eventName: String,
6002eventType: String,
6003application: String,
6004mailboxId: ID,
6005ownerOrganizationId: ID,
6006offset: Int,
6007limit: Int
6008): NotificationActionList
6009
6010# Retrieve Application user setting definitions
6011# Example:
6012# Request:
6013# query {
6014#
6015# getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") {
6016#
6017# key
6018#
6019# value
6020#
6021# }
6022# }
6023# Response:
6024# {
6025#
6026# "data": {
6027#
6028# "getUserSettingDefinitions": [
6029#
6030# {
6031#
6032# "key": "example",
6033#
6034# "value": "example"
6035#
6036# }
6037#
6038# ]
6039#
6040# }
6041# }
6042#
6043# Arguments
6044# application: Specify the applicationId
6045# key: Specify the key of user setting (optional)
6046# organizationGuid: Specify the organizationGuid (require for
6047# internal token)
6048# This can be specified by superadmin to get user setting definitions of other
6049# organization
6050getUserSettingDefinitions(
6051application: ID!,
6052key: String,
6053organizationGuid: ID
6054): [ApplicationSetting]
6055
6056# Retrive User setting
6057# Example:
6058# Request:
6059# query {
6060#
6061# getUserSettings {
6062#
6063# key
6064#
6065# applicationId
6066#
6067# }
6068# }
6069# Response:
6070# {
6071#
6072# "data": {
6073#
6074# "getUserSettings": [
6075#
6076# {
6077#
6078# "key": "example12",
6079#
6080# "applicationId": "80354999-d633-4595-9578-d82f59a5134f"
6081#
6082# }
6083#
6084# ]
6085#
6086# }
6087# }
6088#
6089# Arguments
6090# userId: Filter by userId (optional).
6091# If it's not specified, default is current user
6092# application: Filter by applicationId
6093# keys: Filter by keys
6094getUserSettings(userId: ID, application: ID, keys: [String]): [UserSetting]
6095
6096# Example:
6097# Request:
6098# query {
6099#
6100# staticAppConfig {
6101#
6102# loginUrl
6103#
6104# apiRoot
6105#
6106# }
6107# }
6108# Response:
6109# {
6110#
6111# "data": {
6112#
6113# "staticAppConfig": {
6114#
6115# "loginUrl": "https://login.veritone.com",
6116#
6117# "apiRoot": "https://api.veritone.com"
6118#
6119# }
6120#
6121# }
6122# }
6123staticAppConfig: StaticAppConfig!
6124
6125# Get OpenID Provider by id
6126openIdProvider(id: ID!): OpenIdProvider!
6127
6128# Get OpenID Provides
6129# Example:
6130# Request:
6131# query {
6132#
6133# openIdProviders {
6134#
6135# records {
6136#
6137# id
6138#
6139# isGlobal
6140#
6141# websiteUrl
6142#
6143# }
6144#
6145# }
6146# }
6147# Response:
6148# {
6149#
6150# "data": {
6151#
6152# "openIdProviders": {
6153#
6154# "records": []
6155#
6156# }
6157#
6158# }
6159# }
6160#
6161# Arguments
6162# orgId: Filter Providers by organizationId. This is only used by
6163# superadmin.
6164# If filter with org-admin role, orgId is always the current user org.
6165openIdProviders(
6166ids: [ID],
6167isGlobal: Boolean,
6168orgId: ID,
6169offset: Int,
6170limit: Int
6171): OpenIdProviderList
6172
6173# Arguments
6174# orgId: This returns all packages that the Organization has
6175# access to.
6176#
6177# ___Note: for Super-Admin use only.___
6178# resourceId: This returns packages that have the provided
6179# resource linked to it
6180# resourceAlias: This returns any packages have resources that
6181# have the alias.
6182# primaryResourceId: This returns packages that have the provided
6183# resource as its primary resource
6184# sourceOriginId: This returns the entire lineage of packages
6185# that share the same sourceOriginId.
6186#
6187# This UUID is used to track a package's lineage. This UUID and versions is NOT
6188# guaranteed to be a package ID and should not be used as such.
6189# sourcePackageId: This returns any packages that immediately
6190# derive from the provided ID.
6191#
6192# The sourcePackageId of a package refers to the package that it derived from, if
6193# any.
6194# For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0,
6195# and 4.0.
6196# If the ID of version 2.0 is provided, this filter will return the package
6197# information for
6198# only version 3.0. This is because version 3.0 is the immediate descendent of
6199# version 2.0.
6200# packageFilter: Fields to filter the results by.
6201# distributionType: This returns packages of a specific
6202# distribution type
6203# distributionTypes: This returns packages of a list of
6204# distribution types
6205# status: This returns packages with a specific status
6206# nameRegexp: Search by package name via regex pattern. By
6207# default, this search is _case sensitive_. To change this behavior,
6208# refer to the `packageFilter.caseSensitive` field.
6209# owned: If true, return only packages owned by the calling org.
6210#
6211# If false, return all packages that the calling org has access to.
6212#
6213# The default behavior when `owned` is not provided assumes `false`.
6214#
6215# __Note__: Superadmin tokens are authorized to change the `orgId` field. If
6216# provided, the above behavior will apply to `orgId` instead of the calling org.
6217# includeDeleted: If true, result includes deleted packages
6218# offset: Provide an offset to skip to a certain element in the
6219# result, for paging.
6220# limit: Specify maximum number of results to retrieve in this
6221# result. Page size.
6222packages(
6223id: ID,
6224ids: [ID!],
6225orgId: ID,
6226resourceId: ID,
6227resourceAlias: String,
6228primaryResourceId: ID,
6229sourceOriginId: ID,
6230sourcePackageId: ID,
6231packageFilter: PackageFilter,
6232distributionType: EngineDistributionType,
6233distributionTypes: [EngineDistributionType!],
6234status: PackageStatus,
6235nameRegexp: String,
6236owned: Boolean,
6237includeDeleted: Boolean,
6238offset: Int,
6239limit: Int
6240): PackageList
6241
6242# List existing package grants.
6243# Either packageId or organizationId must be specified.
6244#
6245# The following examples assume that the caller is the owner of the Packages:
6246# packageGrants(id: 123) - Show Grants for Package 123
6247# packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12
6248# packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12
6249#
6250# Arguments
6251# id: Package ID. If specified, show all the Grants for this
6252# Package.
6253#
6254# If calling Org is owner of the Package, show all Grants.
6255#
6256# If calling Org is not owner of the Package, only show Grants for the Package to
6257# the calling Org.
6258#
6259# If Super-Admin, show all Grants for the Package.
6260# orgId: Show all Grants to the specified Org.
6261#
6262# If the input organizationId is different from the calling Org, this will show
6263# Grants for Packages
6264# that are owned by the calling Org to the specified Org.
6265#
6266# If the input organizationId is the same as the caller's Org, this will show
6267# Grants for Packages
6268# to the calling Org.
6269#
6270# If Super-Admin, show Grants for all Packages to the specified Org.
6271# includeDeleted: If true, result includes deleted packages
6272# offset: Provide an offset to skip to a certain element in the
6273# result, for paging.
6274# limit: Specify maximum number of results to retrieve in this
6275# result. Page size.
6276packageGrants(
6277id: ID,
6278orgId: ID,
6279includeDeleted: Boolean,
6280offset: Int,
6281limit: Int,
6282packageFilter: PackageGrantFilter
6283): PackageGrantList
6284
6285# Retrieve the basic user information.
6286# The caller and the queried user are required to be members of the same
6287# organization,
6288# unless the caller is superadmin user.
6289# Example:
6290# Request:
6291# query {
6292#
6293# basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") {
6294#
6295# id
6296#
6297# name
6298#
6299# firstName
6300#
6301# lastName
6302#
6303# email
6304#
6305# imageUrl
6306#
6307# }
6308# }
6309# Response:
6310# {
6311#
6312# "data": {
6313#
6314# "basicUserInfo": {
6315#
6316# "id": "267de7e1-efb2-444a-a524-210328b78503",
6317#
6318# "name": "username",
6319#
6320# "firstName": "first",
6321#
6322# "lastName": "last",
6323#
6324# "email": "email@test.com",
6325#
6326# "imageUrl": null
6327#
6328# }
6329#
6330# }
6331# }
6332#
6333# Arguments
6334# id: The user ID.
6335# A user ID is a string in UUID format.
6336basicUserInfo(id: ID!): BasicUserInfo
6337
6338apiTokens: [ApiTokenInfo]!
6339
6340# Gets the most up to date package linked to this automate flow
6341#
6342# Arguments
6343# engineId: Engine Id for the automate flow.
6344automatePackage(engineId: ID!): Package
6345
6346# Retrieve applicationViewers
6347# Example:
6348# Request:
6349# query {
6350# applicationViewers(limit:2) {
6351# records{
6352# id
6353# name
6354# }
6355# }
6356# }
6357# Response:
6358# {
6359# "data": {
6360# "viewers": {
6361# "records": [
6362# {
6363# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6364# "name": "Viewer 1"
6365# },
6366# {
6367# "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c",
6368# "name": "Viewer 2"
6369# }
6370# ]
6371# }
6372# }
6373# }
6374#
6375# Arguments
6376# ids: Provide an ids to retrieve specific viewers.
6377# offset: Specify maximum number of results to retrieve in this
6378# result. Page size.
6379# limit: Specify maximum number of results to retrieve in this
6380# result.
6381# orderBy: Provide a list of ApplicationViewerSortField to sort
6382# by.
6383# isPublic: Filter viewers that are publicly accessible across
6384# all organizations.
6385applicationViewers(
6386ids: [ID!],
6387offset: Int,
6388limit: Int,
6389orderBy: ApplicationViewerSortField,
6390isPublic: Boolean
6391): ApplicationViewerList
6392
6393# Arguments
6394# encryptionKey: Key to decrypt the stored data.
6395# fromAddress: Credential id to look up in the database.
6396platformEmailProvider(
6397encryptionKey: String,
6398fromAddress: String
6399): EmailProviderConfig
6400
6401# Retrieve email template by id.
6402emailTemplateGet(id: ID!, organizationGuid: ID): EmailTemplate
6403
6404}

link Required by

This element is not required by anyone