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# Return writable storage URLs in bulk.
3670# A maximum of 1000 can be created in one call.
3671# See `getSignedWritableUrl` for details on usage of the
3672# response contents.
3673# Example:
3674# Request:
3675# query {
3676#
3677# getSignedWritableUrls(number: 2) {
3678#
3679# bucket
3680#
3681# key
3682#
3683# url
3684#
3685# }
3686# }
3687# Response:
3688# {
3689#
3690# "data": {
3691#
3692# "getSignedWritableUrls": [
3693#
3694# {
3695#
3696# "bucket": "prod-api.veritone.com",
3697#
3698# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3699#
3700# "url":
3701# "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"
3702#
3703# },
3704#
3705# {
3706#
3707# "bucket": "prod-api.veritone.com",
3708#
3709# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3710#
3711# "url":
3712# "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"
3713#
3714# }
3715#
3716# ]
3717#
3718# }
3719# }
3720#
3721# Arguments
3722# number: Number of signed URLs to return
3723# type: Optional type of resource, such as `asset`, `thumbnail`,
3724# or `preview`
3725# path: Optional extended path information. If the uploaded
3726# content will be contained
3727# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3728# (for `entityIdentifier`), the ID of the object should be provided here.
3729# organizationId: Optional organization ID. Normally this value
3730# is computed by the server
3731# based on the authorization token used for the request.
3732# Is is used only by Veritone platform components.
3733getSignedWritableUrls(
3734number: Int!,
3735type: String,
3736path: String,
3737organizationId: ID
3738): [WritableUrlInfo!]!
3739
3740# Return the overall status for a PUT request, reporting any failures that might
3741# have occurred.
3742# Example:
3743# Request:
3744#
3745# query {
3746#
3747# getUploadStatus(input: {
3748#
3749# key:
3750#
3751# }) {
3752#
3753# status
3754#
3755# message
3756#
3757# totalBytesReceived
3758#
3759# missingChunkNumbers
3760#
3761# failures {
3762#
3763# records {
3764#
3765# chunkNumber
3766#
3767# status
3768#
3769# message
3770#
3771# }
3772#
3773# }
3774#
3775# }
3776#
3777# }
3778# Response:
3779#
3780# {
3781#
3782# "data": {
3783#
3784# "getUploadStatus":
3785#
3786# {
3787#
3788# "status": "processing",
3789#
3790# "message": "test message",
3791#
3792# "totalBytesReceived": 124000000
3793#
3794# "missingChunkNumbers": 2
3795#
3796# "faiulures": [
3797#
3798# {
3799#
3800# "chunkNumber": 4
3801#
3802# "status": "failed"
3803#
3804# "message": "error message"
3805#
3806# }
3807#
3808# ]
3809#
3810# }
3811#
3812# }
3813#
3814# }
3815#
3816# Arguments
3817# input: UploadStatus input
3818getUploadStatus(input: UploadStatusInput!): UploadStatus!
3819
3820# Retrieve the rights of the current user
3821# Example:
3822# Request:
3823# query {
3824#
3825# myRights {
3826#
3827# resources
3828#
3829# operations
3830#
3831# }
3832# }
3833# Response:
3834# {
3835#
3836# "data": {
3837#
3838# "myRights": {
3839#
3840# "resources": {},
3841#
3842# "operations": [
3843#
3844# "admin.access",
3845#
3846# "admin.org.read",
3847#
3848# "admin.org.update",
3849#
3850# "admin.user.create",
3851#
3852# "admin.user.read",
3853#
3854# "admin.user.update",
3855#
3856# "admin.user.delete",
3857#
3858# ...
3859#
3860# ]
3861#
3862# }
3863#
3864# }
3865# }
3866myRights: RightsListing
3867
3868# Retrieve the shared folders for an organization
3869# Example:
3870# Request:
3871# query {
3872#
3873# sharedFolders {
3874#
3875# id
3876#
3877# }
3878# }
3879# Response:
3880# {
3881#
3882# "data": {
3883#
3884# "sharedFolders": []
3885#
3886# }
3887# }
3888sharedFolders: [Folder]
3889
3890# Retrieve multiple watchlists
3891# Example:
3892# Request:
3893# query {
3894#
3895# watchlists(limit: 2) {
3896#
3897# records {
3898#
3899# id
3900#
3901# name
3902#
3903# }
3904#
3905# }
3906# }
3907# Response:
3908# {
3909#
3910# "data": {
3911#
3912# "watchlists": {
3913#
3914# "records": [
3915#
3916# {
3917#
3918# "id": "326916",
3919#
3920# "name": "example"
3921#
3922# },
3923#
3924# {
3925#
3926# "id": "325791",
3927#
3928# "name": "example"
3929#
3930# }
3931#
3932# ]
3933#
3934# }
3935#
3936# }
3937# }
3938#
3939# Arguments
3940# isDisabled: Set `true` to include only disabled watchlist or
3941# `false` to include only enabled watchlists. By default,
3942# both are included.
3943# names: Provide a list of names to filter folders
3944watchlists(
3945id: ID,
3946maxStopDateTime: DateTime,
3947minStopDateTime: DateTime,
3948minStartDateTime: DateTime,
3949maxStartDateTime: DateTime,
3950name: String,
3951offset: Int,
3952limit: Int,
3953orderBy: WatchlistOrderBy,
3954orderDirection: OrderDirection,
3955isDisabled: Boolean,
3956names: [String],
3957nameMatch: StringMatch
3958): WatchlistList
3959
3960# Retrieve a single watchlist by id
3961# Example:
3962# Request:
3963# query {
3964#
3965# watchlist(id: "325791") {
3966#
3967# name
3968#
3969# watchlistType
3970#
3971# }
3972# }
3973# Response:
3974# {
3975#
3976# "data": {
3977#
3978# "watchlist": {
3979#
3980# "name": "example",
3981#
3982# "watchlistType": "tracking"
3983#
3984# }
3985#
3986# }
3987# }
3988watchlist(id: ID!): Watchlist
3989
3990# Example:
3991# Request:
3992# query {
3993#
3994# mentionStatusOptions {
3995#
3996# id
3997#
3998# name
3999#
4000# }
4001# }
4002# Response:
4003# {
4004#
4005# "data": {
4006#
4007# "mentionStatusOptions": [
4008#
4009# {
4010#
4011# "id": "7",
4012#
4013# "name": "Auto Verified"
4014#
4015# },
4016#
4017# {
4018#
4019# "id": "5",
4020#
4021# "name": "Invalid"
4022#
4023# },
4024#
4025# {
4026#
4027# "id": "3",
4028#
4029# "name": "Needs Review"
4030#
4031# },
4032#
4033# {
4034#
4035# "id": "1",
4036#
4037# "name": "Pending Verification"
4038#
4039# },
4040#
4041# {
4042#
4043# "id": "6",
4044#
4045# "name": "Processing Verification"
4046#
4047# },
4048#
4049# {
4050#
4051# "id": "4",
4052#
4053# "name": "Request Bonus"
4054#
4055# },
4056#
4057# {
4058#
4059# "id": "2",
4060#
4061# "name": "Verified"
4062#
4063# }
4064#
4065# ]
4066#
4067# }
4068# }
4069mentionStatusOptions: [MentionStatus!]!
4070
4071# Retrieve multiple data registries
4072# Example:
4073# Request:
4074# query {
4075#
4076# dataRegistries(limit: 2) {
4077#
4078# records {
4079#
4080# id
4081#
4082# name
4083#
4084# }
4085#
4086# }
4087# }
4088# Response:
4089# {
4090#
4091# "data": {
4092#
4093# "dataRegistries": {
4094#
4095# "records": [
4096#
4097# {
4098#
4099# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
4100#
4101# "name": "example"
4102#
4103# },
4104#
4105# {
4106#
4107# "id": "317c941d-30d0-455e-882b-34a26e513364",
4108#
4109# "name": "example"
4110#
4111# }
4112#
4113# ]
4114#
4115# }
4116#
4117# }
4118# }
4119dataRegistries(
4120id: ID,
4121ids: [ID!],
4122name: String,
4123nameMatch: StringMatch,
4124offset: Int,
4125limit: Int,
4126orderBy: DataRegistryOrderBy,
4127orderDirection: OrderDirection,
4128filterByOwnership: SchemaOwnership
4129): DataRegistryList
4130
4131# Retrieve a single data registry
4132# Example:
4133# Request:
4134# query {
4135#
4136# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
4137#
4138# name
4139#
4140# organizationId
4141#
4142# source
4143#
4144# }
4145# }
4146# Response:
4147# {
4148#
4149# "data": {
4150#
4151# "dataRegistry": {
4152#
4153# "name": "example",
4154#
4155# "organizationId": "35521",
4156#
4157# "source": "veritone-35521.datasets"
4158#
4159# }
4160#
4161# }
4162# }
4163dataRegistry(id: ID!): DataRegistry
4164
4165# Retrieve a subscription by id
4166# Example:
4167# Request:
4168# query {
4169#
4170# subscription(id: "275818") {
4171#
4172# isActive
4173#
4174# jsondata
4175#
4176# }
4177# }
4178# Response:
4179# {
4180#
4181# "data": {
4182#
4183# "subscription": {
4184#
4185# "isActive": true,
4186#
4187# "jsondata": {
4188#
4189# "tracking_unit_id": "325791",
4190#
4191# "creator_email": "example email",
4192#
4193# "unsubscribe_hash": "example jwt token"
4194#
4195# }
4196#
4197# }
4198#
4199# }
4200# }
4201subscription(id: ID!): Subscription!
4202
4203cognitiveSearch(id: ID!): CognitiveSearch!
4204
4205# Retrieve multiple collections
4206# Example:
4207# Request:
4208# query {
4209#
4210# collections {
4211#
4212# records {
4213#
4214# id
4215#
4216# name
4217#
4218# }
4219#
4220# }
4221# }
4222# Response:
4223# {
4224#
4225# "data": {
4226#
4227# "collections": {
4228#
4229# "records": [
4230#
4231# {
4232#
4233# "id": "241121",
4234#
4235# "name": "example"
4236#
4237# },
4238#
4239# {
4240#
4241# "id": "242599",
4242#
4243# "name": "example"
4244#
4245# },
4246#
4247# {
4248#
4249# "id": "243625",
4250#
4251# "name": "example"
4252#
4253# }
4254#
4255# ]
4256#
4257# }
4258#
4259# }
4260# }
4261collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
4262
4263# Retrieve a collection by id
4264# Example:
4265# Request:
4266# query {
4267#
4268# collection(id: "241121") {
4269#
4270# name
4271#
4272# isActive
4273#
4274# }
4275# }
4276# Response:
4277# {
4278#
4279# "data": {
4280#
4281# "collection": {
4282#
4283# "name": "example",
4284#
4285# "isActive": true
4286#
4287# }
4288#
4289# }
4290# }
4291collection(id: ID!): Collection!
4292
4293collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
4294
4295# Retrieve a list of collection mentions
4296# Specify at least one of folderId or mentionId
4297collectionMentions(
4298folderId: ID,
4299mentionId: ID,
4300orderBy: CollectionMentionOrderBy,
4301limit: Int,
4302offset: Int
4303): CollectionMentionList!
4304
4305# Retrieve multiple mentions
4306# Example:
4307# Request:
4308# query {
4309#
4310# mentions {
4311#
4312# records {
4313#
4314# id
4315#
4316# }
4317#
4318# }
4319# }
4320# Response:
4321# {
4322#
4323# "data": {
4324#
4325# "mentions": {
4326#
4327# "records": []
4328#
4329# }
4330#
4331# }
4332# }
4333#
4334# Arguments
4335# watchlistId: Get mentions created from the specified watchlist
4336# sourceId: Get mentions associated with the specified source
4337# sourceTypeId: Get mentions associated with sources of the
4338# specified source type
4339# tdoId: Get mentions associated directly with the specific TDO
4340# dateTimeFilter: Specify date/time filters against mention
4341# fields.
4342# Querying for mentions can be expensive. If the query does not
4343# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
4344# a user-provided `dateTimeFilter`, a default filter of the
4345# past 7 days is applied.
4346# orderBy: Set order information on the query. Multiple fields
4347# are supported.
4348# folderId: Provide a folder ID to filter by collection
4349mentions(
4350id: ID,
4351watchlistId: ID,
4352sourceId: ID,
4353sourceTypeId: ID,
4354tdoId: ID,
4355dateTimeFilter: [MentionDateTimeFilter!],
4356orderBy: [MentionOrderBy!],
4357offset: Int,
4358limit: Int,
4359folderId: ID
4360): MentionList
4361
4362# Retrieves engine results by TDO and engine ID or by job ID.
4363# Example:
4364# Request:
4365# query {
4366#
4367# engineResults(
4368#
4369# tdoId: "1580507556",
4370#
4371# engineIds: "4") {
4372#
4373# sourceId
4374#
4375# records {
4376#
4377# tdoId
4378#
4379# }
4380#
4381# }
4382# }
4383# Response:
4384# {
4385#
4386# "data": {
4387#
4388# "engineResults": {
4389#
4390# "sourceId": null,
4391#
4392# "records": []
4393#
4394# }
4395#
4396# }
4397# }
4398#
4399# Arguments
4400# tdoId: Provide the ID of the TDO containing engine results to
4401# retrieve.
4402# If this parameter is used, engineIds or engineCategoryIds must also be set.
4403# Results for _only_ the specified TDO will be returned.
4404# sourceId: Provide the ID of the Source containing engine
4405# results to retrieve.
4406# If this parameter is used, engineIds or engineCategoryIds must also be set.
4407# This takes priority over tdoId.
4408# engineIds: Provide one or more engine IDs to retrieve engine
4409# results by
4410# ID. This parameter is mandatory if tdoId is used, but optional
4411# if jobId or engineCategory is used.
4412# engineCategoryIds: Provide one or more category IDs to get all
4413# results from that categroy.
4414# jobId: Provide a job ID to retrieve engine results for the job.
4415# mentionId: Provide a mention ID to retrieve engine results for
4416# the mention.
4417# startOffsetMs: Start offset ms for the results.
4418# stopOffsetMs: End offset ms for the results.
4419# startDate: Start date for the results. Takes priority over
4420# startOffsetMs.
4421# stopDate: End date for the results. Takes priority over
4422# stopOffsetMs.
4423# ignoreUserEdited: Whether or not to exclude user edited engine
4424# results. Defaults to false.
4425# fallbackTdoId: A TDO ID can be provided for use if the provided
4426# `sourceId` and/or
4427# `mentionId` parameters do not resolve to a logical set of TDOs.
4428# Depending on parameter settings and available data,
4429# results from other TDOs can be included in the response.
4430engineResults(
4431tdoId: ID,
4432sourceId: ID,
4433engineIds: [ID!],
4434engineCategoryIds: [ID!],
4435jobId: ID,
4436mentionId: ID,
4437startOffsetMs: Int,
4438stopOffsetMs: Int,
4439startDate: DateTime,
4440stopDate: DateTime,
4441ignoreUserEdited: Boolean,
4442fallbackTdoId: ID
4443): EngineResultList
4444
4445# Retrieve a trigger by id
4446# Example:
4447# Request:
4448# query {
4449#
4450# trigger(id: "2998") {
4451#
4452# target
4453#
4454# createdDateTime
4455#
4456# }
4457# }
4458# Response:
4459# {
4460#
4461# "data": {
4462#
4463# "trigger": {
4464#
4465# "target": "Email",
4466#
4467# "createdDateTime": "2021-06-18T13:35:08.631Z"
4468#
4469# }
4470#
4471# }
4472# }
4473trigger(id: ID!): Trigger
4474
4475# Retrieve triggers
4476# Example:
4477# Request:
4478# query {
4479#
4480# triggers {
4481#
4482# id
4483#
4484# }
4485# }
4486# Response:
4487# {
4488#
4489# "data": {
4490#
4491# "triggers": [
4492#
4493# {
4494#
4495# "id": "2998"
4496#
4497# }
4498#
4499# ]
4500#
4501# }
4502# }
4503triggers: [Trigger]
4504
4505# Fetch all saved searches that the current user has made
4506# Fetch all saved searches that have been shared with
4507# the current users organization
4508# Include any saved searches that the user has created
4509# Example:
4510# Request:
4511# query {
4512#
4513# savedSearches {
4514#
4515# records {
4516#
4517# id
4518#
4519# name
4520#
4521# }
4522#
4523# }
4524# }
4525# Response:
4526# {
4527#
4528# "data": {
4529#
4530# "savedSearches": {
4531#
4532# "records": [
4533#
4534# {
4535#
4536# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
4537#
4538# "name": "example"
4539#
4540# }
4541#
4542# ]
4543#
4544# }
4545#
4546# }
4547# }
4548savedSearches(
4549offset: Int,
4550limit: Int,
4551includeShared: Boolean,
4552filterByName: String,
4553orderBy: SavedSearchOrderBy,
4554orderDirection: OrderDirection
4555): SavedSearchList!
4556
4557# Retrieve a list of export requests
4558# Example:
4559# Request:
4560# query {
4561#
4562# exportRequests(limit: 2) {
4563#
4564# records {
4565#
4566# id
4567#
4568# organizationId
4569#
4570# }
4571#
4572# }
4573# }
4574# Response:
4575# {
4576#
4577# "data": {
4578#
4579# "exportRequests": {
4580#
4581# "records": [
4582#
4583# {
4584#
4585# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4586#
4587# "organizationId": "35521"
4588#
4589# }
4590#
4591# ]
4592#
4593# }
4594#
4595# }
4596# }
4597#
4598# Arguments
4599# id: Provide an ID to retrieve a single export request
4600# offset: Provide an offset to skip to a certain element in the
4601# result, for paging.
4602# limit: Specify maximum number of results to retrieve in this
4603# result. Page size.
4604# status: Provide a list of status options to filter by status
4605# event: Provide an event to retrieve export request. Should be
4606# 'exportRequest' or 'mentionExportRequest'
4607# Default value is 'exportRequest'
4608exportRequests(
4609id: ID,
4610offset: Int,
4611limit: Int,
4612status: [ExportRequestStatus!],
4613event: ExportRequestEvent
4614): ExportRequestList!
4615
4616# Retrieve a single export request by id
4617# Example:
4618# Request:
4619# query {
4620#
4621# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
4622#
4623# id
4624#
4625# organizationId
4626#
4627# requestorId
4628#
4629# status
4630#
4631# }
4632# }
4633# Response:
4634# {
4635#
4636# "data": {
4637#
4638# "exportRequest": {
4639#
4640# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4641#
4642# "organizationId": "35521",
4643#
4644# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4645#
4646# "status": "complete"
4647#
4648# }
4649#
4650# }
4651# }
4652#
4653# Arguments
4654# event: Provide an event to retrieve export request. Should be
4655# 'exportRequest' or 'mentionExportRequest'
4656# Default value is 'exportRequest'
4657exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4658
4659# Retrieve a event by id
4660# Example:
4661# Request:
4662# query {
4663#
4664# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4665#
4666# eventName
4667#
4668# eventType
4669#
4670# description
4671#
4672# }
4673# }
4674# Response:
4675# {
4676#
4677# "data": {
4678#
4679# "event": {
4680#
4681# "eventName": "example",
4682#
4683# "eventType": "example",
4684#
4685# "description": "new example description"
4686#
4687# }
4688#
4689# }
4690# }
4691event(id: ID!): Event
4692
4693# Retrieve a list of events by application
4694# Example:
4695# Request:
4696# query {
4697#
4698# events(
4699#
4700# application: "system",
4701#
4702# limit: 2) {
4703#
4704# records {
4705#
4706# id
4707#
4708# eventName
4709#
4710# }
4711#
4712# }
4713# }
4714# Response:
4715# {
4716#
4717# "data": {
4718#
4719# "events": {
4720#
4721# "records": [
4722#
4723# {
4724#
4725# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4726#
4727# "eventName": "ActionTokenForbidden"
4728#
4729# },
4730#
4731# {
4732#
4733# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4734#
4735# "eventName": "ActionUserForbidden"
4736#
4737# }
4738#
4739# ]
4740#
4741# }
4742#
4743# }
4744# }
4745#
4746# Arguments
4747# application: Provide an application to retrieve all its events.
4748# Use 'system' to list all public system events.
4749# offset: Provide an offset to skip to a certain element in the
4750# result, for paging.
4751# limit: Specify maximum number of results to retrieve in this
4752# result. Page size.
4753events(application: String!, offset: Int, limit: Int): EventList!
4754
4755# Retrieve a list of subscriptions by organization
4756# Example:
4757# Request:
4758# query {
4759#
4760# eventSubscriptions(limit: 2) {
4761#
4762# records {
4763#
4764# id
4765#
4766# eventName
4767#
4768# }
4769#
4770# }
4771# }
4772# Response:
4773# {
4774#
4775# "data": {
4776#
4777# "eventSubscriptions": {
4778#
4779# "records": [
4780#
4781# {
4782#
4783# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4784#
4785# "eventName": "LibraryTrain"
4786#
4787# },
4788#
4789# {
4790#
4791# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4792#
4793# "eventName": "LibraryTrain"
4794#
4795# }
4796#
4797# ]
4798#
4799# }
4800#
4801# }
4802# }
4803#
4804# Arguments
4805# ids: The event subscription ids
4806# eventName: The name of the event
4807# eventType: The type of event, such as `mention`, `job`,
4808# `engine`.
4809# offset: Provide an offset to skip to a certain element in the
4810# result, for paging.
4811# limit: Specify maximum number of results to retrieve in this
4812# result. Page size.
4813# orgId: The organization ID with which these event subscriptions
4814# are associated.
4815# appId: The application ID with which these event subscriptions
4816# are associated.
4817# scope: Event subscription scope
4818eventSubscriptions(
4819ids: [ID!],
4820eventName: String,
4821eventType: String,
4822offset: Int,
4823limit: Int,
4824orgId: ID,
4825appId: ID,
4826scope: EventSubscriptionScope
4827): EventSubscriptionList!
4828
4829# Retrieve a subscription by id
4830# Example:
4831# Request:
4832# query {
4833#
4834# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4835#
4836# id
4837#
4838# organizationId
4839#
4840# eventName
4841#
4842# targetName
4843#
4844# }
4845# }
4846# Response:
4847# {
4848#
4849# "data": {
4850#
4851# "eventSubscription": {
4852#
4853# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4854#
4855# "organizationId": "35521",
4856#
4857# "eventName": "LibraryTrain",
4858#
4859# "targetName": "NotificationMailbox"
4860#
4861# }
4862#
4863# }
4864# }
4865eventSubscription(id: ID!): EventSubscription!
4866
4867# Example:
4868# Request:
4869# query {
4870#
4871# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4872#
4873# organizationId
4874#
4875# actionType
4876#
4877# name
4878#
4879# }
4880# }
4881# Response:
4882# {
4883#
4884# "data": {
4885#
4886# "eventActionTemplate": {
4887#
4888# "organizationId": "35521",
4889#
4890# "actionType": "job",
4891#
4892# "name": "example"
4893#
4894# }
4895#
4896# }
4897# }
4898eventActionTemplate(id: ID!): EventActionTemplate
4899
4900# Example:
4901# Request:
4902# query {
4903#
4904# eventActionTemplates(
4905#
4906# inputType: event,
4907#
4908# actionType: job
4909#
4910# limit:2) {
4911#
4912# records {
4913#
4914# id
4915#
4916# name
4917#
4918# }
4919#
4920# }
4921# }
4922# Response:
4923# {
4924#
4925# "data": {
4926#
4927# "eventActionTemplates": {
4928#
4929# "records": [
4930#
4931# {
4932#
4933# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4934#
4935# "name": "example"
4936#
4937# },
4938#
4939# {
4940#
4941# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4942#
4943# "name": "example"
4944#
4945# }
4946#
4947# ]
4948#
4949# }
4950#
4951# }
4952# }
4953#
4954# Arguments
4955# ownerApplicationId: The application id
4956# inputType: use "event" for now. In the future, we allow
4957# additional input_type types. For example, a schedule or a tweet.
4958# actionType: Either "job", "webhook", "sms", "email". Future
4959# action_type could be "gql" where action is purely a function call.
4960# offset: Provide an offset to skip to a certain element in the
4961# result, for paging.
4962# limit: Specify maximum number of results to retrieve in this
4963# result. Page size.
4964eventActionTemplates(
4965ownerApplicationId: ID,
4966inputType: EventActionTemplateInputType,
4967actionType: EventActionTemplateActionType,
4968offset: Int,
4969limit: Int
4970): EventActionTemplateList!
4971
4972# Example:
4973# Request:
4974# query {
4975#
4976# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4977#
4978# name
4979#
4980# eventName
4981#
4982# description
4983#
4984# }
4985# }
4986# Response:
4987# {
4988#
4989# "data": {
4990#
4991# "eventCustomRule": {
4992#
4993# "name": "example",
4994#
4995# "eventName": "example",
4996#
4997# "description": "example description"
4998#
4999# }
5000#
5001# }
5002# }
5003eventCustomRule(id: ID!): EventCustomRule
5004
5005# Example:
5006# Request:
5007# query {
5008#
5009# eventCustomRules(limit: 2) {
5010#
5011# records {
5012#
5013# id
5014#
5015# name
5016#
5017# }
5018#
5019# }
5020# }
5021# Response:
5022# {
5023#
5024# "data": {
5025#
5026# "eventCustomRules": {
5027#
5028# "records": [
5029#
5030# {
5031#
5032# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
5033#
5034# "name": "example"
5035#
5036# }
5037#
5038# ]
5039#
5040# }
5041#
5042# }
5043# }
5044#
5045# Arguments
5046# offset: the offset to skip to a certain element in the result
5047# limit: the maximum number of rows in the results
5048eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
5049
5050# This query returns information about time zones recognized by this
5051#
5052# server. The information is static and does not change.
5053#
5054# Example:
5055#
5056# Request:
5057#
5058# query {
5059#
5060# timeZones {
5061#
5062# name
5063#
5064# abbreviations{
5065#
5066# name
5067#
5068# }
5069#
5070# }
5071# }
5072# Response:
5073# {
5074#
5075# "data": {
5076#
5077# "timeZones": [
5078#
5079# {
5080#
5081# "name": "Africa/Abidjan",
5082#
5083# "abbreviations": [
5084#
5085# {
5086#
5087# "name": "GMT"
5088#
5089# }
5090#
5091# ]
5092#
5093# },
5094#
5095# {
5096#
5097# "name": "Africa/Accra",
5098#
5099# "abbreviations": [
5100#
5101# {
5102#
5103# "name": "GMT"
5104#
5105# },
5106#
5107# {
5108#
5109# "name": "+0020"
5110#
5111# }
5112#
5113# ]
5114#
5115# },
5116#
5117# {
5118#
5119# "name": "Africa/Lagos",
5120#
5121# "abbreviations": [
5122#
5123# {
5124#
5125# "name": "WAT"
5126#
5127# }
5128#
5129# ]
5130#
5131# },
5132#
5133# ...
5134#
5135# ...
5136#
5137# ]
5138#
5139# }
5140#
5141# ]
5142#
5143# }
5144timeZones: [TimeZone!]!
5145
5146# Examine entries from the audit log. All operations that modify data are
5147# written to the audit log. Only entries for the user's own organization
5148# can be queried.
5149# All queries are bracketed by a time window. A default time window is applied
5150# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
5151# The maximum time window length is 30 days.
5152# Only Veritone and organization administrators can use this query.
5153# Example:
5154# Request:
5155# query {
5156#
5157# auditLog(limit: 2) {
5158#
5159# records {
5160#
5161# id
5162#
5163# objectId
5164#
5165# description
5166#
5167# }
5168#
5169# }
5170# }
5171# Response:
5172# {
5173#
5174# "data": {
5175#
5176# "auditLog": {
5177#
5178# "records": [
5179#
5180# {
5181#
5182# "id": "735915311",
5183#
5184# "objectId": "*********",
5185#
5186# "description": "Changed password"
5187#
5188# },
5189#
5190# {
5191#
5192# "id": "735915307",
5193#
5194# "objectId": "********",
5195#
5196# "description": "Changed password"
5197#
5198# }
5199#
5200# ]
5201#
5202# }
5203#
5204# }
5205# }
5206#
5207# Arguments
5208# toDateTime: Date/time up to which entries will be returned. In
5209# other words, the
5210# end of the query time window.
5211# Defaults to the current time.
5212# fromDateTime: Date/time from which entries will be returned. In
5213# other words, the
5214# start of the query time window.
5215# Defaults to the `toDateTime` minus 7 days.
5216# organizationId: Organization ID to query records for. This
5217# value can only be used by
5218# Veritone administrators. Any value provided by user administrators will
5219# be ignored.
5220# userName: User name on audit entry. Must be exact match.
5221# clientIpAddress: IP address of the client that generated the
5222# audit action. Must be exact match.
5223# clientUserAgent: HTTP user agent of the client that generated
5224# the audit action. Must be exact match.
5225# eventType: The event type, such as `Create`, `Update`, or
5226# `Delete`.
5227# Must be exact match.
5228# objectId: The ID of the object involved in the audit action.
5229# The format of this ID
5230# varies by object type. Must be exact match.
5231# objectType: The type of the object involved in the audit
5232# action, such as `Watchlist`
5233# or `TemporalDataObject`. Must be exact match.
5234# success: Whether or not the action was successful.
5235# id: The unique ID of an audit log entry. Multiple values can be
5236# provided.
5237# offset: Offset into result set, for paging.
5238# limit: Limit on result size, for paging (page size). Audit
5239# queries are
5240# lightweight so the default of 100 is higher than the default offset
5241# used elsewhere in the API.
5242# orderBy: Order information. Default is order by
5243# `createdDateTime` descending.
5244auditLog(
5245toDateTime: DateTime,
5246fromDateTime: DateTime,
5247organizationId: ID,
5248userName: String,
5249clientIpAddress: String,
5250clientUserAgent: String,
5251eventType: String,
5252objectId: ID,
5253objectType: String,
5254success: Boolean,
5255id: [ID!],
5256offset: Int,
5257limit: Int,
5258orderBy: [AuditLogOrderBy!]
5259): AuditLogEntryList! @deprecated( reason: "No longer supported." )
5260
5261# Get the media share by media shareId
5262mediaShare(id: ID!): MediaShare!
5263
5264# Retrieve a shared collection
5265#
5266# Arguments
5267# shareId: share token
5268sharedCollection(shareId: ID!): SharedCollection
5269
5270# Retrieve shared collection history records
5271# Example:
5272# Request:
5273# query {
5274#
5275# sharedCollectionHistory(limit: 2,
5276#
5277# folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") {
5278#
5279# records {
5280#
5281# id
5282#
5283# status
5284#
5285# shareId
5286#
5287# }
5288#
5289# }
5290# }
5291# Response:
5292# {
5293#
5294# "data": {
5295#
5296# "sharedCollectionHistory": {
5297#
5298# "records": []
5299#
5300# }
5301#
5302# }
5303# }
5304#
5305# Arguments
5306# ids: Provide an ID to retrieve a single history record
5307# folderId: Provide a folder ID to filter by collection
5308# shareId: Provide a share ID to filter by share ID
5309# offset: Specify maximum number of results to retrieve in this
5310# result. Page size.
5311# limit: Specify maximum number of results to retrieve in this
5312# result.
5313sharedCollectionHistory(
5314ids: [ID!],
5315folderId: ID,
5316shareId: String,
5317offset: Int,
5318limit: Int
5319): SharedCollectionHistoryList!
5320
5321# Get list process templates by id or current organizationId
5322# Example:
5323# Request:
5324# query {
5325#
5326# processTemplates(limit: 2) {
5327#
5328# records {
5329#
5330# id
5331#
5332# organizationId
5333#
5334# name
5335#
5336# }
5337#
5338# }
5339# }
5340# Response:
5341# {
5342#
5343# "data": {
5344#
5345# "processTemplates": {
5346#
5347# "records": [
5348#
5349# {
5350#
5351# "id": "762",
5352#
5353# "organizationId": "35521",
5354#
5355# "name": "example"
5356#
5357# }
5358#
5359# ]
5360#
5361# }
5362#
5363# }
5364# }
5365processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
5366
5367# Get process templates by id
5368# Example:
5369# Request:
5370# query {
5371#
5372# processTemplate(id: "762") {
5373#
5374# name
5375#
5376# organizationId
5377#
5378# }
5379# }
5380# Response:
5381# {
5382#
5383# "data": {
5384#
5385# "processTemplate": {
5386#
5387# "name": "example",
5388#
5389# "organizationId": "35521"
5390#
5391# }
5392#
5393# }
5394# }
5395processTemplate(id: ID!): ProcessTemplate!
5396
5397# Get creative by id with current organizationId
5398# Example:
5399# Request:
5400# query {
5401#
5402# creative(id: "25209") {
5403#
5404# organizationId
5405#
5406# brandId
5407#
5408# }
5409# }
5410# Response:
5411# {
5412#
5413# "data": {
5414#
5415# "creative": {
5416#
5417# "organizationId": "35521",
5418#
5419# "brandId": null
5420#
5421# }
5422#
5423# }
5424# }
5425creative(id: ID!): Creative!
5426
5427# Retrieve list of engine classes
5428# Example:
5429# Request:
5430# query {
5431#
5432# engineClasses(limit: 2) {
5433#
5434# records {
5435#
5436# id
5437#
5438# name
5439#
5440# description
5441#
5442# }
5443#
5444# }
5445# }
5446# Response:
5447# {
5448#
5449# "data": {
5450#
5451# "engineClasses": {
5452#
5453# "records": [
5454#
5455# {
5456#
5457# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5458#
5459# "name": "audio",
5460#
5461# "description": "The input to engines in the Audio class is an audio or video
5462# file or stream. If your engine processes human speech or voice, it likely
5463# belongs in the Speech class instead. Audio engines may recognize a specific
5464# audio segment, such as an advertisement, identify sounds like that of a crying
5465# baby or detect the presence of audio or music in an audio or video file, for
5466# example."
5467#
5468# },
5469#
5470# {
5471#
5472# "id": "1bcfdd35-1e9b-4694-8273-00b19510d164",
5473#
5474# "name": "biometrics",
5475#
5476# "description": "The input to engines in the Biometrics class may be an image,
5477# speech or other audio or video file or stream. By definition, the Biometrics
5478# class covers cognitive analysis related to data points from the human body.
5479# Biometrics engines may detect or recognize faces, identify face attributes to
5480# estimate a person's age or ethnicity or verify a person based on their unique
5481# iris, for example."
5482#
5483# }
5484#
5485# ]
5486#
5487# }
5488#
5489# }
5490# }
5491#
5492# Arguments
5493# id: Provide an ID to retrieve a single specific engine class.
5494# name: Provide a name, or part of one, to search by class name
5495# offset: Specify maximum number of results to retrieve in this
5496# result. Page size.
5497# limit: Specify maximum number of results to retrieve in this
5498# result.
5499engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
5500
5501# Retrieve a specific engine class
5502# Example:
5503# Request:
5504# query {
5505#
5506# engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") {
5507#
5508# id
5509#
5510# name
5511#
5512# description
5513#
5514# }
5515# }
5516# Response:
5517# {
5518#
5519# "data": {
5520#
5521# "engineClass": {
5522#
5523# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5524#
5525# "name": "audio",
5526#
5527# "description": "The input to engines in the Audio class is an audio or video
5528# file or stream. If your engine processes human speech or voice, it likely
5529# belongs in the Speech class instead. Audio engines may recognize a specific
5530# audio segment, such as an advertisement, identify sounds like that of a crying
5531# baby or detect the presence of audio or music in an audio or video file, for
5532# example."
5533#
5534# }
5535#
5536# }
5537# }
5538#
5539# Arguments
5540# id: Supply the ID of the engine class to retrieve
5541engineClass(id: ID!): EngineClass
5542
5543# Retrieve list entity tags where tag key contains user input
5544# Example:
5545# Request:
5546# query {
5547#
5548# matchEntityTags(input: { tagKey: "test"}) {
5549#
5550# records {
5551#
5552# tagKey
5553#
5554# tagValue
5555#
5556# }
5557#
5558# }
5559# }
5560# Response:
5561# {
5562#
5563# "data": {
5564#
5565# "matchEntityTags": {
5566#
5567# "records": [
5568#
5569# {
5570#
5571# "tagKey": "test-tag",
5572#
5573# "tagValue": "test-value"
5574#
5575# },
5576#
5577# {
5578#
5579# "tagKey": "another-testtag",
5580#
5581# "tagValue": ""
5582#
5583# },
5584#
5585# ]
5586#
5587# }
5588#
5589# }
5590# }
5591#
5592# Arguments
5593# input: User provided text and entity type input.
5594# offset: Specify maximum number of results to retrieve in this
5595# result. Page size.
5596# limit: Specify maximum number of results to retrieve in this
5597# result.
5598matchEntityTags(input: MatchEntityTagInput!, offset: Int, limit: Int): MatchedEntityTagsList
5599
5600# Returns all custom dashboards created by user
5601# Example:
5602# Request:
5603# query {
5604#
5605# customDashboards {
5606#
5607# records {
5608#
5609# id
5610#
5611# description
5612#
5613# hostAppId
5614#
5615# }
5616#
5617# }
5618# }
5619# Response:
5620# {
5621#
5622# "data": {
5623#
5624# "customDashboards": {
5625#
5626# "records": [
5627#
5628# {
5629#
5630# "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9",
5631#
5632# "description": "example",
5633#
5634# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f"
5635#
5636# }
5637#
5638# ]
5639#
5640# }
5641#
5642# }
5643# }
5644#
5645# Arguments
5646# offset: Provide an offset to skip to a certain element in the
5647# result, for paging.
5648# limit: Specify maximum number of results to retrieve in this
5649# result. Page size.
5650# hostAppId: Include only dashboards created by specific
5651# host_app_id
5652customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
5653
5654# Returns custom dashboard by id
5655# Example:
5656# Request:
5657# query {
5658#
5659# customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") {
5660#
5661# hostAppId
5662#
5663# name
5664#
5665# }
5666# }
5667# Response:
5668# {
5669#
5670# "data": {
5671#
5672# "customDashboard": {
5673#
5674# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f",
5675#
5676# "name": "example"
5677#
5678# }
5679#
5680# }
5681# }
5682customDashboard(id: ID!): CustomDashboard
5683
5684# Gets engine usage for an organization based on their billing type.
5685# Example:
5686# Request:
5687# query {
5688#
5689# getUsageByTaskType {
5690#
5691# totalDuration
5692#
5693# totalCost
5694#
5695# }
5696# }
5697# Response:
5698# {
5699#
5700# "data": {
5701#
5702# "getUsageByTaskType": {
5703#
5704# "totalDuration": 0,
5705#
5706# "totalCost": "0"
5707#
5708# }
5709#
5710# }
5711# }
5712getUsageByTaskType: UsageByTaskType!
5713
5714# Retrives the specific Dataset
5715#
5716# Arguments
5717# id: Supply the ID of the Dataset to retrieve
5718dataset(id: ID!): Dataset
5719
5720# Retrieve list of Datasets
5721# Example:
5722# Request:
5723# query {
5724#
5725# datasets(limit:2, filter: {operation:OR}) {
5726#
5727# records {
5728#
5729# datasetId
5730#
5731# name
5732#
5733# }
5734#
5735# }
5736# }
5737# Response:
5738# {
5739#
5740# "data": {
5741#
5742# "datasets": {
5743#
5744# "records": []
5745#
5746# }
5747#
5748# }
5749# }
5750#
5751# Arguments
5752# offset: Provide an offset to skip to a certain element in the
5753# result, for paging.
5754# limit: Specify maximum number of results to retrieve in this
5755# result. Page size.
5756# filter: Filters for Dataset attributes
5757datasets(offset: Int, limit: Int, filter: DatasetFilter): DatasetList
5758
5759# Arguments
5760# datasetId: Supply the ID of the Dataset to retrieve
5761# offset: Provide an offset to skip to a certain element in the
5762# result, for paging.
5763# limit: Specify maximum number of results to retrieve in this
5764# result. Page size.
5765# filter: Query to filter SDO. Supports operations such as and,
5766# or, eq, gt, lt, etc.
5767# TODO link to syntax documentation
5768# orderBy: Order by
5769datasetDataQuery(
5770datasetId: ID!,
5771offset: Int,
5772limit: Int,
5773filter: JSONData,
5774orderBy: [StructuredDataOrderBy!]
5775): DatasetEntryList!
5776
5777# Retrive list of Engine Replacement
5778# Example:
5779# Request:
5780# query {
5781#
5782# taskReplacementEngines {
5783#
5784# records {
5785#
5786# sourceEngineId
5787#
5788# replacementEngineId
5789#
5790# }
5791#
5792# }
5793# }
5794# Response:
5795# {
5796#
5797# "data": {
5798#
5799# "taskReplacementEngines": {
5800#
5801# "records": [
5802#
5803# {
5804#
5805# "sourceEngineId": "1",
5806#
5807# "replacementEngineId": "2"
5808#
5809# }
5810#
5811# ]
5812#
5813# }
5814#
5815# }
5816# }
5817#
5818# Arguments
5819# organizationId: Only superadmin can get engine replacement of
5820# other orgs
5821# engineId: Filter by the source engineId
5822# offset: Provide an offset to skip to a certain element in the
5823# result, for paging.
5824# limit: Specify maximum number of results to retrieve in this
5825# result. Page size.
5826taskReplacementEngines(
5827organizationId: ID,
5828engineId: ID,
5829offset: Int,
5830limit: Int
5831): TaskReplacementEngineList
5832
5833# Retrive Notification Mailboxes by list of mailboxIds
5834# Example:
5835# Request:
5836# query {
5837#
5838# notificationMailboxes {
5839#
5840# id
5841#
5842# name
5843#
5844# }
5845# }
5846# Response:
5847# {
5848#
5849# "data": {
5850#
5851# "notificationMailboxes": [
5852#
5853# {
5854#
5855# "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149",
5856#
5857# "name": "example"
5858#
5859# },
5860#
5861# {
5862#
5863# "id": "d20e9f37-a887-41bb-aed0-3268884ecebc",
5864#
5865# "name": "Library training mailbox"
5866#
5867# },
5868#
5869# {
5870#
5871# "id": "2d29533b-560e-4354-b794-84f823d33205",
5872#
5873# "name": "Library training mailbox"
5874#
5875# }
5876#
5877# ]
5878#
5879# }
5880# }
5881notificationMailboxes(ids: [ID!], name: String): [NotificationMailbox!]
5882
5883# Retrive Notification Templates
5884# Example:
5885# Request:
5886# query {
5887#
5888# notificationTemplates(limit: 2) {
5889#
5890# records {
5891#
5892# id
5893#
5894# eventName
5895#
5896# }
5897#
5898# }
5899# }
5900# Response:
5901# {
5902#
5903# "data": {
5904#
5905# "notificationTemplates": {
5906#
5907# "records": [
5908#
5909# {
5910#
5911# "id": "3947b833-2be4-4415-8272-2cee62fbca23",
5912#
5913# "eventName": "example"
5914#
5915# }
5916#
5917# ]
5918#
5919# }
5920#
5921# }
5922# }
5923#
5924# Arguments
5925# ids: Get by array of ids
5926# eventName: Get by eventName
5927# eventType: Get by eventType
5928# application: Get by application
5929# mailboxId: Get by mailboxId
5930# ownerOrganizationId: Only super-admin or orgless token can get
5931# templates by ownerOrganizationId
5932# offset: Provide an offset to skip to a certain element in the
5933# result, for paging.
5934# limit: Specify maximum number of results to retrieve in this
5935# result. Page size.
5936notificationTemplates(
5937ids: [ID],
5938eventName: String,
5939eventType: String,
5940application: String,
5941mailboxId: ID,
5942ownerOrganizationId: ID,
5943offset: Int,
5944limit: Int
5945): NotificationTemplateList
5946
5947# Retrieve Notification Actions
5948# Example:
5949# Request:
5950# query {
5951#
5952# notificationActions {
5953#
5954# records {
5955#
5956# id
5957#
5958# actionName
5959#
5960# }
5961#
5962# }
5963# }
5964# Response:
5965# {
5966#
5967# "data": {
5968#
5969# "notificationActions": {
5970#
5971# "records": [
5972#
5973# {
5974#
5975# "id": "866aad9c-9e68-4c33-b523-373bb332aea2",
5976#
5977# "actionName": "example"
5978#
5979# }
5980#
5981# ]
5982#
5983# }
5984#
5985# }
5986# }
5987#
5988# Arguments
5989# ids: Get by array of ids
5990# eventName: Get by eventName
5991# eventType: Get by eventType
5992# application: Get by application
5993# mailboxId: Get by mailboxId
5994# ownerOrganizationId: Only super-admin or orgless token can get
5995# templates by ownerOrganizationId
5996# offset: Provide an offset to skip to a certain element in the
5997# result, for paging.
5998# limit: Specify maximum number of results to retrieve in this
5999# result. Page size.
6000notificationActions(
6001ids: [ID],
6002eventName: String,
6003eventType: String,
6004application: String,
6005mailboxId: ID,
6006ownerOrganizationId: ID,
6007offset: Int,
6008limit: Int
6009): NotificationActionList
6010
6011# Retrieve Application user setting definitions
6012# Example:
6013# Request:
6014# query {
6015#
6016# getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") {
6017#
6018# key
6019#
6020# value
6021#
6022# }
6023# }
6024# Response:
6025# {
6026#
6027# "data": {
6028#
6029# "getUserSettingDefinitions": [
6030#
6031# {
6032#
6033# "key": "example",
6034#
6035# "value": "example"
6036#
6037# }
6038#
6039# ]
6040#
6041# }
6042# }
6043#
6044# Arguments
6045# application: Specify the applicationId
6046# key: Specify the key of user setting (optional)
6047# organizationGuid: Specify the organizationGuid (require for
6048# internal token)
6049# This can be specified by superadmin to get user setting definitions of other
6050# organization
6051getUserSettingDefinitions(
6052application: ID!,
6053key: String,
6054organizationGuid: ID
6055): [ApplicationSetting]
6056
6057# Retrive User setting
6058# Example:
6059# Request:
6060# query {
6061#
6062# getUserSettings {
6063#
6064# key
6065#
6066# applicationId
6067#
6068# }
6069# }
6070# Response:
6071# {
6072#
6073# "data": {
6074#
6075# "getUserSettings": [
6076#
6077# {
6078#
6079# "key": "example12",
6080#
6081# "applicationId": "80354999-d633-4595-9578-d82f59a5134f"
6082#
6083# }
6084#
6085# ]
6086#
6087# }
6088# }
6089#
6090# Arguments
6091# userId: Filter by userId (optional).
6092# If it's not specified, default is current user
6093# application: Filter by applicationId
6094# keys: Filter by keys
6095getUserSettings(userId: ID, application: ID, keys: [String]): [UserSetting]
6096
6097# Example:
6098# Request:
6099# query {
6100#
6101# staticAppConfig {
6102#
6103# loginUrl
6104#
6105# apiRoot
6106#
6107# }
6108# }
6109# Response:
6110# {
6111#
6112# "data": {
6113#
6114# "staticAppConfig": {
6115#
6116# "loginUrl": "https://login.veritone.com",
6117#
6118# "apiRoot": "https://api.veritone.com"
6119#
6120# }
6121#
6122# }
6123# }
6124staticAppConfig: StaticAppConfig!
6125
6126# Get OpenID Provider by id
6127openIdProvider(id: ID!): OpenIdProvider!
6128
6129# Get OpenID Provides
6130# Example:
6131# Request:
6132# query {
6133#
6134# openIdProviders {
6135#
6136# records {
6137#
6138# id
6139#
6140# isGlobal
6141#
6142# websiteUrl
6143#
6144# }
6145#
6146# }
6147# }
6148# Response:
6149# {
6150#
6151# "data": {
6152#
6153# "openIdProviders": {
6154#
6155# "records": []
6156#
6157# }
6158#
6159# }
6160# }
6161#
6162# Arguments
6163# orgId: Filter Providers by organizationId. This is only used by
6164# superadmin.
6165# If filter with org-admin role, orgId is always the current user org.
6166openIdProviders(
6167ids: [ID],
6168isGlobal: Boolean,
6169orgId: ID,
6170offset: Int,
6171limit: Int
6172): OpenIdProviderList
6173
6174# Arguments
6175# orgId: This returns all packages that the Organization has
6176# access to.
6177#
6178# ___Note: for Super-Admin use only.___
6179# resourceId: This returns packages that have the provided
6180# resource linked to it
6181# resourceAlias: This returns any packages have resources that
6182# have the alias.
6183# primaryResourceId: This returns packages that have the provided
6184# resource as its primary resource
6185# sourceOriginId: This returns the entire lineage of packages
6186# that share the same sourceOriginId.
6187#
6188# This UUID is used to track a package's lineage. This UUID and versions is NOT
6189# guaranteed to be a package ID and should not be used as such.
6190# sourcePackageId: This returns any packages that immediately
6191# derive from the provided ID.
6192#
6193# The sourcePackageId of a package refers to the package that it derived from, if
6194# any.
6195# For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0,
6196# and 4.0.
6197# If the ID of version 2.0 is provided, this filter will return the package
6198# information for
6199# only version 3.0. This is because version 3.0 is the immediate descendent of
6200# version 2.0.
6201# packageFilter: Fields to filter the results by.
6202# distributionType: This returns packages of a specific
6203# distribution type
6204# distributionTypes: This returns packages of a list of
6205# distribution types
6206# status: This returns packages with a specific status
6207# nameRegexp: Search by package name via regex pattern. By
6208# default, this search is _case sensitive_. To change this behavior,
6209# refer to the `packageFilter.caseSensitive` field.
6210# owned: If true, return only packages owned by the calling org.
6211#
6212# If false, return all packages that the calling org has access to.
6213#
6214# The default behavior when `owned` is not provided assumes `false`.
6215#
6216# __Note__: Superadmin tokens are authorized to change the `orgId` field. If
6217# provided, the above behavior will apply to `orgId` instead of the calling org.
6218# includeDeleted: If true, result includes deleted packages
6219# offset: Provide an offset to skip to a certain element in the
6220# result, for paging.
6221# limit: Specify maximum number of results to retrieve in this
6222# result. Page size.
6223packages(
6224id: ID,
6225ids: [ID!],
6226orgId: ID,
6227resourceId: ID,
6228resourceAlias: String,
6229primaryResourceId: ID,
6230sourceOriginId: ID,
6231sourcePackageId: ID,
6232packageFilter: PackageFilter,
6233distributionType: EngineDistributionType,
6234distributionTypes: [EngineDistributionType!],
6235status: PackageStatus,
6236nameRegexp: String,
6237owned: Boolean,
6238includeDeleted: Boolean,
6239offset: Int,
6240limit: Int,
6241orderBy: [PackageOrderBy!]
6242): PackageList
6243
6244# List existing package grants.
6245# Either packageId or organizationId must be specified.
6246#
6247# The following examples assume that the caller is the owner of the Packages:
6248# packageGrants(id: 123) - Show Grants for Package 123
6249# packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12
6250# packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12
6251#
6252# Arguments
6253# id: Package ID. If specified, show all the Grants for this
6254# Package.
6255#
6256# If calling Org is owner of the Package, show all Grants.
6257#
6258# If calling Org is not owner of the Package, only show Grants for the Package to
6259# the calling Org.
6260#
6261# If Super-Admin, show all Grants for the Package.
6262# orgId: Show all Grants to the specified Org.
6263#
6264# If the input organizationId is different from the calling Org, this will show
6265# Grants for Packages
6266# that are owned by the calling Org to the specified Org.
6267#
6268# If the input organizationId is the same as the caller's Org, this will show
6269# Grants for Packages
6270# to the calling Org.
6271#
6272# If Super-Admin, show Grants for all Packages to the specified Org.
6273# includeDeleted: If true, result includes deleted packages
6274# offset: Provide an offset to skip to a certain element in the
6275# result, for paging.
6276# limit: Specify maximum number of results to retrieve in this
6277# result. Page size.
6278packageGrants(
6279id: ID,
6280orgId: ID,
6281includeDeleted: Boolean,
6282offset: Int,
6283limit: Int,
6284packageFilter: PackageGrantFilter
6285): PackageGrantList
6286
6287# Retrieve the basic user information.
6288# The caller and the queried user are required to be members of the same
6289# organization,
6290# unless the caller is superadmin user.
6291# Example:
6292# Request:
6293# query {
6294#
6295# basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") {
6296#
6297# id
6298#
6299# name
6300#
6301# firstName
6302#
6303# lastName
6304#
6305# email
6306#
6307# imageUrl
6308#
6309# }
6310# }
6311# Response:
6312# {
6313#
6314# "data": {
6315#
6316# "basicUserInfo": {
6317#
6318# "id": "267de7e1-efb2-444a-a524-210328b78503",
6319#
6320# "name": "username",
6321#
6322# "firstName": "first",
6323#
6324# "lastName": "last",
6325#
6326# "email": "email@test.com",
6327#
6328# "imageUrl": null
6329#
6330# }
6331#
6332# }
6333# }
6334#
6335# Arguments
6336# id: The user ID.
6337# A user ID is a string in UUID format.
6338basicUserInfo(id: ID!): BasicUserInfo
6339
6340apiTokens: [ApiTokenInfo]!
6341
6342# Gets the most up to date package linked to this automate flow
6343#
6344# Arguments
6345# engineId: Engine Id for the automate flow.
6346automatePackage(engineId: ID!): Package
6347
6348# Retrieve applicationViewers
6349# Example:
6350# Request:
6351# query {
6352# applicationViewers(limit:2) {
6353# records{
6354# id
6355# name
6356# }
6357# }
6358# }
6359# Response:
6360# {
6361# "data": {
6362# "viewers": {
6363# "records": [
6364# {
6365# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6366# "name": "Viewer 1"
6367# },
6368# {
6369# "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c",
6370# "name": "Viewer 2"
6371# }
6372# ]
6373# }
6374# }
6375# }
6376#
6377# Arguments
6378# ids: Provide an ids to retrieve specific viewers.
6379# offset: Specify maximum number of results to retrieve in this
6380# result. Page size.
6381# limit: Specify maximum number of results to retrieve in this
6382# result.
6383# orderBy: Provide a list of ApplicationViewerSortField to sort
6384# by.
6385# isPublic: Filter viewers that are publicly accessible across
6386# all organizations.
6387applicationViewers(
6388ids: [ID!],
6389offset: Int,
6390limit: Int,
6391orderBy: ApplicationViewerSortField,
6392isPublic: Boolean
6393): ApplicationViewerList
6394
6395# Arguments
6396# encryptionKey: Key to decrypt the stored data.
6397# fromAddress: Credential id to look up in the database.
6398platformEmailProvider(
6399encryptionKey: String,
6400fromAddress: String
6401): EmailProviderConfig
6402
6403# Retrieve email template by id.
6404emailTemplateGet(id: ID!, organizationGuid: ID): EmailTemplate
6405
6406# Retrieve a single ingest slug by source ID and fileUri.
6407#
6408# An ingest slug is a record that tracks a file through the ingestion pipeline,
6409# containing metadata about the file and its processing status. Both sourceId and
6410# fileUri are required to uniquely identify a slug.
6411#
6412# Example:
6413# query {
6414#
6415# ingestSlug(sourceId: "100", fileUri: "s3://bucket/videos/sample.mp4") {
6416#
6417# sourceId
6418#
6419# fileUri
6420#
6421# organizationId
6422#
6423# status
6424#
6425# mimeType
6426#
6427# fileSizeBytes
6428#
6429# fileCreatedAt
6430#
6431# fileModifiedAt
6432#
6433# statusMessage
6434#
6435# tdoId
6436#
6437# assetId
6438#
6439# createdAt
6440#
6441# updatedAt
6442#
6443# createdBy
6444#
6445# }
6446# }
6447#
6448# Response:
6449# {
6450#
6451# "data": {
6452#
6453# "ingestSlug": {
6454#
6455# "sourceId": "100",
6456#
6457# "fileUri": "s3://bucket/videos/sample.mp4",
6458#
6459# "organizationId": "35521",
6460#
6461# "status": "ingested",
6462#
6463# "mimeType": "video/mp4",
6464#
6465# "fileSizeBytes": 2147483648,
6466#
6467# "fileCreatedAt": "2024-01-15T10:00:00Z",
6468#
6469# "fileModifiedAt": "2024-01-15T10:30:00Z",
6470#
6471# "statusMessage": "Successfully ingested",
6472#
6473# "tdoId": "1570654874",
6474#
6475# "assetId": "1570654874_4hJtNKSUXD",
6476#
6477# "createdAt": "2024-01-15T09:00:00Z",
6478#
6479# "updatedAt": "2024-01-15T12:00:00Z",
6480#
6481# "createdBy": "550e8400-e29b-41d4-a716-446655440000"
6482#
6483# }
6484#
6485# }
6486# }
6487ingestSlug(sourceId: ID!, fileUri: String!): IngestSlug!
6488
6489# Retrieve a list of ingest slugs with optional filtering and pagination.
6490#
6491# This query supports complex filtering on status, file URIs, time ranges, and
6492# other attributes.
6493# Results are paginated and sorted by createdAt ascending. Default offset is 0 and
6494# limit is 30.
6495# The results are automatically filtered to the user's organization from their
6496# authorization context.
6497#
6498# Filter supports:
6499# - sourceId/sourceIds: Filter by media source
6500# - status: Filter by ingestion status (pending, uploaded, ingested, failed, etc.)
6501# - fileUriExact: Match exact file URIs
6502# - fileUriPrefix: Match file URIs by prefix (case-insensitive)
6503# - bundleKey: Group files by bundle identifier
6504# - batchFileUri: Associated batch file URI
6505# - tdoId/assetId: Filter by associated temporal data object or asset
6506# - mimeType: Filter by file MIME type
6507# - updatedFromTime/updatedToTime: Filter by update time range
6508# - updatedFromTimeExclusive/updatedToTimeExclusive: Use exclusive comparison
6509# operators
6510#
6511# Example 1: Get all pending ingest slugs for a specific source:
6512# query {
6513#
6514# ingestSlugs(
6515#
6516# filter: {
6517#
6518# sourceId: "100"
6519#
6520# status: ["pending"]
6521#
6522# }
6523#
6524# offset: 0
6525#
6526# limit: 10
6527#
6528# ) {
6529#
6530# records {
6531#
6532# fileUri
6533#
6534# status
6535#
6536# statusMessage
6537#
6538# fileSizeBytes
6539#
6540# mimeType
6541#
6542# bundleKey
6543#
6544# }
6545#
6546# offset
6547#
6548# limit
6549#
6550# count
6551#
6552# }
6553# }
6554#
6555# Example 2: Search for files by URI prefix and filter by time range:
6556# query {
6557#
6558# ingestSlugs(
6559#
6560# filter: {
6561#
6562# fileUriPrefix: ["s3://bucket/archive/2024-01"]
6563#
6564# updatedFromTime: "2024-01-01T00:00:00Z"
6565#
6566# updatedToTime: "2024-01-31T23:59:59Z"
6567#
6568# status: ["ingested"]
6569#
6570# }
6571#
6572# offset: 0
6573#
6574# limit: 50
6575#
6576# ) {
6577#
6578# records {
6579#
6580# sourceId
6581#
6582# fileUri
6583#
6584# organizationId
6585#
6586# status
6587#
6588# tdoId
6589#
6590# assetId
6591#
6592# updatedAt
6593#
6594# }
6595#
6596# count
6597#
6598# }
6599# }
6600#
6601# Example 3: Get ingest slugs with TDO associations:
6602# query {
6603#
6604# ingestSlugs(
6605#
6606# filter: {
6607#
6608# status: ["ingested"]
6609#
6610# tdoId: ["1570654874"]
6611#
6612# }
6613#
6614# limit: 20
6615#
6616# ) {
6617#
6618# records {
6619#
6620# sourceId
6621#
6622# fileUri
6623#
6624# status
6625#
6626# tdoId
6627#
6628# assetId
6629#
6630# tdo {
6631#
6632# id
6633#
6634# name
6635#
6636# startDateTime
6637#
6638# }
6639#
6640# }
6641#
6642# }
6643# }
6644ingestSlugs(filter: IngestSlugFilter, offset: Int, limit: Int): IngestSlugList!
6645
6646# Retrieve a single processing project by ID.
6647processingProject(id: ID!): ProcessingProject
6648
6649# Retrieve a list of processing projects with filtering and pagination.
6650processingProjects(
6651offset: Int,
6652limit: Int,
6653filter: ProcessingProjectFilter
6654): ProcessingProjectList
6655
6656# Retrieve a single processing deliverable by ID.
6657processingDeliverable(project_id: ID!, id: ID!): ProcessingDeliverable
6658
6659# Retrieve a list of processing deliverables with filtering and pagination.
6660processingDeliverables(
6661projectId: ID!,
6662offset: Int,
6663limit: Int,
6664filter: ProcessingDeliverableFilter
6665): ProcessingDeliverableList
6666
6667}

link Required by

This element is not required by anyone