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

link Required by

This element is not required by anyone