OBJECT

Mutation

Mutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.

link GraphQL Schema definition

1type Mutation {
2
3# Create a new temporal data object
4# Example:
5# Request:
6# mutation {
7#
8# createTDO(input: {
9#
10# startDateTime: 1623253937,
11#
12# stopDateTime: 1623259000,
13#
14# source: "123",
15#
16# name: "example",
17#
18# description: "example",
19#
20# isPublic: false,
21#
22# applicationId: "123"}) {
23#
24# id
25#
26# name
27#
28# }
29# }
30# Response:
31# {
32#
33# "data": {
34#
35# "createTDO": {
36#
37# "id": "1570654874",
38#
39# "name": "example"
40#
41# }
42#
43# }
44# }
45#
46# Arguments
47# input: Fields required to create a TDO
48createTDO(input: CreateTDO): TemporalDataObject
49
50# Update a temporal data object
51# Example:
52# Request:
53# mutation {
54#
55# updateTDO(input:{
56#
57# id: "1570654874",
58#
59# status: "example",
60#
61# name: "example"}) {
62#
63# id
64#
65# name
66#
67# description
68#
69# }
70# }
71# Result:
72# {
73#
74# "data": {
75#
76# "updateTDO": {
77#
78# "id": "1570654874",
79#
80# "name": "example",
81#
82# "description": null
83#
84# }
85#
86# }
87# }
88#
89# Arguments
90# input: Fields required to update a TDO
91updateTDO(input: UpdateTDO): TemporalDataObject
92
93# Delete a temporal data object. The TDO metadata, its assets and
94# all storage objects, and search index data are deleted.
95# Engine results stored in related task objects are not.
96# cleanupTDO can be used to selectively delete certain data on the TDO.
97# Example:
98# Request:
99# mutation {
100#
101# deleteTDO(
102#
103# id: "1570654874") {
104#
105# id
106#
107# message
108#
109# }
110# }
111# Response:
112#
113# {
114#
115# "data": {
116#
117# "deleteTDO": {
118#
119# "id": "1570654874",
120#
121# "message": "TemporalDataObject 1570654874 and all associated asset content was
122# deleted."
123#
124# }
125#
126# }
127# }
128#
129# Arguments
130# id: Supply the ID of the TDO to delete
131deleteTDO(id: ID!): DeletePayload
132
133# Delete partial information from a temporal data object.
134# Use the delete options to control exactly which data is deleted.
135# The default is to delete objects from storage and the search index,
136# while leaving TDO-level metadata and task engine results intact.
137# To permanently delete the TDO, use delete TDO.
138# Example:
139# Request:
140# mutation {
141#
142# cleanupTDO(
143#
144# id: "1570705980") {
145#
146# id
147#
148# message
149#
150# }
151# }
152# Response:
153# {
154#
155# "data": {
156#
157# "cleanupTDO": {
158#
159# "id": "1570705980",
160#
161# "message": null
162#
163# }
164#
165# }
166# }
167#
168# Arguments
169# id: Supply the ID of the TDO to clean up.
170# options: Supply a list of cleanup options. See TDOCleanupOption
171# for details. If not provided, the server will use default settings.
172cleanupTDO(id: ID!, options: [TDOCleanupOption!]): DeletePayload
173
174# Create a task log by using
175# multipart form POST.
176#
177# Arguments
178# input: Fields needed to create a task log.
179createTaskLog(input: CreateTaskLog!): TaskLog
180
181# Create a media asset. Optionally, upload content using
182# multipart form POST.
183# example:
184# Request:
185# mutation {
186#
187# createAsset(input: {
188#
189# containerId: "1570654874",
190#
191# contentType: "application/json",
192#
193# description: "example",
194#
195# file: null,
196#
197# assetType: "text",
198#
199# uri: "example"
200#
201# name: "example"}) {
202#
203# id
204#
205# name
206#
207# description
208#
209# }
210# }
211# Response:
212# {
213#
214# "data": {
215#
216# "createAsset": {
217#
218# "id": "1570654874_4hJtNKSUXD",
219#
220# "name": "example",
221#
222# "description": "example"
223#
224# }
225#
226# }
227# }
228#
229# Arguments
230# input: Fields needed to create an asset.
231createAsset(input: CreateAsset!): Asset
232
233# Delete an asset
234# Example:
235# Request:
236# mutation {
237#
238# deleteAsset(
239#
240# id: "1570705980_w4ZLCPU7Dk") {
241#
242# id
243#
244# message
245#
246# }
247# }
248# Response:
249# {
250#
251# "data": {
252#
253# "deleteAsset": {
254#
255# "id": "1570705980_w4ZLCPU7Dk",
256#
257# "message": "No storage objects deleted for example"
258#
259# }
260#
261# }
262# }
263#
264# Arguments
265# id: Provide the ID of the asset to delete.
266deleteAsset(id: ID!): DeletePayload
267
268# Update an asset
269# Example:
270# Request:
271# mutation {
272#
273# updateAsset(input: {
274#
275# id: "1570705980_w4ZLCPU7Dk",
276#
277# description: "example",
278#
279# name: "example",
280#
281# fileData: null,
282#
283# sourceData: null,
284#
285# details: null}) {
286#
287# id
288#
289# name
290#
291# contentType
292#
293# }
294# }
295# Result:
296# {
297#
298# "data": {
299#
300# "updateAsset": {
301#
302# "id": "1570705980_w4ZLCPU7Dk",
303#
304# "name": "example",
305#
306# "contentType": "application/json"
307#
308# }
309#
310# }
311# }
312#
313# Arguments
314# input: Fields needed to update an asset.
315updateAsset(input: UpdateAsset!): Asset
316
317# Add a single media segment to a TemporalDataObject.
318# This mutation will update the manifest asset (`media-mdp`)
319# for the TemporalDataObject.
320# Example:
321# Request:
322# mutation {
323#
324# addMediaSegment(input: {
325#
326# containerId: "1570705980",
327#
328# details: [],
329#
330# url:
331# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg",
332#
333# segmentGroupId: "123"}) {
334#
335# id
336#
337# name
338#
339# createdBy
340#
341# }
342# }
343# Response:
344# {
345#
346# "data": {
347#
348# "addMediaSegment": {
349#
350# "id": "1570705980",
351#
352# "name": "example",
353#
354# "createdBy": null
355#
356# }
357#
358# }
359# }
360#
361# Arguments
362# input: Fields necesary to create the segment.
363addMediaSegment(input: AddMediaSegment!): TemporalDataObject!
364
365# Add a media segments to a TemporalDataObject.
366# This mutation will update the manifest asset (`media-mdp`)
367# for the TemporalDataObject.
368# Example:
369# Request:
370# mutation {
371#
372# addMediaSegments(
373#
374# containerId: "1570705980",
375#
376# segments: [
377#
378# {
379#
380# details: [],
381#
382# url:
383# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg",
384#
385# },
386#
387# {
388#
389# details: [],
390#
391# url:
392# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
393#
394# }
395#
396# ]
397#
398# segmentGroupId: "123") {
399#
400# id
401#
402# name
403#
404#
405# }
406# }
407# Response:
408# {
409#
410# "data": {
411#
412# "addMediaSegments": {
413#
414# "id": "1570705980",
415#
416# "name": "example"
417#
418# }
419#
420# }
421# }
422#
423# Arguments
424# containerId: ID of the TemporalDataObject container for the
425# segment
426# segments: Fields necesary to create the segment.
427# segmentGroupId: ID of the segment group (Optional)
428addMediaSegments(
429containerId: ID!,
430segments: [AddMediaSegments]!,
431segmentGroupId: ID
432): TemporalDataObject!
433
434# Start a clone job. A clone creates a new TDO
435# that links back to an existing TDO's assets
436# instead of creating new ones and is used
437# primarily to handle sample media.
438# Only for internal platform components.
439# Example:
440# Request:
441# mutation {
442#
443# requestClone(input: {
444#
445# sourceApplicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a",
446#
447# destinationApplicationId:"5908703b-51b4-4291-9787-b54bada73b0a",
448#
449# cloneBlobs: true}) {
450#
451# id
452#
453# status
454#
455# }
456# }
457# Response:
458# {
459#
460# "data": {
461#
462# "requestClone": null
463#
464# }
465# }
466#
467# Arguments
468# input: Fields needed to request a new clone job.
469requestClone(input: RequestClone): CloneRequest
470
471# Create a new automate flow. An automate flow is an engine
472# with extra metadata to work in the automate environment.
473# This endpoint will return an engineId that can be used to open
474# the flow in automate.
475# Example:
476# Request:
477# mutation {
478#
479# createAutomateFlow(input: {
480#
481# linkedApplicationId: "123",
482#
483# templateId: "36"
484#
485# }
486# }
487# Response:
488# {
489#
490# "data": {
491#
492# "createAutomateFlow": {
493#
494# "engineId": "567",
495#
496# "build": {
497#
498# "engineId": 567
499#
500# }
501#
502# }
503#
504# }
505# }
506#
507# Arguments
508# input: Fields needed to create a new automate flow
509createAutomateFlow(input: AutomateFlowInput): AutomateRunConfig
510
511# Create a new engine. The engine will need to go
512# through a sequence of workflow steps before
513# use in production. See VDA documentation for details.
514# Example:
515# Request:
516# mutation {
517#
518# createEngine(input: {
519#
520# id: "123",
521#
522# name: "example",
523#
524# categoryId: "581dbb32-ea5b-4458-bd15-8094942345e3",
525#
526# deploymentModel: FullyNetworkIsolated
527#
528# useCases: [],
529#
530# industries: []}) {
531#
532# id
533#
534# ownerOrganizationId
535#
536# }
537# }
538# Response:
539# {
540#
541# "data": {
542#
543# "createEngine": {
544#
545# "id": "123",
546#
547# "ownerOrganizationId": "35521"
548#
549# }
550#
551# }
552# }
553#
554# Arguments
555# input: Fields needed to create a new engine
556createEngine(input: CreateEngine): Engine
557
558# Update an engine. Engines are subject to specific
559# workflow steps. An engine's state determines what
560# updates can be made to it. See VDA documentation for
561# details.
562# Example:
563# Request:
564# mutation {
565#
566# updateEngine(input: {
567#
568# id:"123",
569#
570# isPublic: false,
571#
572# name: "example",
573#
574# deploymentModel: FullyNetworkIsolated,
575#
576# price: 1}) {
577#
578# id
579#
580# ownerOrganizationId
581#
582# name
583#
584# price
585#
586# }
587# }
588# Response:
589# {
590#
591# "data": {
592#
593# "updateEngine": {
594#
595# "id": "123",
596#
597# "ownerOrganizationId": "35521",
598#
599# "name": "example",
600#
601# "price": 1
602#
603# }
604#
605# }
606# }
607#
608# Arguments
609# input: Fields needed to update an engine
610updateEngine(input: UpdateEngine): Engine
611
612# Delete an engine
613# Example:
614# Request:
615# mutation {
616#
617# deleteEngine(
618#
619# id: "123") {
620#
621# id
622#
623# message
624#
625# }
626# }
627# Response:
628# {
629#
630# "data": {
631#
632# "deleteEngine": {
633#
634# "id": "123",
635#
636# "message": "engine 123 deleted"
637#
638# }
639#
640# }
641# }
642#
643# Arguments
644# id: Provide the ID of the engine to delete
645deleteEngine(id: ID!): DeletePayload
646
647# Create an engine build.
648# Example:
649# Request:
650#
651# mutation {
652#
653# createEngineBuild(input: {
654#
655# engineId: "1",
656#
657# taskRuntime: [],
658#
659# dockerImage: "build",
660#
661# manifest: [] }) {
662#
663# id
664#
665# name
666#
667# engineId
668#
669# }
670#
671# realeaseNotes: "Includes feature x..."
672#
673# }
674#
675# }
676# Response:
677# {
678#
679# "data": {
680#
681# "createEngineBuild": {
682#
683# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
684#
685# "name": "example Version 1",
686#
687# "engineId": "1",
688#
689# "releaseNotes": "Includes feature x..."
690#
691# }
692#
693# }
694# }
695#
696# Arguments
697# input: Fields needed to create an engine build.
698createEngineBuild(input: CreateBuild!): Build
699
700# Update an engine build. Engine builds are subject to
701# specific workflow steps. A build's state determines what
702# updates can be made to it. See VDA documentation for details.
703# Example:
704# Request:
705# mutation {
706#
707# updateEngineBuild(input: {
708#
709# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
710#
711# engineId: "1",
712#
713# action: update,
714#
715# taskRuntime: []}) {
716#
717# id
718#
719# name
720#
721# }
722#
723# releaseNotes: "Includes feature x..."
724#
725# }
726# }
727# Response:
728# {
729#
730# "data": {
731#
732# "updateEngineBuild": {
733#
734# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
735#
736# "name": "example Version 3"
737#
738# "releaseNotes": "Includes feature x..."
739#
740# }
741#
742# }
743# }
744#
745# Arguments
746# input: Fields needed to update an engine build.
747updateEngineBuild(input: UpdateBuild!): Build
748
749# Delete an engine build
750# Example:
751# Request:
752# mutation {
753#
754# deleteEngineBuild(input: {
755#
756# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
757#
758# engineId: "1"}) {
759#
760# id
761#
762# message
763#
764# }
765# }
766# Response:
767# {
768#
769# "data": {
770#
771# "deleteEngineBuild": {
772#
773# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
774#
775# "message": "Engine build 6f766576-03a9-42c4-8a96-f4cd932e7c6c deleted"
776#
777# }
778#
779# }
780# }
781#
782# Arguments
783# input: Fields needed to delete an engine build.
784deleteEngineBuild(input: DeleteBuild!): DeletePayload
785
786# Update a task
787#
788# Arguments
789# input: Fields required to update a task.
790updateTask(input: UpdateTask): Task
791
792# Arguments
793# reason: Short string describing the warning
794# message: Optional: the actual problem
795# referenceId: Optional: Reference ID for the warning, such as
796# assetId, or sourceId
797appendWarningToTask(
798taskId: ID,
799reason: String!,
800message: String,
801referenceId: ID
802): ID
803
804addTasksToJobs(input: AddTasksToJobs): AddTasksToJobsResponse
805
806# Create a job
807#
808# Arguments
809# input: Fields required to create a job.
810createJob(input: CreateJob): Job
811
812# Cancel a job. This action effectively deletes the job,
813# although a records of job and task execution remains in
814# Veritone's database.
815#
816# Arguments
817# id: Supply the ID of the job to delete.
818cancelJob(id: ID!): DeletePayload
819
820# Retry a job. This action applies only to jobs
821# that are in a failure state. The task sequence
822# for the job will be restarted in its original
823# configuration.
824#
825# Arguments
826# id: Supply the ID of the job to retry.
827retryJob(id: ID!): Job
828
829# Create and launch a job executing a single engine,
830# using the default engine DAG definition modified with the
831# supplied field values
832launchSingleEngineJob(input: SingleEngineJobInput!): Job
833
834updateJobs(input: UpdateJobs!): JobList
835
836# This creates a config definition for an application
837applicationConfigDefinitionCreate(
838input: [ApplicationConfigDefinitionCreate]
839): ApplicationConfigDefinitionList
840
841# This updates an existing config definition for an application
842applicationConfigDefinitionUpdate(
843input: [ApplicationConfigDefinitionUpdateInput]
844): ApplicationConfigDefinitionList
845
846# This removes an existing config definition from an application
847applicationConfigDefinitionDelete(
848input: ApplicationConfigDefinitionDelete
849): OperationResult
850
851# This sets configs for an app/org/user
852applicationConfigSet(
853input: ApplicationConfigSetConfigInput
854): ApplicationConfigList
855
856# This removes configs for an app/org/user
857applicationConfigDelete(input: ApplicationConfigDelete): OperationResult
858
859# This adds an application to an organization.
860#
861# Arguments
862# orgId: OrgID
863# appId: AppID
864# configs: Pass in configs
865applicationAddToOrg(
866orgId: ID!,
867appId: ID!,
868configs: [ApplicationConfigInput!]
869): Application!
870
871# This removes an application from an organization
872applicationRemoveFromOrg(
873orgId: ID!,
874appId: ID!,
875userId: ID,
876clearConfigs: Boolean
877): OperationResult
878
879# Create a new application. An application must
880# go through a sequence of workflow steps before
881# it is available in production. See the VDA documentation
882# for details.
883# Example:
884# Request:
885# mutation {
886#
887# createApplication(input: {
888#
889# name: "example123",
890#
891# key: "example123",
892#
893# category: "example",
894#
895# url: "www.veritone.com",
896#
897# checkPermissions: true}) {
898#
899# id
900#
901# name
902#
903# }
904# }
905# Response:
906# {
907#
908# "data": {
909#
910# "createApplication": {
911#
912# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
913#
914# "name": "example123"
915#
916# }
917#
918# }
919# }
920#
921# Arguments
922# input: Fields needed to create a new custom application.
923createApplication(input: CreateApplication): Application
924
925# Delete an application
926# Example:
927# Request:
928# mutation {
929#
930# deleteApplication(
931#
932# id: "7e863365-94de-4ac9-8826-df1a398c9a21") {
933#
934# id
935#
936# message
937#
938# }
939# }
940# Response:
941# {
942#
943# "data": {
944#
945# "deleteApplication": {
946#
947# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
948#
949# "message": null
950#
951# }
952#
953# }
954# }
955#
956# Arguments
957# id: Supply the ID of the application to delete.
958deleteApplication(id: ID!): DeletePayload
959
960# Update a custom application. Applications are subject to
961# specific workflows. The current application state determines
962# what updates can be made to it. See VDA documentation for details.
963# Example:
964# Request:
965# mutation {
966#
967# updateApplication(input: {
968#
969# name: "example123",
970#
971# id: "7e863365-94de-4ac9-8826-df1a398c9a21"
972#
973# category: "example",
974#
975# url: "www.veritone.com",
976#
977# checkPermissions: true,
978#
979# oauth2RedirectUrls: [],
980#
981# permissionsRequired: []}) {
982#
983# id
984#
985# name
986#
987# url
988#
989# }
990# }
991# Response:
992# {
993#
994# "data": {
995#
996# "updateApplication": {
997#
998# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
999#
1000# "name": "example123",
1001#
1002# "url": "www.veritone.com"
1003#
1004# }
1005#
1006# }
1007# }
1008#
1009# Arguments
1010# input: Fields required to update a custom application.
1011updateApplication(input: UpdateApplication): Application
1012
1013# Update an application by adding or removing components
1014# Example:
1015# Request:
1016# mutation {
1017#
1018# updateApplicationComponent(input: {
1019#
1020# id: "5908703b-51b4-4291-9787-b54bada73b0a",
1021#
1022# componentIds: ["1"],
1023#
1024# type: engines,
1025#
1026# action: add}) {
1027#
1028# engines{
1029#
1030# records{
1031#
1032# id
1033#
1034# }
1035#
1036# }
1037#
1038# }
1039# }
1040# Response:
1041# {
1042#
1043# "data": {
1044#
1045# "updateApplicationComponent": {
1046#
1047# "engines": {
1048#
1049# "records": [
1050#
1051# {
1052#
1053# "id": "1"
1054#
1055# }
1056#
1057# ]
1058#
1059# }
1060#
1061# }
1062#
1063# }
1064# }
1065updateApplicationComponent(
1066input: UpdateApplicationComponent!
1067): ApplicationComponent!
1068
1069# Update an application's billing plan id for an organization.
1070# Example:
1071# Request:
1072# mutation {
1073#
1074# updateApplicationBillingPlanId(
1075#
1076# applicationId:"32babe30-fb42-11e4-89bc-27b69865858a",
1077#
1078# organizationId: "35521",
1079#
1080# billingPlanId: "123") {
1081#
1082# applicationId
1083#
1084# billingDirty
1085#
1086# }
1087# }
1088# Response:
1089# {
1090#
1091# "data": {
1092#
1093# "updateApplicationBillingPlanId": {
1094#
1095# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1096#
1097# "billingDirty": true
1098#
1099# }
1100#
1101# }
1102# }
1103updateApplicationBillingPlanId(
1104applicationId: ID!,
1105organizationId: ID!,
1106billingPlanId: String!
1107): ApplicationBillingPlanId!
1108
1109# Update an application's billing dirty for an organization.
1110# Example:
1111# Request:
1112# mutation {
1113#
1114# updateApplicationBillingDirty(
1115#
1116# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a",
1117#
1118# organizationId: "35521",
1119#
1120# billingDirty: false) {
1121#
1122# applicationId
1123#
1124# billingDirty
1125#
1126# }
1127# }
1128# Response:
1129# {
1130#
1131# "data": {
1132#
1133# "updateApplicationBillingDirty": {
1134#
1135# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1136#
1137# "billingDirty": false
1138#
1139# }
1140#
1141# }
1142# }
1143updateApplicationBillingDirty(
1144applicationId: ID!,
1145organizationId: ID!,
1146billingDirty: Boolean!
1147): ApplicationBillingDirty!
1148
1149# Bulk delete context menu extensions.
1150# Example:
1151# Request:
1152# mutation {
1153#
1154# bulkDeleteContextMenuExtensions(input: {
1155#
1156# ids: []}) {
1157#
1158# mentions{
1159#
1160# id
1161#
1162# }
1163#
1164# }
1165# }
1166# Response:
1167# {
1168#
1169# "data": {
1170#
1171# "bulkDeleteContextMenuExtensions": {
1172#
1173# "mentions": []
1174#
1175# }
1176#
1177# }
1178# }
1179fileApplication(input: FileApplication!): Application
1180
1181unfileApplication(input: UnfileApplication!): Application
1182
1183bulkDeleteContextMenuExtensions(
1184input: BulkDeleteContextMenuExtensions
1185): ContextMenuExtensionList
1186
1187# Update an organization
1188# Example:
1189# Request:
1190# mutation {
1191#
1192# updateOrganization(input: {
1193#
1194# id: "35521",
1195#
1196# indexTDOsByDefault: true}) {
1197#
1198# id
1199#
1200# status
1201#
1202# }
1203# }
1204# Response:
1205# {
1206#
1207# "data": {
1208#
1209# "updateOrganization": {
1210#
1211# "id": "35521",
1212#
1213# "status": "active"
1214#
1215# }
1216#
1217# }
1218# }
1219#
1220# Arguments
1221# input: Fields required to update an organization.
1222updateOrganization(input: UpdateOrganization!): Organization
1223
1224# Update organization billing policy. Requires superadmin
1225#
1226# Arguments
1227# planId: External billing plan id.
1228# targetOrganizationId: Optional organization id, to use when the
1229# caller is a superadmin from a different org
1230updateOrganizationBilling(
1231planId: String!,
1232targetOrganizationId: ID
1233): OrganizationBilling
1234
1235addToEngineWhitelist(toAdd: SetEngineWhitelist!): EngineWhitelist
1236
1237addToEngineBlacklist(toAdd: SetEngineBlacklist!): EngineBlacklist
1238
1239deleteFromEngineBlacklist(
1240toDelete: SetEngineBlacklist!
1241): EngineBlacklist
1242
1243deleteFromEngineWhitelist(
1244toDelete: SetEngineBlacklist!
1245): EngineWhitelist
1246
1247# Create an entity identifier type, such as "face" or "image".
1248# Entity identifier types are typically created or modified
1249# only by Veritone engineering. Most libraries and
1250# entities will use existing entity identifier types.
1251# Example:
1252# Request:
1253# mutation {
1254#
1255# createEntityIdentifierType(input: {
1256#
1257# label: "example"
1258#
1259# labelPlural: "example"
1260#
1261# iconClass: null
1262#
1263# description: "example"
1264#
1265# dataType: text
1266#
1267# id: "123"}) {
1268#
1269# id
1270#
1271# description
1272#
1273# }
1274# }
1275# Response:
1276# {
1277#
1278# "data": {
1279#
1280# "createEntityIdentifierType": {
1281#
1282# "id": "123",
1283#
1284# "description": null
1285#
1286# }
1287#
1288# }
1289# }
1290#
1291# Arguments
1292# input: Fields required to create an entity identifier type.
1293createEntityIdentifierType(
1294input: CreateEntityIdentifierType!
1295): EntityIdentifierType
1296
1297# Update an entity identifier type.
1298# Example:
1299# Request:
1300# mutation {
1301#
1302# updateEntityIdentifierType(input: {
1303#
1304# id: "123",
1305#
1306# label: "example",
1307#
1308# labelPlural: "example"
1309#
1310# description: "new description",
1311#
1312# dataType: image}) {
1313#
1314# id
1315#
1316# description
1317#
1318# }
1319# }
1320# Response:
1321# {
1322#
1323# "data": {
1324#
1325# "updateEntityIdentifierType": null
1326#
1327# }
1328# }
1329#
1330# Arguments
1331# input: Fields required to update an entity identifier type.
1332updateEntityIdentifierType(
1333input: UpdateEntityIdentifierType!
1334): EntityIdentifierType
1335
1336# Create a library type, such as "ad" or "people".
1337# Entity identifier types are typically created or modified
1338# only by Veritone engineering. Most libraries
1339# will use existing entity identifier types.
1340# Example:
1341# Request:
1342# mutation {
1343#
1344# createLibraryType(input: {
1345#
1346# id: "123",
1347#
1348# label: "example",
1349#
1350# entityIdentifierTypeIds: ["123"],
1351#
1352# entityType: {
1353#
1354# name: "example",
1355#
1356# namePlural: "example",
1357#
1358# schema: {
1359#
1360# example: "example" }}}) {
1361#
1362# id
1363#
1364# label
1365#
1366# }
1367# }
1368# Response:
1369# {
1370#
1371# "data": {
1372#
1373# "createLibraryType": {
1374#
1375# "id": "123",
1376#
1377# "label": "example"
1378#
1379# }
1380#
1381# }
1382# }
1383#
1384# Arguments
1385# input: Fields needed to create a new library type.
1386createLibraryType(input: CreateLibraryType!): LibraryType
1387
1388# Update a library type.
1389# Example:
1390# Request:
1391# mutation {
1392#
1393# updateLibraryType(input: {
1394#
1395# id: "123",
1396#
1397# label: "example",
1398#
1399# entityIdentifierTypeIds: ["123"],
1400#
1401# entityType: {
1402#
1403# name: "example",
1404#
1405# namePlural: "example",
1406#
1407# schema: {
1408#
1409# example: "new example" }}}) {
1410#
1411# id
1412#
1413# label
1414#
1415# }
1416# }
1417# Response:
1418# {
1419#
1420# "data": {
1421#
1422# "updateLibraryType": null
1423#
1424# }
1425# }
1426#
1427# Arguments
1428# input: Fields needed to update a library type.
1429updateLibraryType(input: UpdateLibraryType!): LibraryType
1430
1431# Create a new library.
1432# Once the library is created, the client can add
1433# entities and entity identifiers. Note that the
1434# library type determines what types of entity identifiers
1435# can be used within the library.
1436# Example:
1437# Request:
1438# mutation {
1439#
1440# createLibrary(input: {
1441#
1442# name: "example"
1443#
1444# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a"
1445#
1446# organizationId: "35521"
1447#
1448# libraryTypeId: "123"
1449#
1450# coverImageUrl:
1451# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1452#
1453# description: "example"}) {
1454#
1455# id
1456#
1457# name
1458#
1459# }
1460# }
1461# Response:
1462# {
1463#
1464# "data": {
1465#
1466# "createLibrary": {
1467#
1468# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1469#
1470# "name": "example"
1471#
1472# }
1473#
1474# }
1475# }
1476#
1477# Arguments
1478# input: Fields needed to create a new library.
1479createLibrary(input: CreateLibrary!): Library
1480
1481# Update an existing library.
1482# Example:
1483# Request:
1484# mutation {
1485#
1486# updateLibrary(input: {
1487#
1488# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1489#
1490# name: "example"
1491#
1492# coverImageUrl:
1493# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1494#
1495# description: "new description"
1496#
1497# libraryTypeId: "123"
1498#
1499# version: 2}) {
1500#
1501# id
1502#
1503# name
1504#
1505# description
1506#
1507# }
1508# }
1509# Response:
1510# {
1511#
1512# "data": {
1513#
1514# "updateLibrary": {
1515#
1516# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1517#
1518# "name": "example",
1519#
1520# "description": "new description"
1521#
1522# }
1523#
1524# }
1525# }
1526#
1527# Arguments
1528# input: Fields needed to update a library
1529updateLibrary(input: UpdateLibrary!): Library
1530
1531# Delete a library. This mutation will also delete all entities,
1532# entity identifiers, library engine models, and associated objects.
1533# Example:
1534# Request:
1535# mutation {
1536#
1537# deleteLibrary(id:"d232c90f-ae47-4125-b884-0d35fbed7e5f") {
1538#
1539# message
1540#
1541# }
1542# }
1543# Response:
1544# {
1545#
1546# "data": {
1547#
1548# "deleteLibrary": {
1549#
1550# "message": "d232c90f-ae47-4125-b884-0d35fbed7e5f deleted"
1551#
1552# }
1553#
1554# }
1555# }
1556#
1557# Arguments
1558# id: Provide the ID of the library to delete.
1559deleteLibrary(id: ID!): DeletePayload
1560
1561# Publish a new version of a library.
1562# Increments library version by one and trains compatible engines.
1563# Example:
1564# Request:
1565# mutation {
1566#
1567# publishLibrary(
1568#
1569# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1570#
1571# name
1572#
1573# description
1574#
1575# version
1576#
1577# }
1578# }
1579# Response:
1580# {
1581#
1582# "data": {
1583#
1584# "publishLibrary": {
1585#
1586# "name": "example",
1587#
1588# "description": "new description",
1589#
1590# "version": 2
1591#
1592# }
1593#
1594# }
1595# }
1596#
1597# Arguments
1598# id: ID of the library to publish
1599publishLibrary(id: ID!): Library
1600
1601# Create a new entity.
1602# Example:
1603# Request:
1604# mutation {
1605#
1606# createEntity(input: {
1607#
1608# name: "example",
1609#
1610# description: "example",
1611#
1612# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1613#
1614# jsondata: {
1615#
1616# example: "new example" }}) {
1617#
1618# id
1619#
1620# name
1621#
1622# }
1623# }
1624# Response:
1625# {
1626#
1627# "data": {
1628#
1629# "createEntity": {
1630#
1631# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1632#
1633# "name": "example"
1634#
1635# }
1636#
1637# }
1638# }
1639#
1640# Arguments
1641# input: Fields required to create a new entity.
1642createEntity(input: CreateEntity!): Entity
1643
1644# Update an entity.
1645# Example:
1646# Request:
1647# mutation {
1648#
1649# updateEntity(input: {
1650#
1651# id: "85b700fa-f327-4fea-b94b-ed83054170db",
1652#
1653# name: "example",
1654#
1655# description: "example",
1656#
1657# jsondata: {
1658#
1659# example: "updated example" }}) {
1660#
1661# id
1662#
1663# name
1664#
1665# jsondata
1666#
1667# }
1668# }
1669# Response:
1670# {
1671#
1672# "data": {
1673#
1674# "updateEntity": {
1675#
1676# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1677#
1678# "name": "example",
1679#
1680# "jsondata": {
1681#
1682# "example": "updated example"
1683#
1684# }
1685#
1686# }
1687#
1688# }
1689# }
1690#
1691# Arguments
1692# input: Fields required to update an entity.
1693updateEntity(input: UpdateEntity!): Entity
1694
1695# Delete an entity. This mutation will also delete all associated
1696# entity identifiers and associated objects.
1697# Example:
1698# Request:
1699# mutation {
1700#
1701# deleteEntity(id: "522bc6cf-5b7c-47bd-bd30-10cd77016a49") {
1702#
1703# message
1704#
1705# }
1706# }
1707# Response:
1708# {
1709#
1710# "data": {
1711#
1712# "deleteEntity": {
1713#
1714# "message": "Entity 522bc6cf-5b7c-47bd-bd30-10cd77016a49 deleted."
1715#
1716# }
1717#
1718# }
1719# }
1720#
1721# Arguments
1722# id: Supply the ID of the entity to delete.
1723deleteEntity(id: ID!): DeletePayload
1724
1725# Create an entity identifier.
1726# This mutation accepts file uploads. To use this mutation and upload a file,
1727# send a multipart form POST containing two parameters: `query`, with the
1728# GraphQL query, and `file` containing the file itself.
1729# For more information see the documentation at
1730# https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL.
1731# Example:
1732# Request:
1733# mutation {
1734#
1735# createEntityIdentifier(input: {
1736#
1737# entityId: "85b700fa-f327-4fea-b94b-ed83054170db",
1738#
1739# identifierTypeId: "123",
1740#
1741# title: "example",
1742#
1743# isPriority: false,
1744#
1745# contentType: "example",
1746#
1747# url:
1748# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1749# {
1750#
1751# id
1752#
1753# isPriority
1754#
1755# }
1756# }
1757# Result:
1758# {
1759#
1760# "data": {
1761#
1762# "createEntityIdentifier": {
1763#
1764# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1765#
1766# "isPriority": false,
1767#
1768# }
1769#
1770# }
1771# }
1772#
1773# Arguments
1774# input: Fields needed to create an entity identifier.
1775createEntityIdentifier(input: CreateEntityIdentifier!): EntityIdentifier
1776
1777# Updates an entity identifier.
1778# Example:
1779# Request:
1780# mutation {
1781#
1782# updateEntityIdentifier(input: {
1783#
1784# id: "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1785#
1786# title: "example",
1787#
1788# isPriority: true,
1789#
1790# url:
1791# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1792# {
1793#
1794# id
1795#
1796# isPriority
1797#
1798# }
1799# }
1800# Response:
1801# {
1802#
1803# "data": {
1804#
1805# "updateEntityIdentifier": {
1806#
1807# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1808#
1809# "isPriority": true
1810#
1811# }
1812#
1813# }
1814# }
1815#
1816# Arguments
1817# input: Fields required to update an entity identifier.
1818updateEntityIdentifier(input: UpdateEntityIdentifier!): EntityIdentifier
1819
1820# Delete an entity identifier
1821# Example:
1822# Request:
1823# mutation {
1824#
1825# deleteEntityIdentifier(id: "0bda9fa6-9fad-4025-8f03-07cc73321050") {
1826#
1827# message
1828#
1829# }
1830# }
1831# Response:
1832# {
1833#
1834# "data": {
1835#
1836# "deleteEntityIdentifier": {
1837#
1838# "message": "Entity identifier0bda9fa6-9fad-4025-8f03-07cc73321050 deleted."
1839#
1840# }
1841#
1842# }
1843# }
1844#
1845# Arguments
1846# id: Supply the ID of the entity identifier to delete.
1847deleteEntityIdentifier(id: ID!): DeletePayload
1848
1849# Create a library engine model.
1850# Example:
1851# Request:
1852# mutation {
1853#
1854# createLibraryEngineModel(input: {
1855#
1856# engineId: "1",
1857#
1858# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1859#
1860# trainJobId: "123",
1861#
1862# dataUrl:
1863# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1864# {
1865#
1866# id
1867#
1868# engineId
1869#
1870# }
1871# }
1872# Response:
1873# {
1874#
1875# "data": {
1876#
1877# "createLibraryEngineModel": {
1878#
1879# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1880#
1881# "engineId": "1"
1882#
1883# }
1884#
1885# }
1886# }
1887#
1888# Arguments
1889# input: Fields required to create a library engine model.
1890createLibraryEngineModel(
1891input: CreateLibraryEngineModel!
1892): LibraryEngineModel
1893
1894# Update a library engine model
1895# Example:
1896# Request:
1897# mutation {
1898#
1899# updateLibraryEngineModel(input: {
1900#
1901# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1902#
1903# trainJobId: "1234"}) {
1904#
1905# trainJobId
1906#
1907# }
1908# }
1909# Response:
1910# {
1911#
1912# "data": {
1913#
1914# "updateLibraryEngineModel": {
1915#
1916# "trainJobId": "1234"
1917#
1918# }
1919#
1920# }
1921# }
1922#
1923# Arguments
1924# input: Fields required to update a library engine model
1925updateLibraryEngineModel(
1926input: UpdateLibraryEngineModel!
1927): LibraryEngineModel
1928
1929# Delete a library engine model
1930# Example:
1931# Request:
1932# mutation {
1933#
1934# deleteLibraryEngineModel(
1935#
1936# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b") {
1937#
1938# id
1939#
1940# message
1941#
1942# }
1943# }
1944# Response:
1945# {
1946#
1947# "data": {
1948#
1949# "deleteLibraryEngineModel": {
1950#
1951# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1952#
1953# "message": "library engine model 0e9c25f7-d994-4363-af41-c00b37de9a1b deleted."
1954#
1955# }
1956#
1957# }
1958# }
1959#
1960# Arguments
1961# id: Supply the ID of the library engine model to delete.
1962deleteLibraryEngineModel(id: ID!): DeletePayload
1963
1964# Create a library collaborator.
1965# Example:
1966# Request:
1967# mutation {
1968#
1969# createLibraryCollaborator(input: {
1970#
1971# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1972#
1973# organizationId: 35521,
1974#
1975# permissions: ["job.create"]}) {
1976#
1977# organizationId
1978#
1979# status
1980#
1981# }
1982# }
1983# Response:
1984# {
1985#
1986# "data": {
1987#
1988# "createLibraryCollaborator": {
1989#
1990# "organizationId": "35521",
1991#
1992# "status": "active"
1993#
1994# }
1995#
1996# }
1997# }
1998#
1999# Arguments
2000# input: Fields required to create a library collaborator.
2001createLibraryCollaborator(
2002input: CreateLibraryCollaborator!
2003): LibraryCollaborator
2004
2005# Update a library collaborator
2006# Example:
2007# Request:
2008# mutation {
2009#
2010# updateLibraryCollaborator(input: {
2011#
2012# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2013#
2014# organizationId: 35521,
2015#
2016# permissions: ["job.create", "job.read"]}) {
2017#
2018# status
2019#
2020# permissions
2021#
2022# }
2023# }
2024# Response:
2025# {
2026#
2027# "data": {
2028#
2029# "updateLibraryCollaborator": {
2030#
2031# "status": "active",
2032#
2033# "permissions": [
2034#
2035# "job.create"
2036#
2037# ]
2038#
2039# }
2040#
2041# }
2042# }
2043#
2044# Arguments
2045# input: Fields required to update a library collaborator
2046updateLibraryCollaborator(
2047input: UpdateLibraryCollaborator!
2048): LibraryCollaborator
2049
2050# Delete a library collaborator
2051# Example:
2052# Request:
2053# mutation {
2054#
2055# deleteLibraryCollaborator(
2056#
2057# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2058#
2059# organizationId: "35521") {
2060#
2061# id
2062#
2063# message
2064#
2065# }
2066# }
2067# Response:
2068# {
2069#
2070# "data": {
2071#
2072# "deleteLibraryCollaborator": {
2073#
2074# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599 - 35521",
2075#
2076# "message": "library collaborator model libraryId:
2077# e0a6e5ad-dec8-49a1-ad33-3f1194c2e599, organizationId: 35521 deleted."
2078#
2079# }
2080#
2081# }
2082# }
2083#
2084# Arguments
2085# libraryId: Supply the ID of the library collaborator to delete.
2086# organizationId: Supply the ID of the library collaborator to
2087# delete.
2088deleteLibraryCollaborator(
2089libraryId: ID!,
2090organizationId: ID!
2091): DeletePayload
2092
2093# Create Dataset Library Configuration
2094# Example
2095# Request:
2096# mutation {
2097#
2098# createLibraryConfiguration(input: {
2099#
2100# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2101#
2102# engineCategoryId: "c1e5f177-ca10-433a-a155-bb5e4872cf9a",
2103#
2104# targetEngineIds: ["1"],
2105#
2106# confidence: {}}) {
2107#
2108# id
2109#
2110# }
2111# }
2112# Response:
2113# {
2114#
2115# "data": {
2116#
2117# "createLibraryConfiguration": {
2118#
2119# "id": "7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7"
2120#
2121# }
2122#
2123# }
2124# }
2125#
2126# Arguments
2127# input: Fields required to create library configuration
2128createLibraryConfiguration(
2129input: CreateLibraryConfiguration!
2130): LibraryConfiguration
2131
2132# Update Dataset Library Configuration
2133#
2134# Arguments
2135# input: Fields required to create library configuration
2136updateLibraryConfiguration(
2137input: UpdateLibraryConfiguration!
2138): LibraryConfiguration
2139
2140# Delete Dataset Library Configuration
2141#
2142# Arguments
2143# id: Supply configuration ID to delete.
2144deleteLibraryConfiguration(id: ID!): DeletePayload
2145
2146# Add recordings to a dataset library
2147# Example:
2148# Request:
2149# mutation {
2150#
2151# addLibraryDataset(input: {
2152#
2153# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2154#
2155# tdoIds: ["1570899328"]}) {
2156#
2157# tdoIds
2158#
2159# }
2160# }
2161# Response:
2162# {
2163#
2164# "data": {
2165#
2166# "addLibraryDataset": {
2167#
2168# "tdoIds": [
2169#
2170# "1570899328"
2171#
2172# ]
2173#
2174# }
2175#
2176# }
2177# }
2178addLibraryDataset(input: AddLibraryDataset!): LibraryDataset
2179
2180# Remove recordings from a dataset library
2181# Example:
2182# Request:
2183# mutation {
2184#
2185# deleteLibraryDataset(input: {
2186#
2187# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2188#
2189# tdoIds: ["1570899328"]}) {
2190#
2191# tdoIds
2192#
2193# message
2194#
2195# }
2196# }
2197# Response:
2198# {
2199#
2200# "data": {
2201#
2202# "deleteLibraryDataset": {
2203#
2204# "tdoIds": [
2205#
2206# "1570899328"
2207#
2208# ],
2209#
2210# "message": "[1570899328] are removed from e0a6e5ad-dec8-49a1-ad33-3f1194c2e599"
2211#
2212# }
2213#
2214# }
2215# }
2216deleteLibraryDataset(input: DeleteLibraryDataset!): DeleteLibraryDatasetPayload
2217
2218# Apply an application workflow step, such as "submit" or "approve"
2219# Example:
2220# Request:
2221# mutation {
2222#
2223# applicationWorkflow(input: {
2224#
2225# id: "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2226#
2227# action: submit}) {
2228#
2229# id
2230#
2231# name
2232#
2233# }
2234# }
2235# Response:
2236# {
2237#
2238# "data": {
2239#
2240# "applicationWorkflow": {
2241#
2242# "id": "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2243#
2244# "name": "appexamplebill2"
2245#
2246# }
2247#
2248# }
2249# }
2250#
2251# Arguments
2252# input: Fields required to apply a application workflow step
2253applicationWorkflow(input: ApplicationWorkflow): Application
2254
2255# Apply an engine workflow step, such as "submit" or "approve"
2256#
2257# Arguments
2258# input: Fields required to apply a engine workflow step
2259engineWorkflow(input: EngineWorkflow): Engine
2260
2261# Creates a widget associated with a collection
2262# Example:
2263# Request:
2264# mutation {
2265#
2266# createWidget(input:{
2267#
2268# collectionId: "242361",
2269#
2270# name: "example",
2271#
2272# nextButtonColor: "000000"}) {
2273#
2274# id
2275#
2276# name
2277#
2278# }
2279# }
2280# Response:
2281# {
2282#
2283# "data": {
2284#
2285# "createWidget": {
2286#
2287# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2288#
2289# "name": ""
2290#
2291# }
2292#
2293# }
2294# }
2295#
2296# Arguments
2297# input: Fields needed to create a new widget
2298createWidget(input: CreateWidget): Widget
2299
2300# Updates a widget
2301# Example:
2302# Request:
2303# mutation {
2304#
2305# updateWidget(input: {
2306#
2307# id: "fwSwWdRWTm2fdFMoPQDKkg",
2308#
2309# name: "new example name"}) {
2310#
2311# id
2312#
2313# name
2314#
2315# }
2316# }
2317# Response:
2318# {
2319#
2320# "data": {
2321#
2322# "updateWidget": {
2323#
2324# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2325#
2326# "name": "new example name"
2327#
2328# }
2329#
2330# }
2331# }
2332#
2333# Arguments
2334# input: Fields needed to update a widget
2335updateWidget(input: UpdateWidget): Widget
2336
2337# Create a new user within an organization.
2338# Example:
2339# Request:
2340# mutation {
2341#
2342# createUser(input: {
2343#
2344# name: "example",
2345#
2346# password: "example",
2347#
2348# organizationId: "35521"}) {
2349#
2350# id
2351#
2352# }
2353# }
2354# Response:
2355# {
2356#
2357# "data": {
2358#
2359# "createUser": {
2360#
2361# "id": "267de7e1-efb2-444a-a524-210328b78503"
2362#
2363# }
2364#
2365# }
2366# }
2367#
2368# Arguments
2369# input: Fields needed to create a user.
2370createUser(input: CreateUser): User
2371
2372# Create a new organization.
2373#
2374# Arguments
2375# input: Fields needed to create an organization. Requires
2376# superadmin
2377createOrganization(input: CreateOrganization!): Organization
2378
2379# Update an existing user'
2380# Example:
2381# Request:
2382# mutation {
2383#
2384# updateUser(input: {
2385#
2386# id: "267de7e1-efb2-444a-a524-210328b78503",
2387#
2388# firstName: "example",
2389#
2390# lastName: "example"}) {
2391#
2392# firstName
2393#
2394# lastName
2395#
2396# }
2397# }
2398# Response:
2399# {
2400#
2401# "data": {
2402#
2403# "updateUser": {
2404#
2405# "firstName": "example",
2406#
2407# "lastName": "example"
2408#
2409# }
2410#
2411# }
2412# }
2413#
2414# Arguments
2415# input: Fields needed to update a user
2416updateUser(input: UpdateUser): User
2417
2418# Add an existing user to an organization.
2419# One of the user identifiers (userId or userName) has to be specified.
2420#
2421# Arguments
2422# userId: UUID of user
2423# userName: User name to uniquely identify a user
2424# organizationGuid: UUID of organization
2425# roleIds: Role Ids.
2426# priority: Priority of the organization. If not provided, max
2427# priority plus one will be used.
2428addUserToOrganization(
2429userId: ID,
2430userName: String,
2431organizationGuid: ID!,
2432roleIds: [ID],
2433priority: Int
2434): User
2435
2436# Remove an existing user for organization.
2437# One of the user identifiers (userId or userName) has to be specified.
2438# The operation fails if the organization is the last one to which user belongs.
2439#
2440# Arguments
2441# userId: UUID of user
2442# userName: User name to uniquely identify a user
2443# organizationGuid: UUID of organization
2444removeUserFromOrganization(
2445userId: ID,
2446userName: String,
2447organizationGuid: ID!
2448): User
2449
2450# #Switch user to organization
2451#
2452# Arguments
2453# token: User token that should be logout
2454# userName: The user login name -- typically, email address.
2455# organizationGuid: GUID of organization.
2456switchUserToOrganization(
2457token: String!,
2458userName: String!,
2459organizationGuid: ID!
2460): LoginInfo
2461
2462# Force a user to update password on next login.
2463# This mutation is used by administrators.
2464# Example:
2465# Request:
2466# mutation {
2467#
2468# createPasswordUpdateRequest(input: {
2469#
2470# id: "267de7e1-efb2-444a-a524-210328b78503",
2471#
2472# skipPasswordResetEmail: true}) {
2473#
2474# id
2475#
2476# name
2477#
2478# }
2479# }
2480# Response:
2481# {
2482#
2483# "data": {
2484#
2485# "createPasswordUpdateRequest": {
2486#
2487# "id": "267de7e1-efb2-444a-a524-210328b78503",
2488#
2489# "name": "example"
2490#
2491# }
2492#
2493# }
2494# }
2495#
2496# Arguments
2497# input: Fields needed to create a password update request
2498createPasswordUpdateRequest(
2499input: CreatePasswordUpdateRequest
2500): User
2501
2502# Create a password reset request. This mutation is used on behalf
2503# of a user who needs to reset their password. It operates only on
2504# the currently authenicated user (based on the authentication token provided).
2505# Example:
2506# Request:
2507# mutation {
2508#
2509# createPasswordResetRequest(input: {
2510#
2511# userName: "example",
2512#
2513# skipPasswordResetEmail:true}) {
2514#
2515# message
2516#
2517# }
2518# }
2519# Response:
2520# {
2521#
2522# "data": {
2523#
2524# "createPasswordResetRequest": {
2525#
2526# "message": "Reset request issued for example. Email will not be sent."
2527#
2528# }
2529#
2530# }
2531# }
2532createPasswordResetRequest(
2533input: CreatePasswordResetRequest
2534): CreatePasswordResetRequestPayload
2535
2536# Update the current authenticated user
2537# Example:
2538# Request:
2539# mutation {
2540#
2541# updateCurrentUser(input: {
2542#
2543# title: "undefined"}) {
2544#
2545# id
2546#
2547# }
2548# }
2549# Response:
2550# {
2551#
2552# "data": {
2553#
2554# "updateCurrentUser": {
2555#
2556# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008"
2557#
2558# }
2559#
2560# }
2561# }
2562updateCurrentUser(input: UpdateCurrentUser!): User!
2563
2564# Get password token info for current user
2565# Example:
2566# Request:
2567# mutation {
2568#
2569# getCurrentUserPasswordToken(input: {
2570#
2571# password: "Example password"}) {
2572#
2573# passwordToken
2574#
2575# }
2576# }
2577# Response:
2578# {
2579#
2580# "data": {
2581#
2582# "getCurrentUserPasswordToken": {
2583#
2584# "passwordToken": "e4cb86c7-34a4-4a52-b458-3ebbb2cca9c3"
2585#
2586# }
2587#
2588# }
2589# }
2590getCurrentUserPasswordToken(
2591input: GetCurrentUserPasswordToken!
2592): PasswordTokenInfo!
2593
2594# Change the current authenticated user's password
2595#
2596# Arguments
2597# input: Fields needed to change password
2598changePassword(input: ChangePassword!): User
2599
2600# Delete a user
2601# Example:
2602# Request:
2603# mutation {
2604#
2605# deleteUser(
2606#
2607# id: "267de7e1-efb2-444a-a524-210328b78503") {
2608#
2609# message
2610#
2611# }
2612# }
2613# Response:
2614# {
2615#
2616# "data": {
2617#
2618# "deleteUser": {
2619#
2620# "message": null
2621#
2622# }
2623#
2624# }
2625# }
2626#
2627# Arguments
2628# id: Supply the ID of the user to delete.
2629deleteUser(id: ID!): DeletePayload
2630
2631# Create a structured data registry schema metadata.
2632# Example:
2633# Request:
2634# mutation {
2635#
2636# createDataRegistry(input: {
2637#
2638# name: "example",
2639#
2640# description: "example"
2641#
2642# source: "example"}) {
2643#
2644# id
2645#
2646# organizationId
2647#
2648# }
2649# }
2650# Response:
2651# {
2652#
2653# "data": {
2654#
2655# "createDataRegistry": {
2656#
2657# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2658#
2659# "organizationId": "35521"
2660#
2661# }
2662#
2663# }
2664# }
2665createDataRegistry(input: CreateDataRegistry!): DataRegistry
2666
2667# Update a structured data registry schema metadata.
2668# Example:
2669# Request:
2670# mutation {
2671#
2672# updateDataRegistry(input: {
2673#
2674# id: "230f95e4-95c9-47c4-a845-61ca67ad6ba6"
2675#
2676# name: "example"
2677#
2678# description: "example"
2679#
2680# source: "new source"}) {
2681#
2682# id
2683#
2684# source
2685#
2686# }
2687# }
2688# Response:
2689# {
2690#
2691# "data": {
2692#
2693# "updateDataRegistry": {
2694#
2695# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2696#
2697# "source": "new source"
2698#
2699# }
2700#
2701# }
2702# }
2703updateDataRegistry(input: UpdateDataRegistry!): DataRegistry
2704
2705# Create a schema record.
2706# Example:
2707# Request:
2708# mutation {
2709#
2710# createSchema(input: {
2711#
2712# id: "450f95e4-95c9-47c4-a845-62ca67ad6ea6",
2713#
2714# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2715#
2716# status: published,
2717#
2718# definition: {
2719#
2720# example: "example"
2721#
2722# },
2723#
2724# majorVersion: 1,
2725#
2726# minorVersion: 2
2727#
2728# }) {
2729#
2730# id
2731#
2732# }
2733# }
2734# Response:
2735# {
2736#
2737# "data": {
2738#
2739# "createSchema": {
2740#
2741# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2742#
2743# }
2744#
2745# }
2746# }
2747createSchema(input: CreateSchema!): Schema
2748
2749# Update a structured data registry schema.
2750# Example:
2751# Request:
2752# mutation {
2753#
2754# upsertSchemaDraft(input: {
2755#
2756# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2757#
2758# schema: {
2759#
2760# example: "example"
2761#
2762# }}) {
2763#
2764# id
2765#
2766# }
2767# }
2768# Response:
2769# {
2770#
2771# "data": {
2772#
2773# "upsertSchemaDraft": {
2774#
2775# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2776#
2777# }
2778#
2779# }
2780# }
2781upsertSchemaDraft(input: UpsertSchemaDraft!): Schema
2782
2783# Update the state of a schema
2784# Example:
2785# Request:
2786# mutation {
2787#
2788# updateSchemaState(input: {
2789#
2790# id: "0bd05e43-ddac-4b1a-9238-f3b177439b91",
2791#
2792# status: deleted}) {
2793#
2794# id
2795#
2796# }
2797# }
2798# Response:
2799# {
2800#
2801# "data": {
2802#
2803# "updateSchemaState": {
2804#
2805# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2806#
2807# }
2808#
2809# }
2810# }
2811updateSchemaState(input: UpdateSchemaState!): Schema
2812
2813# Create (ingest) a structured data object
2814# Example:
2815# Request:
2816# mutation {
2817#
2818# createStructuredData(input: {
2819#
2820# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2821#
2822# data: {
2823#
2824# example: "example"
2825#
2826# }}) {
2827#
2828# id
2829#
2830# }
2831# }
2832# Response:
2833# {
2834#
2835# "data": {
2836#
2837# "createStructuredData": {
2838#
2839# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa"
2840#
2841# }
2842#
2843# }
2844# }
2845createStructuredData(input: CreateStructuredData!): StructuredData
2846
2847# Delete a structured data object
2848# Example:
2849# Request:
2850# mutation {
2851#
2852# deleteStructuredData(input:{
2853#
2854# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
2855#
2856# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) {
2857#
2858# message
2859#
2860# }
2861# }
2862# Response:
2863# {
2864#
2865# "data": {
2866#
2867# "deleteStructuredData": {
2868#
2869# "message": null
2870#
2871# }
2872#
2873# }
2874# }
2875deleteStructuredData(input: DeleteStructuredData!): DeletePayload
2876
2877# Create (ingest) a structured data object
2878# Example:
2879# Request:
2880# mutation {
2881#
2882# createCollection(input: {
2883#
2884# name: "example",
2885#
2886# folderDescription: "example",
2887#
2888# image:"",
2889#
2890# parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) {
2891#
2892# id
2893#
2894# }
2895# }
2896# Response:
2897# {
2898#
2899# "data": {
2900#
2901# "createCollection": {
2902#
2903# "id": "242361"
2904#
2905# }
2906#
2907# }
2908# }
2909#
2910# Arguments
2911# input: Fields required to create new collection
2912createCollection(input: CreateCollection): Collection
2913
2914# Update a collection
2915# Example:
2916# Request:
2917# mutation {
2918#
2919# updateCollection(input: {
2920#
2921# folderId: "242361"
2922#
2923# name: "new name"
2924#
2925# folderDescription: "new description"}) {
2926#
2927# id
2928#
2929# name
2930#
2931# }
2932# }
2933# Response:
2934# {
2935#
2936# "data": {
2937#
2938# "updateCollection": {
2939#
2940# "id": "242361",
2941#
2942# "name": "new name"
2943#
2944# }
2945#
2946# }
2947# }
2948#
2949# Arguments
2950# input: Fields needed to update a collection
2951updateCollection(input: UpdateCollection): Collection
2952
2953# Delete Collection
2954# Example:
2955# Request:
2956# mutation {
2957#
2958# deleteCollection(
2959#
2960# id: "242361") {
2961#
2962# message
2963#
2964# }
2965# }
2966# Response:
2967# {
2968#
2969# "data": {
2970#
2971# "deleteCollection": {
2972#
2973# "message": "Deleted Successfully"
2974#
2975# }
2976#
2977# }
2978# }
2979#
2980# Arguments
2981# id: Supply the ID of the folder or collection to delete
2982deleteCollection(folderId: ID, id: ID): DeletePayload
2983
2984# Share a collection, allowing other organizations to view the data
2985# it contains.
2986# Example:
2987# Request:
2988# mutation {
2989#
2990# shareCollection(input: {
2991#
2992# folderId: "242599",
2993#
2994# shareMessage: "example",
2995#
2996# recipients: [] }) {
2997#
2998# id
2999#
3000# }
3001# }
3002# Response:
3003# {
3004#
3005# "data": {
3006#
3007# "shareCollection": {
3008#
3009# "id": "FhQrlAwfRMaTy0blR_eHRw"
3010#
3011# }
3012#
3013# }
3014# }
3015#
3016# Arguments
3017# input: Fields needed to share a collection
3018shareCollection(input: ShareCollection): Share
3019
3020# Arguments
3021# shareId: ID of the shared collection to update
3022# mentionIds: List of mentionIds to add or remove
3023# type: Indicates whether or not the mentions are to be added or
3024# deleted
3025updateSharedCollectionMentions(
3026shareId: String!,
3027mentionIds: [ID!],
3028type: SharedCollectionUpdateType!
3029): Share
3030
3031updateSharedCollectionHistory(
3032input: UpdateSharedCollectionHistory
3033): SharedCollectionHistory
3034
3035# Share a mention from a collection
3036#
3037# Arguments
3038# input: Fields needed to share a mention
3039shareMentionFromCollection(
3040input: ShareMentionFromCollection
3041): Share
3042
3043# Share mention
3044shareMention(input: ShareMention): Share
3045
3046# Share mentions in bulk
3047shareMentionInBulk(input: ShareMentionInBulk): [Share]
3048
3049# Add a mention to a collection
3050#
3051# Arguments
3052# input: Fields needed to add a mention to a collection
3053createCollectionMention(input: CollectionMentionInput): CollectionMention
3054
3055# Arguments
3056# input: Fields needed to add mentions to a collection
3057createCollectionMentions(
3058input: CreateCollectionMentions
3059): [CollectionMention!]!
3060
3061# Update a mention in a collection
3062#
3063# Arguments
3064# input: Fields needed to add mentions to a collection
3065updateCollectionMention(
3066input: UpdateCollectionMention!
3067): CollectionMention!
3068
3069# Remove a mention from a collection
3070#
3071# Arguments
3072# input: Fields needed to delete a mention from a collection
3073deleteCollectionMention(input: CollectionMentionInput): CollectionMention
3074
3075# Create a new folder
3076# Example:
3077# Request:
3078# mutation {
3079#
3080# createFolder(input: {
3081#
3082# name: "example",
3083#
3084# description: "example",
3085#
3086# parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3087#
3088# rootFolderType:watchlist}) {
3089#
3090# id
3091#
3092# name
3093#
3094# }
3095# }
3096# Response:
3097# {
3098#
3099# "data": {
3100#
3101# "createFolder": {
3102#
3103# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3104#
3105# "name": "example"
3106#
3107# }
3108#
3109# }
3110# }
3111#
3112# Arguments
3113# input: Fields needed to create a new folder.
3114createFolder(input: CreateFolder): Folder
3115
3116# Update an existing folder
3117# Example:
3118# Request:
3119# mutation {
3120#
3121# updateFolder(input: {
3122#
3123# id: "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3124#
3125# name: "new name"}) {
3126#
3127# name
3128#
3129# }
3130# }
3131# Response:
3132# {
3133#
3134# "data": {
3135#
3136# "updateFolder": {
3137#
3138# "name": "new name"
3139#
3140# }
3141#
3142# }
3143# }
3144#
3145# Arguments
3146# input: Fields needed to update a folder.
3147updateFolder(input: UpdateFolder): Folder
3148
3149# Move a folder from one parent folder to another.
3150# Example:
3151# Request:
3152# mutation {
3153#
3154# moveFolder(input: {
3155#
3156# treeObjectId: "68a5833a-f573-41fe-840a-adb5f6888e2d",
3157#
3158# prevParentTreeObjectId: "3104f61f-4bd1-4175-9fe6-27436d591c54",
3159#
3160# newParentTreeObjectId: "ad7839a7-d088-4202-9db1-5ed4992f915d",
3161#
3162# prevOrderIndex: 1,
3163#
3164# newOrderIndex: 1}) {
3165#
3166# id
3167#
3168# name
3169#
3170# }
3171# }
3172# Response:
3173# {
3174#
3175# "data": {
3176#
3177# "moveFolder": {
3178#
3179# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3180#
3181# "name": "new name"
3182#
3183# }
3184#
3185# }
3186# }
3187#
3188# Arguments
3189# input: Fields needed to move a folder
3190moveFolder(input: MoveFolder): Folder
3191
3192# Delete a folder
3193# Example:
3194# Request:
3195# mutation {
3196#
3197# deleteFolder(input: {
3198#
3199# id:"d551fbd6-7354-4b0e-abfb-654ab8583be2",
3200#
3201# orderIndex: 1}) {
3202#
3203# message
3204#
3205# }
3206# }
3207# Response:
3208# {
3209#
3210# "data": {
3211#
3212# "deleteFolder": {
3213#
3214# "message": null
3215#
3216# }
3217#
3218# }
3219# }
3220#
3221# Arguments
3222# input: Fields needed to delete a folder
3223deleteFolder(input: DeleteFolder): DeletePayload
3224
3225# Create a mention comment
3226#
3227# Arguments
3228# input: Fields needed to create a mention comment
3229createMentionComment(input: CreateMentionComment): MentionComment
3230
3231# Update a mention comment
3232#
3233# Arguments
3234# input: Fields needed to update a mention comment
3235updateMentionComment(input: UpdateMentionComment): MentionComment
3236
3237# Delete a mention comment
3238#
3239# Arguments
3240# input: Fields needed to delete a mention comment
3241deleteMentionComment(input: DeleteMentionComment): DeletePayload
3242
3243# Create a mention rating
3244#
3245# Arguments
3246# input: Fields needed to create a mention rating
3247createMentionRating(input: CreateMentionRating): MentionRating
3248
3249# Update a mention rating
3250#
3251# Arguments
3252# input: Fields needed to update a mention rating
3253updateMentionRating(input: UpdateMentionRating): MentionRating
3254
3255# Delete a mention rating
3256#
3257# Arguments
3258# input: Fields needed to delete a mention rating.
3259deleteMentionRating(input: DeleteMentionRating): DeletePayload
3260
3261# Login as a user. This mutation does not require an existing authentication
3262# context (via `Authorization` header with bearer token, cookie, etc.).
3263# Instead, the client supplies credentials to this mutation, which then
3264# authenticates the user and sets up the authentication context.
3265# The returned tokens can be used to authenticate future requests.
3266# Example:
3267# Request:
3268# mutation {
3269#
3270# userLogin(input: {
3271#
3272# userName: "example1",
3273#
3274# password: "example1"}) {
3275#
3276# apiToken
3277#
3278# lastLoggedIn
3279#
3280# }
3281# }
3282# Response:
3283# {
3284#
3285# "data": {
3286#
3287# "userLogin": {
3288#
3289# "apiToken": null,
3290#
3291# "lastLoggedIn": "2021-06-15T02:04:52.000Z",
3292#
3293# "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a"
3294#
3295# }
3296#
3297# }
3298# }
3299#
3300# Arguments
3301# input: Fields needed to log in
3302userLogin(input: UserLogin): LoginInfo
3303
3304# Logout user and invalidate user token
3305# Example:
3306# Request:
3307# mutation {
3308#
3309# userLogout(
3310#
3311# token: "a5610058-260d-46ac-aa3e-ee529c4feaab")
3312# }
3313# Response:
3314# {
3315#
3316# "data": {
3317#
3318# "userLogout": null
3319#
3320# }
3321# }
3322#
3323# Arguments
3324# token: User token that should be invalidated
3325userLogout(token: String!): Boolean
3326
3327# Refreshes the session user from database to reflect the latest changes. It does
3328# not extend session timeout.\
3329# Example:
3330# Request:
3331# mutation {
3332#
3333# refreshToken(
3334#
3335# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3336#
3337# hasPassword
3338#
3339# user{id}
3340#
3341# }
3342# }
3343# Response:
3344# {
3345#
3346# "data": {
3347#
3348# "refreshToken": {
3349#
3350# "hasPassword": true,
3351#
3352# "user": {
3353#
3354# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3355#
3356# }
3357#
3358# }
3359#
3360# }
3361# }
3362refreshToken(token: String!): LoginInfo
3363
3364# Refresh a user token, returning a fresh token so that the client
3365# can continue to authenticate to the API.\
3366# Example:
3367# Request:
3368# mutation {
3369#
3370# extendToken(
3371#
3372# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3373#
3374# hasPassword
3375#
3376# user{id}
3377#
3378# }
3379# }
3380# Response:
3381# {
3382#
3383# "data": {
3384#
3385# "extendToken": {
3386#
3387# "hasPassword": true,
3388#
3389# "user": {
3390#
3391# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3392#
3393# }
3394#
3395# }
3396#
3397# }
3398# }
3399extendToken(token: String!): LoginInfo
3400
3401# Validate a user token. This mutation is used by services to determine
3402# if the token provided by a given client is valid.
3403# Example:
3404# Request:
3405# mutation {
3406#
3407# validateToken(
3408#
3409# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3410#
3411# hasPassword
3412#
3413# user{id}
3414#
3415# }
3416# }
3417# Response:
3418# {
3419#
3420# "data": {
3421#
3422# "validateToken": {
3423#
3424# "hasPassword": true,
3425#
3426# "user": {
3427#
3428# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3429#
3430# }
3431#
3432# }
3433#
3434# }
3435# }
3436validateToken(token: String!): LoginInfo
3437
3438# Create a mention object
3439createMention(input: CreateMention!): Mention
3440
3441# Update a mention object
3442updateMention(input: UpdateMention!): Mention
3443
3444# Update a set of mentions
3445updateMentions(input: UpdateMentions!): [Mention]
3446
3447# Create root folder for an organization
3448# Example:
3449# Request:
3450# mutation {
3451#
3452# createRootFolders {
3453#
3454# id
3455#
3456# treeObjectId
3457#
3458# rootFolderTypeId
3459#
3460# }
3461# }
3462# Response:
3463# {
3464#
3465# "data": {
3466#
3467# "createRootFolders": [
3468#
3469# {
3470#
3471# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3472#
3473# "treeObjectId": "3104f61f-4bd1-4175-9fe6-27436d591c54",
3474#
3475# "rootFolderTypeId": 1
3476#
3477# },
3478#
3479# {
3480#
3481# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3482#
3483# "treeObjectId": "4c9f1c95-f6a3-4355-8831-c77719850eaa",
3484#
3485# "rootFolderTypeId": 1
3486#
3487# }
3488#
3489# ]
3490#
3491# }
3492# }
3493#
3494# Arguments
3495# rootFolderType: The type of root folder to create
3496createRootFolders(rootFolderType: RootFolderType): [Folder]
3497
3498# Apply bulk updates to watchlists.
3499# This mutation is currently available only to Veritone operations.
3500#
3501# Arguments
3502# filter: A filter indicating which watchlists should be updated.
3503# At least one filter condition must be provided.
3504# Only watchlists for the user's organization will be updated.
3505# input: Fields used to update a watchlist.
3506bulkUpdateWatchlist(
3507filter: BulkUpdateWatchlistFilter!,
3508input: BulkUpdateWatchlist
3509): WatchlistList
3510
3511# File a TemporalDataObject in a folder. A given TemporalDataObject can
3512# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3513# and its assets to be visible within the folder.
3514# Example:
3515# Request:
3516# mutation {
3517#
3518# fileTemporalDataObject(input:{
3519#
3520# tdoId: "1580388995",
3521#
3522# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3523#
3524# id
3525#
3526# folders{
3527#
3528# id
3529#
3530# }
3531#
3532# }
3533# }
3534# Response:
3535# {
3536#
3537# "data": {
3538#
3539# "fileTemporalDataObject": {
3540#
3541# "id": "1580388995",
3542#
3543# "folders": [
3544#
3545# {
3546#
3547# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3548#
3549# }
3550#
3551# ]
3552#
3553# }
3554#
3555# }
3556# }
3557#
3558# Arguments
3559# input: The fields needed to file a TemporalDataObject in a
3560# folder
3561fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3562
3563# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3564# and its assets to disappear from the folder, but does not otherwise affect
3565# either the TDO or the folder and does not change access controls.
3566# Example:
3567# Request:
3568# mutation {
3569#
3570# unfileTemporalDataObject(input: {
3571#
3572# tdoId: "1580388995",
3573#
3574# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3575#
3576# id
3577#
3578# description
3579#
3580# }
3581# }
3582# Response:
3583# {
3584#
3585# "data": {
3586#
3587# "unfileTemporalDataObject": {
3588#
3589# "id": "1580388995",
3590#
3591# "description": null
3592#
3593# }
3594#
3595# }
3596# }
3597#
3598# Arguments
3599# input: The fields needed to file a TemporalDataObject in a
3600# folder
3601unfileTemporalDataObject(
3602input: UnfileTemporalDataObject!
3603): TemporalDataObject
3604
3605# Moves a TemporalDataObject from one parent folder to another.
3606# Any other folders the TemporalDataObject is filed in are unaffected.
3607# Example:
3608# Request:
3609# mutation {
3610#
3611# moveTemporalDataObject(input: {
3612#
3613# tdoId: "1580388995",
3614#
3615# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3616#
3617# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
3618#
3619# id
3620#
3621# folders{
3622#
3623# folderPath{id}
3624#
3625# }
3626#
3627# }
3628# }
3629# Response:
3630# {
3631#
3632# "data": {
3633#
3634# "moveTemporalDataObject": {
3635#
3636# "id": "1580388995",
3637#
3638# "folders": [
3639#
3640# {
3641#
3642# "folderPath": [
3643#
3644# {
3645#
3646# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
3647#
3648# }
3649#
3650# ]
3651#
3652# }
3653#
3654# ]
3655#
3656# }
3657#
3658# }
3659# }
3660#
3661# Arguments
3662# input: Fields need to move a TemporalDataObject
3663moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
3664
3665# Upload and store an engine result. The result will be stored as an
3666# asset associated with the target TemporalDataObject and the
3667# task will be updated accordingly.
3668# Use a multipart form POST to all this mutation.
3669#
3670# Arguments
3671# input: Fields needed to upload and store an engine result
3672uploadEngineResult(input: UploadEngineResult!): Asset
3673
3674# Create a watchlist
3675# Example:
3676# Request:
3677# mutation {
3678#
3679# createWatchlist(input: {
3680#
3681# stopDateTime: 1623851655,
3682#
3683# name: "example",
3684#
3685# searchIndex: mine,
3686#
3687# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3688#
3689# cognitiveSearches: [],
3690#
3691# subscriptions: [],
3692#
3693# details: {
3694#
3695# example: "example"}}) {
3696#
3697# id
3698#
3699# }
3700# }
3701# Response:
3702# {
3703#
3704# "data": {
3705#
3706# "createWatchlist": {
3707#
3708# "id": "325783"
3709#
3710# }
3711#
3712# }
3713# }
3714createWatchlist(input: CreateWatchlist!): Watchlist
3715
3716bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
3717
3718# Update a watchlist
3719# Example:
3720# Request:
3721# mutation {
3722#
3723# updateWatchlist(input: {
3724#
3725# id: "325783"
3726#
3727# name: "new name"
3728#
3729# details: {
3730#
3731# example: "new details"}}) {
3732#
3733# id
3734#
3735# name
3736#
3737# }
3738# }
3739# Response:
3740#
3741# {
3742#
3743# "data": {
3744#
3745# "updateWatchlist": {
3746#
3747# "id": "325783",
3748#
3749# "name": "new name"
3750#
3751# }
3752#
3753# }
3754# }
3755updateWatchlist(input: UpdateWatchlist!): Watchlist
3756
3757# Delete a watchlist
3758# Example:
3759# Request:
3760# mutation {
3761#
3762# deleteWatchlist(
3763#
3764# id:"325783") {
3765#
3766# message
3767#
3768# }
3769# }
3770# Response:
3771# {
3772#
3773# "data": {
3774#
3775# "deleteWatchlist": {
3776#
3777# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
3778# profiles, 0 mention comments, and 0 mention ratings."
3779#
3780# }
3781#
3782# }
3783# }
3784deleteWatchlist(id: ID!): DeletePayload
3785
3786updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
3787
3788createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
3789
3790deleteCognitiveSearch(id: ID!): DeletePayload
3791
3792fileWatchlist(input: FileWatchlist!): Watchlist
3793
3794# Unfile a watchlist from a folder
3795# Example:
3796# Request:
3797# mutation {
3798#
3799# unfileWatchlist(input: {
3800#
3801# watchlistId:"325786",
3802#
3803# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3804#
3805# id
3806#
3807# folders{
3808#
3809# folderPath{
3810#
3811# id
3812#
3813# }
3814#
3815# }
3816#
3817# }
3818# }
3819# Response:
3820# {
3821#
3822# "data": {
3823#
3824# "unfileWatchlist": {
3825#
3826# "id": "325786",
3827#
3828# "folders": []
3829#
3830# }
3831#
3832# }
3833# }
3834unfileWatchlist(input: UnfileWatchlist!): Watchlist
3835
3836# Share a folder with other organizations
3837# Requires superadmin
3838shareFolder(input: ShareFolderInput): Folder
3839
3840# Create a TDO and an asset with a single call
3841# Example:
3842# Request:
3843# mutation {
3844#
3845# createTDOWithAsset(input: {
3846#
3847# startDateTime: 1623841655,
3848#
3849# stopDateTime: 1623851655,
3850#
3851# contentType: "video/mp4",
3852#
3853# assetType: "media",
3854#
3855# addToIndex: false,
3856#
3857# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
3858#
3859# id
3860#
3861# status
3862#
3863# assets {
3864#
3865# records {
3866#
3867# id
3868#
3869# assetType
3870#
3871# contentType
3872#
3873# signedUri
3874#
3875# }
3876#
3877# }
3878#
3879# }
3880# }
3881# Response:
3882# {
3883#
3884# "data": {
3885#
3886# "createTDOWithAsset": {
3887#
3888# "id": "1580507556",
3889#
3890# "status": "recorded",
3891#
3892# "assets": {
3893#
3894# "records": [
3895#
3896# {
3897#
3898# "id": "1580507556_DQ2nU8cTDh",
3899#
3900# "assetType": "media",
3901#
3902# "contentType": "video/mp4",
3903#
3904# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
3905#
3906# }
3907#
3908# ]
3909#
3910# }
3911#
3912# }
3913#
3914# }
3915# }
3916#
3917# Arguments
3918# input: Input fields necessary to create the TDO and asset
3919createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
3920
3921# Create a subscription
3922# Example:
3923# Request:
3924# mutation {
3925#
3926# createSubscription(input: {
3927#
3928# targetId: "325791",
3929#
3930# contact: {
3931#
3932# emailAddress: "example email"},
3933#
3934# scheduledDay: Friday}) {
3935#
3936# id
3937#
3938# }
3939# }
3940# Response:
3941# {
3942#
3943# "data": {
3944#
3945# "createSubscription": {
3946#
3947# "id": "274939"
3948#
3949# }
3950#
3951# }
3952# }
3953createSubscription(input: CreateSubscription!): Subscription
3954
3955# Update a subscription
3956# Example:
3957# Request:
3958# mutation {
3959#
3960# updateSubscription(input: {
3961#
3962# id: "274939"}) {
3963#
3964# id
3965#
3966# }
3967# }
3968# Response:
3969# mutation {
3970#
3971# updateSubscription(input: {
3972#
3973# id: "274939"}) {
3974#
3975# id
3976#
3977# }
3978# }
3979updateSubscription(input: UpdateSubscription!): Subscription
3980
3981# Delete a subscription
3982# Example:
3983# Request:
3984# mutation {
3985#
3986# deleteSubscription(
3987#
3988# id: "274939") {
3989#
3990# message
3991#
3992# }
3993# }
3994# Response:
3995# mutation {
3996#
3997# deleteSubscription(
3998#
3999# id: "274939") {
4000#
4001# message
4002#
4003# }
4004# }
4005deleteSubscription(id: ID!): DeletePayload
4006
4007# Create trigger for events or types.
4008# Example:
4009# Request:
4010# mutation {
4011#
4012# createTriggers(input: {
4013#
4014# events: "*",
4015#
4016# targets: {
4017#
4018# name: Email,
4019#
4020# params: {
4021#
4022# address: "example@veritone.com"}}}) {
4023#
4024# id
4025#
4026# }
4027# }
4028# Response:
4029# {
4030#
4031# "data": {
4032#
4033# "createTriggers": [
4034#
4035# {
4036#
4037# "id": "2936"
4038#
4039# }
4040#
4041# ]
4042#
4043# }
4044# }
4045createTriggers(input: CreateTriggers!): [Trigger]
4046
4047# Delete a registed trigger by ID.
4048# Example:
4049# Request:
4050# mutation {
4051#
4052# deleteTrigger(
4053#
4054# id: "2936") {
4055#
4056# message
4057#
4058# }
4059# }
4060# Response:
4061# {
4062#
4063# "data": {
4064#
4065# "deleteTrigger": {
4066#
4067# "message": "Trigger 2936 has been removed from organization 35521"
4068#
4069# }
4070#
4071# }
4072# }
4073deleteTrigger(id: ID!): DeletePayload
4074
4075# Validates if an engine output conforms to the engine output guidelines
4076# Example:
4077# Request:
4078# mutation {
4079#
4080# validateEngineOutput(input:
4081#
4082# {
4083#
4084# schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json",
4085#
4086# validationContracts: [
4087#
4088# "structured-data"
4089#
4090# ],
4091#
4092# series: [
4093#
4094# {
4095#
4096# startTimeMs: 0,
4097#
4098# stopTimeMs: 10000,
4099#
4100# structuredData: {
4101#
4102# exampleschemaid: {
4103#
4104# key: "value",
4105#
4106# any: "data you'd like",
4107#
4108# as_long: "as it conforms to the schema"
4109#
4110# }
4111#
4112# }
4113#
4114# }
4115#
4116# ]
4117#
4118# }
4119#
4120# )
4121# }
4122# Response:
4123# {
4124#
4125# "data": {
4126#
4127# "validateEngineOutput": true
4128#
4129# }
4130# }
4131validateEngineOutput(input: JSONData!): Boolean!
4132
4133# JWT tokens with a more limited scoped token to specific
4134# resources to the recording, task, and job
4135# and also has no organization association.
4136# Example:
4137# Request:
4138# mutation {
4139#
4140# getEngineJWT(input: {
4141#
4142# engineId: "1",
4143#
4144# resource:{
4145#
4146# tdoId: "1580701928"
4147#
4148# }}) {
4149#
4150# token
4151#
4152# }
4153# }
4154#
4155# Response:
4156# {
4157#
4158# "data": {
4159#
4160# "getEngineJWT": {
4161#
4162# "token": "eyJh...Tw_z3BKRA"
4163#
4164# }
4165#
4166# }
4167# }
4168getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
4169
4170# Verify JWT token
4171# Example:
4172# Request:
4173# mutation {
4174#
4175# verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW
4176#
4177# 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY
4178#
4179# wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ
4180#
4181# XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb
4182#
4183# eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw
4184#
4185# icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD
4186#
4187# A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia
4188#
4189# m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz
4190#
4191# NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI
4192#
4193# 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA")
4194# {
4195#
4196# payload
4197#
4198# }
4199# }
4200# Response:
4201# {
4202#
4203# "data": {
4204#
4205# "verifyJWT": {
4206#
4207# "payload": {
4208#
4209# "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09",
4210#
4211# "contentOrganizationId": 35521,
4212#
4213# "engineId": "1",
4214#
4215# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4216#
4217# "scope": [
4218#
4219# {
4220#
4221# "actions": [
4222#
4223# "asset:uri",
4224#
4225# "asset:all",
4226#
4227# "recording:read",
4228#
4229# "recording:update"
4230#
4231# ],
4232#
4233# "resources": {
4234#
4235# "recordingIds": [
4236#
4237# "1580701928"
4238#
4239# ]
4240#
4241# }
4242#
4243# },
4244#
4245# {
4246#
4247# "actions": [
4248#
4249# "task:update"
4250#
4251# ],
4252#
4253# "resources": {
4254#
4255# "jobIds": [],
4256#
4257# "taskIds": [],
4258#
4259# "sourceIds": []
4260#
4261# }
4262#
4263# }
4264#
4265# ],
4266#
4267# "iat": 1624036122,
4268#
4269# "exp": 1624640922,
4270#
4271# "sub": "engine-run",
4272#
4273# "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133"
4274#
4275# }
4276#
4277# }
4278#
4279# }
4280# }
4281verifyJWT(jwtToken: String!): VerifyJWTPayload
4282
4283# Create a new Saved Search
4284# Example:
4285# Request:
4286# mutation {
4287#
4288# createSavedSearch(input: {
4289#
4290# name: "example",
4291#
4292# csp: {
4293#
4294# example: "example"}}) {
4295#
4296# id
4297#
4298# }
4299# }
4300# Response:
4301# {
4302#
4303# "data": {
4304#
4305# "createSavedSearch": {
4306#
4307# "id": "a29f2255-e509-4454-89ec-e425390ca4ca"
4308#
4309# }
4310#
4311# }
4312# }
4313createSavedSearch(input: CreateSavedSearch!): SavedSearch!
4314
4315# Delete a saved search
4316# Example:
4317# Request:
4318# mutation {
4319#
4320# deleteSavedSearch(
4321#
4322# id:"a29f2255-e509-4454-89ec-e425390ca4ca") {
4323#
4324# message
4325#
4326# }
4327# }
4328# Response:
4329# {
4330#
4331# "data": {
4332#
4333# "deleteSavedSearch": {
4334#
4335# "message": null
4336#
4337# }
4338#
4339# }
4340# }
4341deleteSavedSearch(id: ID!): DeletePayload!
4342
4343# Mark existing saved search profile as deleted
4344# Create new saved search profile
4345# Example:
4346# Request:
4347# mutation {
4348#
4349# replaceSavedSearch(input: {
4350#
4351# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4352#
4353# name: "example",
4354#
4355# csp: {
4356#
4357# example: "new csp"}}) {
4358#
4359# id
4360#
4361# }
4362# }
4363# Response:
4364# mutation {
4365#
4366# replaceSavedSearch(input: {
4367#
4368# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4369#
4370# name: "example",
4371#
4372# csp: {
4373#
4374# example: "new csp"}}) {
4375#
4376# id
4377#
4378# }
4379# }
4380replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
4381
4382# Send a basic email. Mutation returns true for a success message.
4383# The email from field will be automatically set the default platform email
4384# address
4385# Example:
4386# Request:
4387# mutation {
4388#
4389# sendEmail(input: {
4390#
4391# to: "example@veritone.com"
4392#
4393# subject: "example"
4394#
4395# message: "email body"
4396#
4397# replyTo: "example@veritone.com"
4398#
4399# })
4400# }
4401# Response:
4402# {
4403#
4404# "data": {
4405#
4406# "sendEmail": true
4407#
4408# }
4409# }
4410sendEmail(input: SendEmail!): Boolean!
4411
4412# Create new content template into a folder
4413createFolderContentTempate(
4414input: CreateFolderContentTempate!
4415): FolderContentTemplate!
4416
4417# Update existing content template by folderContentTemplateId
4418updateFolderContentTempate(
4419input: UpdateFolderContentTempate!
4420): FolderContentTemplate!
4421
4422# Delete existing folder content template by folderContentTemplateId
4423#
4424# Arguments
4425# id: Folder Content Template Id
4426deleteFolderContentTempate(id: ID!): DeletePayload!
4427
4428# Create an export request. The requested TDO data, possibly including
4429# TDO media and engine results, will be exported offline.
4430# Example:
4431# Request:
4432# mutation {
4433#
4434# createExportRequest(input: {
4435#
4436# tdoData: {
4437#
4438# tdoId: "1580388995",
4439#
4440# }}) {
4441#
4442# id
4443#
4444# }
4445# }
4446# Response:
4447# {
4448#
4449# "data": {
4450#
4451# "createExportRequest": {
4452#
4453# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad"
4454#
4455# }
4456#
4457# }
4458# }
4459#
4460# Arguments
4461# input: Input data required to create the export request
4462createExportRequest(input: CreateExportRequest!): ExportRequest!
4463
4464# Update an export request
4465# Example:
4466# Request:
4467# mutation {
4468#
4469# updateExportRequest(input: {
4470#
4471# id: "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4472#
4473# status: complete}) {
4474#
4475# id
4476#
4477# status
4478#
4479# }
4480# }
4481# Response:
4482# {
4483#
4484# "data": {
4485#
4486# "updateExportRequest": {
4487#
4488# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4489#
4490# "status": "complete"
4491#
4492# }
4493#
4494# }
4495# }
4496#
4497# Arguments
4498# input: Input data required to update an export request
4499updateExportRequest(input: UpdateExportRequest!): ExportRequest!
4500
4501# Create Mention in bulk. The input should be an array of createMentions
4502createMentions(input: CreateMentions!): MentionList
4503
4504# Create Media Share. Returning the url of the share
4505createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
4506
4507# Create a new event
4508#
4509# Example:
4510#
4511# Request:
4512#
4513# mutation {
4514#
4515# createEvent(input: {
4516#
4517# eventName: "example",
4518#
4519# eventType: "example",
4520#
4521# application: ""
4522#
4523# description: "example"}) {
4524#
4525# id
4526#
4527# }
4528# }
4529# Response:
4530# {
4531#
4532# "data": {
4533#
4534# "createEvent": {
4535#
4536# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d"
4537#
4538# }
4539#
4540