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

link Required by

This element is not required by anyone