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#
5# Arguments
6# input: Fields required to create a TDO
7createTDO(input: CreateTDO): TemporalDataObject
8
9# Update a temporal data object
10#
11# Arguments
12# input: Fields required to update a TDO
13updateTDO(input: UpdateTDO): TemporalDataObject
14
15# Delete a temporal data object. The TDO metadata, its assets and
16# all storage objects, and search index data are deleted.
17# Engine results stored in related task objects are not.
18# cleanupTDO can be used to selectively delete certain data on the TDO.
19#
20# Arguments
21# id: Supply the ID of the TDO to delete
22deleteTDO(id: ID!): DeletePayload
23
24# Delete partial information from a temporal data object.
25# Use the delete options to control exactly which data is deleted.
26# The default is to delete objects from storage and the search index,
27# while leaving TDO-level metadata and task engine results intact.
28# To permanently delete the TDO, use delete TDO.
29#
30# Arguments
31# id: Supply the ID of the TDO to clean up.
32# options: Supply a list of cleanup options. See TDOCleanupOption
33# for details. If not provided, the server will use default settings.
34cleanupTDO(id: ID!, options: [TDOCleanupOption!]): DeletePayload
35
36# Create a task log by using
37# multipart form POST.
38#
39# Arguments
40# input: Fields needed to create a task log.
41createTaskLog(input: CreateTaskLog!): TaskLog
42
43# Create a media asset. Optionally, upload content using
44# multipart form POST.
45#
46# Arguments
47# input: Fields needed to create an asset.
48createAsset(input: CreateAsset!): Asset
49
50# Delete an asset
51#
52# Arguments
53# id: Provide the ID of the asset to delete.
54deleteAsset(id: ID!): DeletePayload
55
56# Update an asset
57#
58# Arguments
59# input: Fields needed to update an asset.
60updateAsset(input: UpdateAsset!): Asset
61
62# Add a single media segment to a TemporalDataObject.
63# This mutation will update the manifest asset (`media-mdp`)
64# for the TemporalDataObject.
65#
66# Arguments
67# input: Fields necesary to create the segment.
68addMediaSegment(input: AddMediaSegment!): TemporalDataObject!
69
70# Add a media segments to a TemporalDataObject.
71# This mutation will update the manifest asset (`media-mdp`)
72# for the TemporalDataObject.
73#
74# Arguments
75# containerId: ID of the TemporalDataObject container for the
76# segment
77# segments: Fields necesary to create the segment.
78# segmentGroupId: ID of the segment group (Optional)
79addMediaSegments(
80containerId: ID!,
81segments: [AddMediaSegments]!,
82segmentGroupId: ID
83): TemporalDataObject!
84
85# Start a clone job. A clone creates a new TDO
86# that links back to an existing TDO's assets
87# instead of creating new ones and is used
88# primarily to handle sample media.
89# Only for internal platform components.
90#
91# Arguments
92# input: Fields needed to request a new clone job.
93requestClone(input: RequestClone): CloneRequest
94
95# Create a new engine. The engine will need to go
96# through a sequence of workflow steps before
97# use in production. See VDA documentation for details.
98#
99# Arguments
100# input: Fields needed to create a new engine
101createEngine(input: CreateEngine): Engine
102
103# Update an engine. Engines are subject to specific
104# workflow steps. An engine's state determines what
105# updates can be made to it. See VDA documentation for
106# details.
107#
108# Arguments
109# input: Fields needed to update an engine
110updateEngine(input: UpdateEngine): Engine
111
112# Delete an engine
113#
114# Arguments
115# id: Provide the ID of the engine to delete
116deleteEngine(id: ID!): DeletePayload
117
118# Create an engine build.
119#
120# Arguments
121# input: Fields needed to create an engine build.
122createEngineBuild(input: CreateBuild!): Build
123
124# Update an engine build. Engine builds are subject to
125# specific workflow steps. A build's state determines what
126# updates can be made to it. See VDA documentation for details.
127#
128# Arguments
129# input: Fields needed to update an engine build.
130updateEngineBuild(input: UpdateBuild!): Build
131
132# Delete an engine build
133#
134# Arguments
135# input: Fields needed to delete an engine build.
136deleteEngineBuild(input: DeleteBuild!): DeletePayload
137
138# Update a task
139#
140# Arguments
141# input: Fields required to update a task.
142updateTask(input: UpdateTask): Task
143
144# Arguments
145# reason: Short string describing the warning
146# message: Optional: the actual problem
147# referenceId: Optional: Reference ID for the warning, such as
148# assetId, or sourceId
149appendWarningToTask(
150taskId: ID,
151reason: String!,
152message: String,
153referenceId: ID
154): ID
155
156addTasksToJobs(input: AddTasksToJobs): AddTasksToJobsResponse
157
158# Poll a task
159#
160# Arguments
161# input: Fields required to poll a task.
162pollTask(input: PollTask): Task
163
164# Create a job
165#
166# Arguments
167# input: Fields required to create a job.
168createJob(input: CreateJob): Job
169
170# Cancel a job. This action effectively deletes the job,
171# although a records of job and task execution remains in
172# Veritone's database.
173#
174# Arguments
175# id: Supply the ID of the job to delete.
176cancelJob(id: ID!): DeletePayload
177
178# Retry a job. This action applies only to jobs
179# that are in a failure state. The task sequence
180# for the job will be restarted in its original
181# configuration.
182#
183# Arguments
184# id: Supply the ID of the job to retry.
185retryJob(id: ID!): Job
186
187# Create and launch a job executing a single engine,
188# using the default engine DAG definition modified with the
189# supplied field values
190launchSingleEngineJob(input: SingleEngineJobInput!): Job
191
192updateJobs(input: UpdateJobs!): JobList
193
194# Create a new application. An application must
195# go through a sequence of workflow steps before
196# it is available in production. See the VDA documentation
197# for details.
198#
199# Arguments
200# input: Fields needed to create a new custom application.
201createApplication(input: CreateApplication): Application
202
203# Delete an application
204#
205# Arguments
206# id: Supply the ID of the application to delete.
207deleteApplication(id: ID!): DeletePayload
208
209# Update a custom application. Applications are subject to
210# specific workflows. The current application state determines
211# what updates can be made to it. See VDA documentation for details.
212#
213# Arguments
214# input: Fields required to update a custom application.
215updateApplication(input: UpdateApplication): Application
216
217# Update an application by adding or removing components
218updateApplicationComponent(
219input: UpdateApplicationComponent!
220): ApplicationComponent!
221
222# Update an application's billing plan id for an organization.
223updateApplicationBillingPlanId(
224applicationId: ID!,
225organizationId: ID!,
226billingPlanId: String!
227): ApplicationBillingPlanId!
228
229# Update an application's billing dirty for an organization.
230updateApplicationBillingDirty(
231applicationId: ID!,
232organizationId: ID!,
233billingDirty: Boolean!
234): ApplicationBillingDirty!
235
236# Bulk delete context meu extensions.
237bulkDeleteContextMenuExtensions(
238input: BulkDeleteContextMenuExtensions
239): ContextMenuExtensionList
240
241# Update an organization
242#
243# Arguments
244# input: Fields required to update an organization.
245updateOrganization(input: UpdateOrganization!): Organization
246
247# Update organization billing policy
248#
249# Arguments
250# planId: External billing plan id.
251# targetOrganizationId: Optional organization id, to use when the
252# caller is a superadmin from a different org
253updateOrganizationBilling(
254planId: String!,
255targetOrganizationId: ID
256): OrganizationBilling
257
258addToEngineWhitelist(toAdd: SetEngineWhitelist!): EngineWhitelist
259
260addToEngineBlacklist(toAdd: SetEngineBlacklist!): EngineBlacklist
261
262deleteFromEngineBlacklist(
263toDelete: SetEngineBlacklist!
264): EngineBlacklist
265
266deleteFromEngineWhitelist(
267toDelete: SetEngineBlacklist!
268): EngineWhitelist
269
270# Create an entity identifier type, such as "face" or "image".
271# Entity identifier types are typically created or modified
272# only by Veritone engineering. Most libraries and
273# entities will use existing entity identifier types.
274#
275# Arguments
276# input: Fields required to create an entity identifier type.
277createEntityIdentifierType(
278input: CreateEntityIdentifierType!
279): EntityIdentifierType
280
281# Update an entity identifier type.
282#
283# Arguments
284# input: Fields required to update an entity identifier type.
285updateEntityIdentifierType(
286input: UpdateEntityIdentifierType!
287): EntityIdentifierType
288
289# Create a library type, such as "ad" or "people".
290# Entity identifier types are typically created or modified
291# only by Veritone engineering. Most libraries
292# will use existing entity identifier types.
293#
294# Arguments
295# input: Fields needed to create a new library type.
296createLibraryType(input: CreateLibraryType!): LibraryType
297
298# Update a library type.
299#
300# Arguments
301# input: Fields needed to update a library type.
302updateLibraryType(input: UpdateLibraryType!): LibraryType
303
304# Create a new library.
305# Once the library is created, the client can add
306# entities and entity identifiers. Note that the
307# library type determines what types of entity identifiers
308# can be used within the library.
309#
310# Arguments
311# input: Fields needed to create a new library.
312createLibrary(input: CreateLibrary!): Library
313
314# Update an existing library.
315#
316# Arguments
317# input: Fields needed to update a library
318updateLibrary(input: UpdateLibrary!): Library
319
320# Delete a library. This mutation will also delete all entities,
321# entity identifiers, library engine models, and associated objects.
322#
323# Arguments
324# id: Provide the ID of the library to delete.
325deleteLibrary(id: ID!): DeletePayload
326
327# Publish a new version of a library.
328# Increments library version by one and trains compatible engines.
329#
330# Arguments
331# id: ID of the library to publish
332publishLibrary(id: ID!): Library
333
334# Create a new entity.
335#
336# Arguments
337# input: Fields required to create a new entity.
338createEntity(input: CreateEntity!): Entity
339
340# Update an entity.
341#
342# Arguments
343# input: Fields required to update an entity.
344updateEntity(input: UpdateEntity!): Entity
345
346# Delete an entity. This mutation will also delete all associated
347# entity identifiers and associated objects.
348#
349# Arguments
350# id: Supply the ID of the entity to delete.
351deleteEntity(id: ID!): DeletePayload
352
353# Create an entity identifier.
354# This mutation accepts file uploads. To use this mutation and upload a file,
355# send a multipart form POST containing two parameters: `query`, with the
356# GraphQL query, and `file` containing the file itself.
357# For more information see the documentation at
358# https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL.
359#
360# Arguments
361# input: Fields needed to create an entity identifier.
362createEntityIdentifier(input: CreateEntityIdentifier!): EntityIdentifier
363
364# Arguments
365# input: Fields required to update an entity identifier.
366updateEntityIdentifier(input: UpdateEntityIdentifier!): EntityIdentifier
367
368# Delete an entity identifier
369#
370# Arguments
371# id: Supply the ID of the entity identifier to delete.
372deleteEntityIdentifier(id: ID!): DeletePayload
373
374# Create a library engine model.
375#
376# Arguments
377# input: Fields required to create a library engine model.
378createLibraryEngineModel(
379input: CreateLibraryEngineModel!
380): LibraryEngineModel
381
382# Update a library engine model
383#
384# Arguments
385# input: Fields required to update a library engine model
386updateLibraryEngineModel(
387input: UpdateLibraryEngineModel!
388): LibraryEngineModel
389
390# Delete a library engine model
391#
392# Arguments
393# id: Supply the ID of the library engine model to delete.
394deleteLibraryEngineModel(id: ID!): DeletePayload
395
396# Create a library collaborator.
397#
398# Arguments
399# input: Fields required to create a library collaborator.
400createLibraryCollaborator(
401input: CreateLibraryCollaborator!
402): LibraryCollaborator
403
404# Update a library collaborator
405#
406# Arguments
407# input: Fields required to update a library collaborator
408updateLibraryCollaborator(
409input: UpdateLibraryCollaborator!
410): LibraryCollaborator
411
412# Delete a library collaborator
413#
414# Arguments
415# libraryId: Supply the ID of the library collaborator to delete.
416# organizationId: Supply the ID of the library collaborator to
417# delete.
418deleteLibraryCollaborator(
419libraryId: ID!,
420organizationId: ID!
421): DeletePayload
422
423# #Create Dataset Library Configuration
424#
425# Arguments
426# input: Fields required to create library configuration
427createLibraryConfiguration(
428input: CreateLibraryConfiguration!
429): LibraryConfiguration
430
431# #Update Dataset Library Configuration
432#
433# Arguments
434# input: Fields required to create library configuration
435updateLibraryConfiguration(
436input: UpdateLibraryConfiguration!
437): LibraryConfiguration
438
439# #Delete Dataset Library Configuration
440#
441# Arguments
442# id: Supply configuration ID to delete.
443deleteLibraryConfiguration(id: ID!): DeletePayload
444
445# Add recordings to a dataset library
446addLibraryDataset(input: AddLibraryDataset!): LibraryDataset
447
448# Remove recordings from a dataset library
449deleteLibraryDataset(input: DeleteLibraryDataset!): DeleteLibraryDatasetPayload
450
451# Apply an application workflow step, such as "submit" or "approve"
452#
453# Arguments
454# input: Fields required to apply a application workflow step
455applicationWorkflow(input: ApplicationWorkflow): Application
456
457# Apply an application workflow step, such as "submit" or "approve"
458#
459# Arguments
460# input: Fields required to apply a engine workflow step
461engineWorkflow(input: EngineWorkflow): Engine
462
463# Creates a widget associated with a collection
464#
465# Arguments
466# input: Fields needed to create a new widget
467createWidget(input: CreateWidget): Widget
468
469# Updates a widget
470#
471# Arguments
472# input: Fields needed to update a widget
473updateWidget(input: UpdateWidget): Widget
474
475# Create a new user within an organization.
476#
477# Arguments
478# input: Fields needed to create a user.
479createUser(input: CreateUser): User
480
481# Create a new organization.
482#
483# Arguments
484# input: Fields needed to create an organization.
485createOrganization(input: CreateOrganization!): Organization
486
487# Update an existing user
488#
489# Arguments
490# input: Fields needed to update a user
491updateUser(input: UpdateUser): User
492
493# Add an existing user to an organization.
494# One of the user identifiers (userId or userName) has to be specified.
495#
496# Arguments
497# userId: UUID of user
498# userName: User name to uniquely identify a user
499# organizationGuid: UUID of organization
500# roleIds: Role Ids.
501# priority: Priority of the organization. If not provided, max
502# priority plus one will be used.
503addUserToOrganization(
504userId: ID,
505userName: String,
506organizationGuid: ID!,
507roleIds: [ID],
508priority: Int
509): User
510
511# Remove an existing user for organization.
512# One of the user identifiers (userId or userName) has to be specified.
513# The operation fails if the organization is the last one to which user belongs.
514#
515# Arguments
516# userId: UUID of user
517# userName: User name to uniquely identify a user
518# organizationGuid: UUID of organization
519removeUserFromOrganization(
520userId: ID,
521userName: String,
522organizationGuid: ID!
523): User
524
525# #Switch user to organization
526#
527# Arguments
528# token: User token that should be logout
529# userName: The user login name -- typically, email address.
530# organizationGuid: GUID of organization.
531switchUserToOrganization(
532token: String!,
533userName: String!,
534organizationGuid: ID!
535): LoginInfo
536
537# Force a user to update password on next login.
538# This mutation is used by administrators.
539#
540# Arguments
541# input: Fields needed to create a password update request
542createPasswordUpdateRequest(
543input: CreatePasswordUpdateRequest
544): User
545
546# Create a password reset request. This mutation is used on behalf
547# of a user who needs to reset their password. It operates only on
548# the currently authenicated user (based on the authentication token provided).
549createPasswordResetRequest(
550input: CreatePasswordResetRequest
551): CreatePasswordResetRequestPayload
552
553# Update the current authenticated user
554updateCurrentUser(input: UpdateCurrentUser!): User!
555
556# Get password token info for current user
557getCurrentUserPasswordToken(
558input: GetCurrentUserPasswordToken!
559): PasswordTokenInfo!
560
561# Change the current authenticated user's password
562#
563# Arguments
564# input: Fields needed to change password
565changePassword(input: ChangePassword!): User
566
567# Delete a user
568#
569# Arguments
570# id: Supply the ID of the user to delete.
571deleteUser(id: ID!): DeletePayload
572
573# Create a structured data registry schema metadata.
574createDataRegistry(input: CreateDataRegistry!): DataRegistry
575
576# Update a structured data registry schema metadata.
577updateDataRegistry(input: UpdateDataRegistry!): DataRegistry
578
579# Update a structured data registry schema.
580upsertSchemaDraft(input: UpsertSchemaDraft!): Schema
581
582updateSchemaState(input: UpdateSchemaState!): Schema
583
584# Create (ingest) a structured data object
585createStructuredData(input: CreateStructuredData!): StructuredData
586
587# Delete a structured data object
588deleteStructuredData(input: DeleteStructuredData!): DeletePayload
589
590# Create (ingest) a structured data object
591#
592# Arguments
593# input: Fields required to create new collection
594createCollection(input: CreateCollection): Collection
595
596# Update a collection
597#
598# Arguments
599# input: Fields needed to update a collection
600updateCollection(input: UpdateCollection): Collection
601
602# Delete Collection
603#
604# Arguments
605# id: Supply the ID of the folder or collection to delete
606deleteCollection(folderId: ID, id: ID): DeletePayload
607
608# Share a collection, allowing other organizations to view the data
609# it contains.
610#
611# Arguments
612# input: Fields needed to share a collection
613shareCollection(input: ShareCollection): Share
614
615# Arguments
616# shareId: ID of the shared collection to update
617# mentionIds: List of mentionIds to add or remove
618# type: Indicates whether or not the mentions are to be added or
619# deleted
620updateSharedCollectionMentions(
621shareId: String!,
622mentionIds: [ID!],
623type: SharedCollectionUpdateType!
624): Share
625
626updateSharedCollectionHistory(
627input: UpdateSharedCollectionHistory
628): SharedCollectionHistory
629
630# Share a mention from a collection
631#
632# Arguments
633# input: Fields needed to share a mention
634shareMentionFromCollection(
635input: ShareMentionFromCollection
636): Share
637
638# Share mention
639shareMention(input: ShareMention): Share
640
641# Share mentions in bulk
642shareMentionInBulk(input: ShareMentionInBulk): [Share]
643
644# Add a mention to a collection
645#
646# Arguments
647# input: Fields needed to add a mention to a collection
648createCollectionMention(input: CollectionMentionInput): CollectionMention
649
650# Arguments
651# input: Fields needed to add mentions to a collection
652createCollectionMentions(
653input: CreateCollectionMentions
654): [CollectionMention!]!
655
656# Update a mention in a collection
657#
658# Arguments
659# input: Fields needed to add mentions to a collection
660updateCollectionMention(
661input: UpdateCollectionMention!
662): CollectionMention!
663
664# Remove a mention from a collection
665#
666# Arguments
667# input: Fields needed to delete a mention from a collection
668deleteCollectionMention(input: CollectionMentionInput): CollectionMention
669
670# Create a new folder
671#
672# Arguments
673# input: Fields needed to create a new folder.
674createFolder(input: CreateFolder): Folder
675
676# Update an existing folder
677#
678# Arguments
679# input: Fields needed to update a folder.
680updateFolder(input: UpdateFolder): Folder
681
682# Move a folder from one parent folder to another.
683#
684# Arguments
685# input: Fields needed to move a folder
686moveFolder(input: MoveFolder): Folder
687
688# Delete a folder
689#
690# Arguments
691# input: Fields needed to delete a folder
692deleteFolder(input: DeleteFolder): DeletePayload
693
694# Create a mention comment
695#
696# Arguments
697# input: Fields needed to create a mention comment
698createMentionComment(input: CreateMentionComment): MentionComment
699
700# Update a mention comment
701#
702# Arguments
703# input: Fields needed to update a mention comment
704updateMentionComment(input: UpdateMentionComment): MentionComment
705
706# Delete a mention comment
707#
708# Arguments
709# input: Fields needed to delete a mention comment
710deleteMentionComment(input: DeleteMentionComment): DeletePayload
711
712# Create a mention rating
713#
714# Arguments
715# input: Fields needed to create a mention rating
716createMentionRating(input: CreateMentionRating): MentionRating
717
718# Update a mention rating
719#
720# Arguments
721# input: Fields needed to update a mention rating
722updateMentionRating(input: UpdateMentionRating): MentionRating
723
724# Delete a mention rating
725#
726# Arguments
727# input: Fields needed to delete a mention rating.
728deleteMentionRating(input: DeleteMentionRating): DeletePayload
729
730# Login as a user. This mutation does not require an existing authentication
731# context (via `Authorization` header with bearer token, cookie, etc.).
732# Instead, the client supplies credentials to this mutation, which then
733# authenticates the user and sets up the authentication context.
734# The returned tokens can be used to authenticate future requests.
735#
736# Arguments
737# input: Fields needed to log in
738userLogin(input: UserLogin): LoginInfo
739
740# Logout user and invalidate user token
741#
742# Arguments
743# token: User token that should be invalidated
744userLogout(token: String!): Boolean
745
746# Refresh a user token, returning a fresh token so that the client
747# can continue to authenticate to the API.\
748refreshToken(token: String!): LoginInfo
749
750# Validate a user token. This mutation is used by services to determine
751# if the token provided by a given client is valid.
752validateToken(token: String!): LoginInfo
753
754# Create a mention object
755createMention(input: CreateMention!): Mention
756
757# Update a mention object
758updateMention(input: UpdateMention!): Mention
759
760# Update a set of mentions
761updateMentions(input: UpdateMentions!): [Mention]
762
763# Create root folder for an organization
764#
765# Arguments
766# rootFolderType: The type of root folder to create
767createRootFolders(rootFolderType: RootFolderType): [Folder]
768
769# Apply bulk updates to watchlists.
770# This mutation is currently available only to Veritone operations.
771#
772# Arguments
773# filter: A filter indicating which watchlists should be updated.
774# At least one filter condition must be provided.
775# Only watchlists for the user's organization will be updated.
776# input: Fields used to update a watchlist.
777bulkUpdateWatchlist(
778filter: BulkUpdateWatchlistFilter!,
779input: BulkUpdateWatchlist
780): WatchlistList
781
782# File a TemporalDataObject in a folder. A given TemporalDataObject can
783# be filed in any number of folders, or none. Filing causes the TemporalDataObject
784# and its assets to be visible within the folder.
785#
786# Arguments
787# input: The fields needed to file a TemporalDataObject in a
788# folder
789fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
790
791# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
792# and its assets to disappear from the folder, but does not otherwise affect
793# either the TDO or the folder and does not change access controls.
794#
795# Arguments
796# input: The fields needed to file a TemporalDataObject in a
797# folder
798unfileTemporalDataObject(
799input: UnfileTemporalDataObject!
800): TemporalDataObject
801
802# Moves a TemporalDataObject from one parent folder to another.
803# Any other folders the TemporalDataObject is filed in are unaffected.
804#
805# Arguments
806# input: Fields need to move a TemporalDataObject
807moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
808
809# Upload and store an engine result. The result will be stored as an
810# asset associated with the target TemporalDataObject and the
811# task will be updated accordingly.
812# Use a multipart form POST to all this mutation.
813#
814# Arguments
815# input: Fields needed to upload and store an engine result
816uploadEngineResult(input: UploadEngineResult!): Asset
817
818createWatchlist(input: CreateWatchlist!): Watchlist
819
820updateWatchlist(input: UpdateWatchlist!): Watchlist
821
822deleteWatchlist(id: ID!): DeletePayload
823
824updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
825
826createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
827
828deleteCognitiveSearch(id: ID!): DeletePayload
829
830fileWatchlist(input: FileWatchlist!): Watchlist
831
832unfileWatchlist(input: UnfileWatchlist!): Watchlist
833
834# Share a folder with other organizations
835shareFolder(input: ShareFolderInput): Folder
836
837# Create a TDO and an asset with a single call
838#
839# Arguments
840# input: Input fields necessary to create the TDO and asset
841createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
842
843createSubscription(input: CreateSubscription!): Subscription
844
845updateSubscription(input: UpdateSubscription!): Subscription
846
847deleteSubscription(id: ID!): DeletePayload
848
849# Create trigger for events or types.
850createTriggers(input: CreateTriggers!): [Trigger]
851
852# Delete a registed trigger by ID.
853deleteTrigger(id: ID!): DeletePayload
854
855# Validates if an engine output conforms to the engine output guidelines
856validateEngineOutput(input: JSONData!): Boolean!
857
858# JWT tokens with a more limited scoped token to specific
859# resources to the recording, task, and job
860# and also has no organization association.
861getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
862
863# Verify JWT token
864verifyJWT(jwtToken: String!): VerifyJWTPayload
865
866# Create a new Saved Search
867createSavedSearch(input: CreateSavedSearch!): SavedSearch!
868
869# Delete a saved search
870deleteSavedSearch(id: ID!): DeletePayload!
871
872# Mark existing saved search profile as deleted
873# Create new saved search profile
874replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
875
876# Send a basic email. Mutation returns true for a success message.
877sendEmail(input: SendEmail!): Boolean!
878
879# Create new content template into a folder
880createFolderContentTempate(
881input: CreateFolderContentTempate!
882): FolderContentTemplate!
883
884# Update existing content template by folderContentTemplateId
885updateFolderContentTempate(
886input: UpdateFolderContentTempate!
887): FolderContentTemplate!
888
889# Delete existing folder content template by folderContentTemplateId
890#
891# Arguments
892# id: Folder Content Template Id
893deleteFolderContentTempate(id: ID!): DeletePayload!
894
895# Create an export request. The requested TDO data, possibly including
896# TDO media and engine results, will be exported offline.
897#
898# Arguments
899# input: Input data required to create the export request
900createExportRequest(input: CreateExportRequest!): ExportRequest!
901
902# Update an export request
903#
904# Arguments
905# input: Input data required to update an export request
906updateExportRequest(input: UpdateExportRequest!): ExportRequest!
907
908# Create Mention in bulk. The input should be an array of createMentions
909createMentions(input: CreateMentions!): MentionList
910
911# Create Media Share. Returning the url of the share
912createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
913
914# Create or Update Workflow data.
915setWorkflowRuntimeStorageData(
916workflowRuntimeId: ID!,
917input: CreateWorkflowRuntimeStorageData!
918): WorkflowRuntimeStorageData!
919
920# Create a new event
921createEvent(input: CreateEvent!): Event!
922
923# Update an event
924updateEvent(input: UpdateEvent!): Event!
925
926# Subscribe to an event
927subscribeEvent(input: SubscribeEvent!): ID!
928
929# Unsubscribe to an event
930unsubscribeEvent(id: ID!): UnsubscribeEvent!
931
932# Emit an event
933emitEvent(input: EmitEvent!): EmitEventResponse!
934
935# Create a new event trigger template
936createEventActionTemplate(
937input: CreateEventActionTemplate!
938): EventActionTemplate!
939
940# Update an event trigger template
941updateEventActionTemplate(
942input: UpdateEventActionTemplate!
943): EventActionTemplate!
944
945# Create a new event custom rule
946createEventCustomRule(input: CreateEventCustomRule!): EventCustomRule!
947
948# Update an event custom rule
949updateEventCustomRule(input: UpdateEventCustomRule!): EventCustomRule!
950
951# Delete an event custom rule
952deleteEventCustomRule(id: ID!): DeletePayload!
953
954# Start a Veritone Workflow instance
955startWorkflowRuntime(
956workflowRuntimeId: ID!,
957orgId: ID!,
958generateAuthToken: Boolean
959): WorkflowRuntimeResponse!
960
961# Shutdown Veritone Workflow instance
962stopWorkflowRuntime(workflowRuntimeId: ID!): WorkflowRuntimeResponse!
963
964# Create a processTemplate in CMS
965createProcessTemplate(input: CreateProcessTemplate!): ProcessTemplate!
966
967# Update a processTemplate by ID in CMS
968updateProcessTemplate(input: UpdateProcessTemplate!): ProcessTemplate!
969
970# Delete a processTemplate by ID in CMS
971deleteProcessTemplate(id: ID!): DeletePayload!
972
973# Create a mention export request. The requested mentionFilters including
974# The mention export file csv will be exported offline.
975#
976# Arguments
977# input: Input data required to create the export request
978createMentionExportRequest(
979input: CreateMentionExportRequest!
980): ExportRequest!
981
982# Update status or assetURI of a mentionExportRequest
983# Often use when the file export was completed or downloaded
984updateMentionExportRequest(
985input: UpdateMentionExportRequest!
986): ExportRequest!
987
988# Create a creative
989createCreative(input: CreateCreative!): Creative!
990
991# Update a creative
992updateCreative(input: UpdateCreative!): Creative!
993
994# Delete a creative
995deleteCreative(id: ID!): DeletePayload!
996
997# Emit a system-level emit. This mutation is used only by
998# Veritone platform components.
999#
1000# Arguments
1001# input: Data required to create the event
1002emitSystemEvent(input: EmitSystemEvent!): SystemEventInfo!
1003
1004# Creates an immutable audit log event with the given payload
1005emitAuditEvent(input: EmitAuditEvent!): AuditEvent!
1006
1007createContextMenuExtension(
1008input: CreateContextMenuExtension!
1009): ContextMenuExtension!
1010
1011updateContextMenuExtension(
1012input: UpdateContextMenuExtension!
1013): ContextMenuExtension!
1014
1015deleteContextMenuExtension(
1016input: DeleteContextMenuExtension!
1017): DeletePayload!
1018
1019# Add or update an organization integration config by
1020# organization id and integration id
1021setOrganizationIntegrationConfig(
1022input: SetOrganizationIntegrationConfig!
1023): IntegrationConfig!
1024
1025# Delete an integration config
1026deleteOrganizationIntegrationConfig(
1027input: DeleteOrganizationIntegrationConfig!
1028): DeleteIntegrationConfigPayload!
1029
1030# Arguments
1031# input: Data required to create the event
1032updateUserStatus(input: UpdateUserStatus!): User!
1033
1034# Create a custom dashboard
1035createCustomDashboard(input: CreateCustomDashboard): CustomDashboard
1036
1037# Update a custom dashboard
1038updateCustomDashboard(input: UpdateCustomDashboard): CustomDashboard
1039
1040# Delete a custom dashboard
1041deleteCustomDashboard(id: ID!): DeletePayload
1042
1043# Create a Dataset
1044createDataset(input: DatasetInput!): Dataset
1045
1046createDatasetSchema(input: CreateDatasetSchema!): Dataset
1047
1048# Update a Dataset
1049updateDataset(id: ID!, input: DatasetInput): Dataset
1050
1051# Delete a Dataset
1052deleteDataset(id: ID!): DeleteDatasetPayload!
1053
1054# Perform Dataset Operations
1055#
1056# Arguments
1057# id: Specify the Dataset ID for the operation to be performed
1058datasetDataOperation(
1059id: ID!,
1060actions: [DatasetActionInput!],
1061async: Boolean,
1062updateMetrics: Boolean
1063): DatasetStateInfo
1064
1065createFlowTemplate(input: CreateFlowTemplate): FlowTemplate
1066
1067updateFlowTemplate(input: UpdateFlowTemplate): FlowTemplate
1068
1069deleteFlowTemplate(id: ID!): FlowTemplate
1070
1071createFlowRevision(input: CreateFlowRevision): FlowRevision
1072
1073updateFlowRevision(input: UpdateFlowRevision): FlowRevision
1074
1075createFlowExecution(input: CreateFlowExecution): FlowExecution
1076
1077updateFlowExecution(input: UpdateFlowExecution): FlowExecution
1078
1079updateFlowRevisionHead(input: UpdateFlowRevisionHead): FlowRevision
1080
1081deployFlowRevision(input: DeployFlowRevision): FlowRevision
1082
1083createFlowFromTemplate(input: CreateFlowFromTemplate): FlowFromTemplate
1084
1085createFlow(input: CreateFlow): Engine
1086
1087updateFlow(input: CreateEngine): Engine
1088
1089copyFlow(input: CopyFlow): Engine
1090
1091deleteFlow(input: DeleteFlow): Engine
1092
1093pauseFlow(input: pauseFlow): Engine
1094
1095unpauseFlow(input: pauseFlow): Engine
1096
1097addTaskReplacementEngine(
1098input: AddTaskReplacementEngine
1099): TaskEngineReplacement
1100
1101removeTaskReplacementEngine(
1102input: RemoveTaskReplacementEngine
1103): DeletePayload
1104
1105# Create a custom notification mailbox
1106notificationMailboxCreate(
1107input: NotificationMailboxInput
1108): NotificationMailbox
1109
1110# Pause a notification mailbox
1111notificationMailboxPause(id: ID!): NotificationMailbox
1112
1113# Delete a notification mailbox
1114notificationMailboxDelete(id: ID!): DeletePayload!
1115
1116# Post a notification to some mailboxes
1117notificationPost(input: NotificaionPostInput): Notification
1118
1119# Add a new notification template by eventName, eventType, application
1120addNotificationTemplate(input: AddNotificationTemplate): NotificationTemplate
1121
1122# Remove a notification template by id
1123removeNotificationTemplate(id: ID!): DeletePayload!
1124
1125# Add a new notification action by eventName, eventType, application
1126addNotificationAction(input: AddNotificationAction): NotificationAction
1127
1128# Remove a notification action by id
1129removeNotificationAction(id: ID!): DeletePayload!
1130
1131# Set and unset the notification flags
1132setNotificationFlag(input: SetNotificationFlag): Notification
1133
1134# Unpause/resume a notification mailbox
1135notificationMailboxUnpause(id: ID!): NotificationMailbox
1136
1137# Mark all notification as read for mailboxIds
1138markAllNotificationsRead(mailboxIds: [ID]!): [NotificationMailbox]
1139
1140# Mark all notification as read for mailboxIds
1141markAllNotificationsSeen(mailboxIds: [ID]!): [NotificationMailbox]
1142
1143# Create the default user setting definition for application by current
1144# organization
1145#
1146# Arguments
1147# organizationGuid: Should be required by orgless token,
1148# or can be set by superadmin
1149createUserSettingDefinition(
1150application: ID!,
1151key: String!,
1152type: String!,
1153description: String,
1154defaultValue: String!,
1155organizationGuid: ID
1156): ApplicationSetting
1157
1158# Delete the default user setting definition for application and org
1159#
1160# Arguments
1161# organizationGuid: Should be required by orgless token,
1162# or can be set by superadmin
1163deleteUserSettingDefinition(
1164application: ID!,
1165organizationGuid: ID,
1166key: String!
1167): DeletePayload!
1168
1169# Update setting for user (add/update/remove settings)
1170updateUserSetting(input: UpdateUserSetting): UserSetting
1171
1172}

link Required by

This element is not required by anyone