Mutation Methods

The table below provides a quick summary of GraphQL mutation methods, alphabetized by name.

Click any name to see the complete method signature and other info.

Method name	Short Description
addLibraryDataset	Add recordings to a dataset library
addMediaSegment	Add a single media segment to a TemporalDataObject
addTasksToJobs	Add tasks to jobs
addToEngineBlacklist	Add to engine blacklist
addToEngineWhitelist	Add to engine whitelist
applicationWorkflow	Apply an application workflow step, such as "submit" or "approve"
bulkDeleteContextMenuExtensions	Bulk delete context meu extensions
bulkUpdateWatchlist	Apply bulk updates to watchlists
cancelJob	Cancel a job
changePassword	Change the current authenticated user's password
cleanupTDO	Delete partial information from a temporal data object
createApplication	Create a new application
createAsset	Create a media asset
createCognitiveSearch	Create cognitive search
createCollection	Create (ingest) a structured data object
createCollectionMention	Add a mention to a collection
createCollectionMentions	Create collection mentions
createCreative	Create a creative
createDataRegistry	Create a structured data registry schema metadata
createEngine	Create a new engine
createEngineBuild	Create an engine build
createEntity	Create a new entity
createEntityIdentifier	Create an entity identifier
createEntityIdentifierType	Create an entity identifier type, such as "face" or "image"
createEvent	Create a new event
createExportRequest	Create an export request
createFolder	Create a new folder
createFolderContentTempate	Create new content template into a folder
createIngestionConfiguration	Create an ingestion configuration
createJob	Create a job
createLibrary	Create a new library
createLibraryConfiguration	Create Dataset Library Configuration
createLibraryEngineModel	Create a library engine model
createLibraryType	Create a library type, such as "ad" or "people"
createMediaShare	Create Media Share
createMention	Create a mention object
createMentionComment	Create a mention comment
createMentionExportRequest	Create a mention export request
createMentionRating	Create a mention rating
createMentions	Create Mention in bulk
createOrganization	Create a new organization
createPasswordResetRequest	Create a password reset request
createPasswordUpdateRequest	Force a user to update password on next login
createProcessTemplate	Create a processTemplate in Data Center
createRootFolders	Create root folder for an organization
createSavedSearch	Create a new Saved Search
createStructuredData	Create (ingest) a structured data object
createSubscription	Create subscription
createTDO	Create a new temporal data object
createTDOWithAsset	Create a TDO and an asset with a single call
createTaskLog	Create a task log by using multipart form POST
createTriggers	Create trigger for events or types
createUser	Create a new user within an organization
createWatchlist	Create watchlist
createWidget	Creates a widget associated with a collection
deleteApplication	Delete an application
deleteAsset	Delete an asset
deleteCognitiveSearch	Delete cognitive search
deleteCollection	Delete Collection
deleteCollectionMention	Remove a mention from a collection
deleteCreative	Delete a creative
deleteEngine	Delete an engine
deleteEngineBuild	Delete an engine build
deleteEntity	Delete an entity
deleteEntityIdentifier	Delete an entity identifier
deleteFolder	Delete a folder
deleteFolderContentTempate	Delete existing folder content template by folderContentTemplateId
deleteFromEngineBlacklist	Delete from engine blacklist
deleteFromEngineWhitelist	Delete from engine whitelist
deleteIngestionConfiguration	Delete an ingestion configuration
deleteLibrary	Delete a library
deleteLibraryConfiguration	Delete Dataset Library Configuration
deleteLibraryDataset	Remove recordings from a dataset library
deleteLibraryEngineModel	Delete a library engine model
deleteMentionComment	Delete a mention comment
deleteMentionRating	Delete a mention rating
deleteProcessTemplate	Delete a processTemplate by ID in Data Center
deleteSavedSearch	Delete a saved search
deleteStructuredData	Delete a structured data object
deleteSubscription	Delete subscription
deleteTDO	Delete a temporal data object
deleteTrigger	Delete a registed trigger by ID
deleteUser	Delete a user
deleteWatchlist	Delete watchlist
emitEvent	Emit an event
emitSystemEvent	Emit a system-level emit
engineWorkflow	Apply an application workflow step, such as "submit" or "approve"
fileTemporalDataObject	File a TemporalDataObject in a folder
fileWatchlist	File watchlist
getCurrentUserPasswordToken	Get password token info for current user
getEngineJWT	JWT tokens with a more limited scoped token to specific resources to the recording, task, and job and also has no organization association
moveFolder	Move a folder from one parent folder to another
moveTemporalDataObject	Moves a TemporalDataObject from one parent folder to another
pollTask	Poll a task
publishLibrary	Publish a new version of a library
refreshToken	Refresh a user token, returning a fresh token so that the client can continue to authenticate to the API
replaceSavedSearch	Mark existing saved search profile as deleted Create new saved search profile
requestClone	Start a clone job
retryJob	Retry a job
sendEmail	Send a basic email
setWorkflowRuntimeStorageData	Create or Update Workflow data
shareCollection	Share a collection, allowing other organizations to view the data it contains
shareFolder	Share a folder with other organizations
shareMention	Share mention
shareMentionFromCollection	Share a mention from a collection
shareMentionInBulk	Share mentions in bulk
startWorkflowRuntime	Start a Veritone Workflow instance
stopWorkflowRuntime	Shutdown Veritone Workflow instance
subscribeEvent	Subscribe to an event
unfileTemporalDataObject	Unfile a TemporalDataObject from a folder
unfileWatchlist	Unfile watchlist
unsubscribeEvent	Unsubscribe to an event
updateApplication	Update a custom application
updateAsset	Update an asset
updateCognitiveSearch	Update cognitive search
updateCollection	Update a collection
updateCreative	Update a creative
updateCurrentUser	Update the current authenticated user
updateDataRegistry	Update a structured data registry schema metadata
updateEngine	Update an engine
updateEngineBuild	Update an engine build
updateEntity	Update an entity
updateEntityIdentifier	Update entity identifier
updateEntityIdentifierType	Update an entity identifier type
updateEvent	Update an event
updateExportRequest	Update an export request
updateFolder	Update an existing folder
updateFolderContentTempate	Update existing content template by folderContentTemplateId
updateIngestionConfiguration	Update an ingestion configuration
updateJobs	Update jobs
updateLibrary	Update an existing library
updateLibraryConfiguration	Update Dataset Library Configuration
updateLibraryEngineModel	Update a library engine model
updateLibraryType	Update a library type
updateMention	Update a mention object
updateMentionComment	Update a mention comment
updateMentionExportRequest	Update status or assetURI of a mentionExportRequest Often use when the file export was completed or downloaded
updateMentionRating	Update a mention rating
updateMentions	Update a set of mentions
updateOrganization	Update an organization
updateProcessTemplate	Update a processTemplate by ID in Data Center
updateSchemaState	Update schema state
updateSharedCollectionHistory	Update shared collection history
updateSharedCollectionMentions	Update shared collection mentions
updateSubscription	Update subscription
updateTDO	Update a temporal data object
updateTask	Update a task
updateUser	Update an existing user
updateWatchlist	Update watchlist
updateWidget	Updates a widget
uploadEngineResult	Upload and store an engine result
upsertSchemaDraft	Update a structured data registry schema
userLogin	Login as a user
userLogout	Logout user and invalidate user token
validateEngineOutput	Validates if an engine output conforms to the engine output guidelines
validateToken	Validate a user token
verifyJWT	Verify JWT token

addLibraryDataset

Add recordings to a dataset library.

Arguments

input:

addLibraryDataset(input: AddLibraryDataset!): LibraryDataset

See also: AddLibraryDataset, LibraryDataset

---

addTasksToJobs

Arguments input:

Arguments

addTasksToJobs(input: AddTasksToJobs): AddTasksToJobsResponse

See also: AddTasksToJobs, AddTasksToJobsResponse

---

addToEngineBlacklist

Arguments toAdd:

Arguments

addToEngineBlacklist(toAdd: SetEngineBlacklist!): EngineBlacklist

See also: SetEngineBlacklist, EngineBlacklist

---

addToEngineWhitelist

Arguments toAdd:

Arguments

addToEngineWhitelist(toAdd: SetEngineWhitelist!): EngineWhitelist

See also: SetEngineWhitelist, EngineWhitelist

---

applicationWorkflow

Apply an application workflow step, such as "submit" or "approve."

Arguments

input: Fields required to apply an application workflow step

applicationWorkflow(input: ApplicationWorkflow): Application

See also: ApplicationWorkflow, Application

---

bulkDeleteContextMenuExtensions

Bulk delete context menu extensions.

Arguments

input:

bulkDeleteContextMenuExtensions(
  input: BulkDeleteContextMenuExtensions
): ContextMenuExtensionList

See also: BulkDeleteContextMenuExtensions, ContextMenuExtensionList

---

bulkUpdateWatchlist

Apply bulk updates to watchlists. This mutation is currently available only to Veritone operations.

Arguments

filter: A filter indicating which watchlists should be updated.

At least one filter condition must be provided.

Only watchlists for the user's organization will be updated.

input: Fields used to update a watchlist.

bulkUpdateWatchlist(
  filter: BulkUpdateWatchlistFilter!,
  input: BulkUpdateWatchlist
): WatchlistList

See also: BulkUpdateWatchlistFilter, BulkUpdateWatchlist, WatchlistList

---

cancelJob

Cancel a job. This action effectively deletes the job, although records of job and task execution remain in Veritone's database.

Arguments

id: Supply the ID of the job to delete.

cancelJob(id: ID!): DeletePayload

See also: ID, DeletePayload

---

changePassword

Change the current authenticated user's password

Arguments

input: Fields needed to change password

changePassword(input: ChangePassword!): User

See also: ChangePassword, User

---

cleanupTDO

Delete partial information from a temporal data object. Use the delete options to control exactly which data is deleted. The default is to delete objects from storage and the search index, while leaving TDO-level metadata and task engine results intact. To permanently delete the TDO, use delete TDO.

Arguments

id: Supply the ID of the TDO to clean up.

options: Supply a list of cleanup options. See TDOCleanupOption for details. If not provided, the server will use default settings.

cleanupTDO(id: ID!, options: [TDOCleanupOption!]): DeletePayload

See also: ID, TDOCleanupOption, DeletePayload

---

createApplication

Create a new application. An application must go through a sequence of workflow steps before it is available in production. See the the Veritone Developer Application documentation for details.

Arguments

input: Fields needed to create a new custom application.

createApplication(input: CreateApplication): Application

See also:CreateApplication, Application

---

createAsset

Create a media asset. Optionally, upload content using multipart form POST.

Arguments

input: Fields needed to create an asset.

createAsset(input: CreateAsset!): Asset

See also: CreateAsset, Asset

---

createCognitiveSearch

Arguments

input:

createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch

See also:
CreateCognitiveSearch, CognitiveSearch

---

createCollection

Create (ingest) a structured data object.

Arguments

input: Fields required to create a new collection.

createCollection(input: CreateCollection): Collection

See also: CreateCollection, Collection

---

createCollectionMention

Add a mention to a collection.

Arguments

input: Fields needed to add a mention to a collection.

createCollectionMention(input: CollectionMentionInput): CollectionMention

See also: CollectionMentionInput, CollectionMention

---

createCreative

Create a creative

Arguments

input:

createCreative(input: CreateCreative!): Creative!

See also: CreateCreative, Creative

---

createDataRegistry

Create a structured data registry schema metadata.

Arguments

input:

createDataRegistry(input: CreateDataRegistry!): DataRegistry

See also: CreateDataRegistry, DataRegistry

---

createEngine

Create a new engine. The engine needs to go through a sequence of workflow steps before use in production. See the Veritone Developer Application documentation for details.

Arguments

input: Fields needed to create a new engine

createEngine(input: CreateEngine): Engine

See also: CreateEngine, Engine

---

createEngineBuild

Create an engine build.

Arguments

input: Fields needed to create an engine build.

createEngineBuild(input: CreateBuild!): Build

See also: CreateBuild, Build

---

createEntity

Create a new entity.

Arguments

input: Fields required to create a new entity.

createEntity(input: CreateEntity!): Entity

See also: CreateEntity, Entity

---

createEntityIdentifier

Create an entity identifier. This mutation accepts file uploads. To use this mutation and upload a file, send a multipart form POST containing two parameters: query, with the GraphQL query, and file containing the file itself. For more information see the documentation at https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL.

Arguments

input: Fields needed to create an entity identifier.

createEntityIdentifier(input: CreateEntityIdentifier!): EntityIdentifier

See also:CreateEntityIdentifier, EntityIdentifier

---

createEntityIdentifierType

Create an entity identifier type, such as "face" or "image". Entity identifier types are typically created or modified only by Veritone engineering. Most libraries and entities will use existing entity identifier types.

Arguments

input: Fields required to create an entity identifier type.

createEntityIdentifierType(
  input: CreateEntityIdentifierType!
): EntityIdentifierType

See also: CreateEntityIdentifierType, EntityIdentifierType

---

createEvent

Create a new event.

Arguments

input:

createEvent(input: CreateEvent!): Event!

See also: CreateEvent, Event

---

createExportRequest

Create an export request. The requested TDO data, possibly including TDO media and engine results, is exported offline.

Arguments

input: Input data required to create the export request

createExportRequest(input: CreateExportRequest!): ExportRequest!

See also: CreateExportRequest, ExportRequest

---

createFolder

Create a new folder.

Arguments

input: Fields needed to create a new folder.

createFolder(input: CreateFolder): Folder

See also:CreateFolder, Folder

---

createFolderContentTemplate

Create a new content template in a folder.

Arguments

input:

createFolderContentTemplate(
  input: CreateFolderContentTemplate!
): FolderContentTemplate!

See also: CreateFolderContentTempate, FolderContentTemplate

---

createIngestionConfiguration

Create an ingestion configuration.

Arguments

input:

createIngestionConfiguration(
  input: CreateIngestionConfiguration
): IngestionConfiguration

See also: CreateIngestionConfiguration, IngestionConfiguration

---

createJob

Create a job.

Arguments

input: Fields required to create a job.

createJob(input: CreateJob): Job

See also:
CreateJob, Job

---

createLibrary

Create a new library. Once the library is created, the client can add entities and entity identifiers. Note that the library type determines what types of entity identifiers can be used within the library.

Arguments

input: Fields needed to create a new library.

createLibrary(input: CreateLibrary!): Library

See also:
CreateLibrary, Library

---

createLibraryConfiguration

Create Dataset Library Configuration

Arguments

input: Fields required to create library configuration

createLibraryConfiguration(
  input: CreateLibraryConfiguration!
): LibraryConfiguration

See also:
CreateLibraryConfiguration, LibraryConfiguration

---

createLibraryEngineModel

Create a library engine model.

Arguments

input: Fields required to create a library engine model.

createLibraryEngineModel(
  input: CreateLibraryEngineModel!
): LibraryEngineModel

See also:
CreateLibraryEngineModel, LibraryEngineModel

---

createLibraryType

Create a library type, such as "ad" or "people". Entity identifier types are typically created or modified only by Veritone engineering. Most libraries will use existing entity identifier types.

Arguments

input: Fields needed to create a new library type.

createLibraryType(input: CreateLibraryType!): LibraryType

See also:CreateLibraryType, LibraryType

---

createMediaShare

Create Media Share. Returning the url of the share

Arguments

input:

createMediaShare(input: CreateMediaShare!): CreatedMediaShare!

See also:CreateMediaShare, CreatedMediaShare

---

createMention

Create a mention object

Arguments

input:

createMention(input: CreateMention!): Mention

See also:CreateMention, Mention

---

createMentionComment

Create a mention comment

Arguments

input: Fields needed to create a mention comment

createMentionComment(input: CreateMentionComment): MentionComment

See also:CreateMentionComment, MentionComment

---

createMentionExportRequest

Create a mention export request. The requested mentionFilters including The mention export file csv will be exported offline.

Arguments

input: Input data required to create the export request

createMentionExportRequest(
  input: CreateMentionExportRequest!
): ExportRequest!

See also:CreateMentionExportRequest, ExportRequest

---

createMentionRating

Create a mention rating

Arguments

input: Fields needed to create a mention rating

createMentionRating(input: CreateMentionRating): MentionRating

See also:
CreateMentionRating, MentionRating

---

createMentions

Create Mention in bulk. The input should be an array of createMentions

Arguments

input:

createMentions(input: CreateMentions!): MentionList

See also:
CreateMentions, MentionList

---

createOrganization

Create a new organization.

Arguments

input: Fields needed to create an organization.

createOrganization(input: CreateOrganization!): Organization

See also:
CreateOrganization, Organization

---

createPasswordResetRequest

Create a password reset request. This mutation is used on behalf of a user who needs to reset their password. It operates only on the currently authenicated user (based on the authentication token provided).

Arguments

input:

createPasswordResetRequest(
  input: CreatePasswordResetRequest
): CreatePasswordResetRequestPayload

See also:
CreatePasswordResetRequest, CreatePasswordResetRequestPayload

---

createPasswordUpdateRequest

Force a user to update password on next login. This mutation is used by administrators.

Arguments

input: Fields needed to create a password update request

createPasswordUpdateRequest(
  input: CreatePasswordUpdateRequest
): User

See also:
CreatePasswordUpdateRequest, User

---

createProcessTemplate

Create a processTemplate in {{cms}}

Arguments

input:

createProcessTemplate(input: CreateProcessTemplate!): ProcessTemplate!

See also:
CreateProcessTemplate, ProcessTemplate

---

createRootFolders

Create root folder for an organization

Arguments

rootFolderType: The type of root folder to create

createRootFolders(rootFolderType: RootFolderType): [Folder]

See also:
RootFolderType, Folder

---

createSavedSearch

Create a new Saved Search

Arguments

input:

createSavedSearch(input: CreateSavedSearch!): SavedSearch!

See also:
CreateSavedSearch, SavedSearch

---

createStructuredData

Create (ingest) a structured data object

Arguments

input:

createStructuredData(input: CreateStructuredData!): StructuredData

See also:
CreateStructuredData, StructuredData

---

createSubscription

Arguments

input:

createSubscription(input: CreateSubscription!): Subscription

See also:
CreateSubscription, Subscription

---

createTDO

Create a new temporal data object

Arguments

input: Fields required to create a TDO

createTDO(input: CreateTDO): TemporalDataObject

See also:
CreateTDO, TemporalDataObject

---

createTDOWithAsset

Create a TDO and an asset with a single call

Arguments

input: Input fields necessary to create the TDO and asset

createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject

See also:
CreateTDOWithAsset, TemporalDataObject

---

createTaskLog

Create a task log by using multipart form POST.

Arguments

input: Fields needed to create a task log.

createTaskLog(input: CreateTaskLog!): TaskLog

See also:
CreateTaskLog, TaskLog

---

createTriggers

Create trigger for events or types.

Arguments

input:

createTriggers(input: CreateTriggers!): [Trigger]

See also:
CreateTriggers, Trigger

---

createUser

Create a new user within an organization.

Arguments

input: Fields needed to create a user.

createUser(input: CreateUser): User

See also:
CreateUser, User

---

createWatchlist

Arguments

input:

createWatchlist(input: CreateWatchlist!): Watchlist

See also:
CreateWatchlist, Watchlist

---

createWidget

Creates a widget associated with a collection

Arguments

input: Fields needed to create a new widget

createWidget(input: CreateWidget): Widget

See also:
CreateWidget, Widget

---

deleteApplication

Delete an application

Arguments

id: Supply the ID of the application to delete.

deleteApplication(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteAsset

Delete an asset

Arguments

id: Provide the ID of the asset to delete.

deleteAsset(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteCognitiveSearch

Arguments

id:

deleteCognitiveSearch(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteCollection

Delete Collection

Arguments

folderId: @deprecated(reason: "folderId has been renamed to id. Use id.")

id: Supply the ID of the folder or collection to delete

deleteCollection(folderId: ID, id: ID): DeletePayload

See also:
ID, ID, DeletePayload

---

deleteCollectionMention

Remove a mention from a collection

Arguments

input: Fields needed to delete a mention from a collection

deleteCollectionMention(input: CollectionMentionInput): CollectionMention

See also:
CollectionMentionInput, CollectionMention

---

deleteCreative

Delete a creative

Arguments

id:

deleteCreative(id: ID!): DeletePayload!

See also:
ID, DeletePayload

---

deleteEngine

Delete an engine

Arguments

id: Provide the ID of the engine to delete

deleteEngine(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteEngineBuild

Delete an engine build

Arguments

input: Fields needed to delete an engine build.

deleteEngineBuild(input: DeleteBuild!): DeletePayload

See also:
DeleteBuild, DeletePayload

---

deleteEntity

Delete an entity. This mutation will also delete all associated entity identifiers and associated objects.

Arguments

id: Supply the ID of the entity to delete.

deleteEntity(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteEntityIdentifier

Delete an entity identifier

Arguments

id: Supply the ID of the entity identifier to delete.

deleteEntityIdentifier(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteFolder

Delete a folder

Arguments

input: Fields needed to delete a folder

deleteFolder(input: DeleteFolder): DeletePayload

See also:
DeleteFolder, DeletePayload

---

deleteFolderContentTempate

Delete existing folder content template by folderContentTemplateId

Arguments

id: Folder Content Template Id

deleteFolderContentTempate(id: ID!): DeletePayload!

See also:
ID, DeletePayload

---

deleteFromEngineBlacklist

Arguments

toDelete:

deleteFromEngineBlacklist(
  toDelete: SetEngineBlacklist!
): EngineBlacklist

See also:
SetEngineBlacklist, EngineBlacklist

---

deleteFromEngineWhitelist

Arguments

toDelete:

deleteFromEngineWhitelist(
  toDelete: SetEngineBlacklist!
): EngineWhitelist

See also:
SetEngineBlacklist, EngineWhitelist

---

deleteIngestionConfiguration

Delete an ingestion configuration

Arguments

id: ID of the ingestion configuration to delete

deleteIngestionConfiguration(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteLibrary

Delete a library. This mutation will also delete all entities, entity identifiers, library engine models, and associated objects.

Arguments

id: Provide the ID of the library to delete.

deleteLibrary(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteLibraryConfiguration

Delete Dataset Library Configuration

Arguments

id: Supply configuration ID to delete.

deleteLibraryConfiguration(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteLibraryDataset

Remove recordings from a dataset library

Arguments

input:

deleteLibraryDataset(input: DeleteLibraryDataset!): DeleteLibraryDatasetPayload

See also:
DeleteLibraryDataset, DeleteLibraryDatasetPayload

---

deleteLibraryEngineModel

Delete a library engine model

Arguments

id: Supply the ID of the library engine model to delete.

deleteLibraryEngineModel(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteMentionComment

Delete a mention comment

Arguments

input: Fields needed to delete a mention comment

deleteMentionComment(input: DeleteMentionComment): DeletePayload

See also:
DeleteMentionComment, DeletePayload

---

deleteMentionRating

Delete a mention rating

Arguments

input: Fields needed to delete a mention rating.

deleteMentionRating(input: DeleteMentionRating): DeletePayload

See also:
DeleteMentionRating, DeletePayload

---

deleteSavedSearch

Delete a saved search

Arguments

id:

deleteSavedSearch(id: ID!): DeletePayload!

See also:
ID, DeletePayload

---

deleteStructuredData

Delete a structured data object

Arguments

input:

deleteStructuredData(input: DeleteStructuredData!): DeletePayload

See also:
DeleteStructuredData, DeletePayload

---

deleteSubscription

Arguments

id:

deleteSubscription(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteTDO

Delete a temporal data object. The TDO metadata, its assets and all storage objects, and search index data are deleted. Engine results stored in related task objects are not. cleanupTDO can be used to selectively delete certain data on the TDO.

Arguments

id: Supply the ID of the TDO to delete

deleteTDO(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteTrigger

Delete a registed trigger by ID.

Arguments

id:

deleteTrigger(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteUser

Delete a user.

Arguments

id: Supply the ID of the user to delete.

deleteUser(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

deleteWatchlist

Arguments

id:

deleteWatchlist(id: ID!): DeletePayload

See also:
ID, DeletePayload

---

emitEvent

Emit an event.

Arguments

input:

emitEvent(input: EmitEvent!): EmitEventResponse!

See also:
EmitEvent, EmitEventResponse

---

emitSystemEvent

Emit a system-level emit. This mutation is used only by Veritone platform components.

Arguments

input: Data required to create the event

emitSystemEvent(input: EmitSystemEvent!): SystemEventInfo!

See also:
EmitSystemEvent, SystemEventInfo

---

engineWorkflow

Apply an application workflow step, such as "submit" or "approve"

Arguments

input: Fields required to apply a engine workflow step

engineWorkflow(input: EngineWorkflow): Engine

See also:
EngineWorkflow, Engine

---

fileTemporalDataObject

File a TemporalDataObject in a folder. A given TemporalDataObject can be filed in any number of folders, or none. Filing causes the TemporalDataObject and its assets to be visible within the folder.

Arguments

input: The fields needed to file a TemporalDataObject in a folder

fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject

See also:
FileTemporalDataObject, TemporalDataObject

---

fileWatchlist

Arguments

input:

fileWatchlist(input: FileWatchlist!): Watchlist

See also:
FileWatchlist, Watchlist

---

getCurrentUserPasswordToken

Get password token info for current user

Arguments

input:

getCurrentUserPasswordToken(
  input: GetCurrentUserPasswordToken!
): PasswordTokenInfo!

See also:
GetCurrentUserPasswordToken, PasswordTokenInfo

---

getEngineJWT

JWT tokens with a more limited scoped token to specific resources to the recording, task, and job and also has no organization association.

Arguments

input:

getEngineJWT(input: getEngineJWT!): JWTTokenInfo!

See also:
getEngineJWT, JWTTokenInfo

---

moveFolder

Move a folder from one parent folder to another.

Arguments

input: Fields needed to move a folder

moveFolder(input: MoveFolder): Folder

See also:
MoveFolder, Folder

---

moveTemporalDataObject

Moves a TemporalDataObject from one parent folder to another. Any other folders the TemporalDataObject is filed in are unaffected.

Arguments

input: Fields need to move a TemporalDataObject

moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject

See also:
MoveTemporalDataObject, TemporalDataObject

---

pollTask

Poll a task

Arguments

input: Fields required to poll a task.

pollTask(input: PollTask): Task

See also:
PollTask, Task

---

publishLibrary

Publish a new version of a library. Increments library version by one and trains compatible engines.

Arguments

id: ID of the library to publish

publishLibrary(id: ID!): Library

See also:
ID, Library

---

refreshToken

Refresh a user token, returning a fresh token so that the client can continue to authenticate to the API.

Arguments

token:

refreshToken(token: String!): LoginInfo

See also:
String, LoginInfo

---

replaceSavedSearch

Mark existing saved search profile as deleted Create new saved search profile

Arguments

input:

replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!

See also:
ReplaceSavedSearch, SavedSearch

---

requestClone

Start a clone job. A clone creates a new TDO that links back to an existing TDO's assets instead of creating new ones and is used primarily to handle sample media.

Arguments

input: Fields needed to request a new clone job.

requestClone(input: RequestClone): CloneRequest

See also:
RequestClone, CloneRequest

---

retryJob

Retry a job. This action applies only to jobs that are in a failure state. The task sequence for the job will be restarted in its original configuration.

Arguments

id: Supply the ID of the job to retry.

retryJob(id: ID!): Job

See also:
ID, Job

---

sendEmail

Send a basic email. Mutation returns true for a success message.

Arguments

input:

sendEmail(input: SendEmail!): Boolean!

See also:
SendEmail, Boolean

---

setWorkflowRuntimeStorageData

Create or Update Workflow data.

Arguments

workflowRuntimeId:

input:

setWorkflowRuntimeStorageData(
  workflowRuntimeId: ID!,
  input: CreateWorkflowRuntimeStorageData!
): WorkflowRuntimeStorageData!

See also:
ID, CreateWorkflowRuntimeStorageData, WorkflowRuntimeStorageData

---

shareCollection

Share a collection, allowing other organizations to view the data it contains.

Arguments

input: Fields needed to share a collection

shareCollection(input: ShareCollection): Share

See also:
ShareCollection, Share

---

shareFolder

Share a folder with other organizations

Arguments

input:

shareFolder(input: ShareFolderInput): Folder

See also:
ShareFolderInput, Folder

---

shareMention

Share mention

Arguments

input:

shareMention(input: ShareMention): Share

See also:
ShareMention, Share

---

shareMentionFromCollection

Share a mention from a collection

Arguments

input: Fields needed to share a mention

shareMentionFromCollection(
  input: ShareMentionFromCollection
): Share

See also:
ShareMentionFromCollection, Share

---

shareMentionInBulk

Share mentions in bulk

Arguments

input:

shareMentionInBulk(input: ShareMentionInBulk): [Share]

See also:
ShareMentionInBulk, Share

---

startWorkflowRuntime

Start a Veritone Workflow instance

Arguments

workflowRuntimeId:

orgId:

generateAuthToken:

startWorkflowRuntime(
  workflowRuntimeId: ID!,
  orgId: ID!,
  generateAuthToken: Boolean
): WorkflowRuntimeResponse!

See also:
ID, ID, Boolean, WorkflowRuntimeResponse

---

stopWorkflowRuntime

Shut down Veritone Workflow instance

Arguments

workflowRuntimeId:

stopWorkflowRuntime(workflowRuntimeId: ID!): WorkflowRuntimeResponse!

See also:
ID, WorkflowRuntimeResponse

---

subscribeEvent

Subscribe to an event

Arguments

input:

subscribeEvent(input: SubscribeEvent!): ID!

See also:
SubscribeEvent, ID

---

unfileTemporalDataObject

Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject and its assets to disappear from the folder, but does not otherwise affect either the TDO or the folder and does not change access controls.

Arguments

input:

The fields needed to file a TemporalDataObject in a folder

unfileTemporalDataObject(
  input: UnfileTemporalDataObject!
): TemporalDataObject

See also:
UnfileTemporalDataObject, TemporalDataObject

---

unfileWatchlist

Arguments

input:

unfileWatchlist(input: UnfileWatchlist!): Watchlist

See also:
UnfileWatchlist, Watchlist

---

unsubscribeEvent

Unsubscribe to an event.

Arguments

id:

unsubscribeEvent(id: ID!): UnsubscribeEvent!

See also:
ID, UnsubscribeEvent

---

updateApplication

Update a custom application. Applications are subject to specific workflows. The current application state determines what updates can be made to it. See the Veritone Developer Application documentation for details.

Arguments

input: Fields required to update a custom application.

updateApplication(input: UpdateApplication): Application

See also:
UpdateApplication, Application

---

updateAsset

Update an asset

Arguments

input: Fields needed to update an asset.

updateAsset(input: UpdateAsset!): Asset

See also:
UpdateAsset, Asset

---

updateCognitiveSearch

Arguments

input:

updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch

See also:
UpdateCognitiveSearch, CognitiveSearch

---

updateCollection

Update a collection.

Arguments

input: Fields needed to update a collection

updateCollection(input: UpdateCollection): Collection

See also:
UpdateCollection, Collection

---

updateCreative

Update a creative

Arguments

input:

updateCreative(input: UpdateCreative!): Creative!

See also:
UpdateCreative, Creative

---

updateCurrentUser

Update the current authenticated user.

Arguments

input:

updateCurrentUser(input: UpdateCurrentUser!): User!

See also:
UpdateCurrentUser, User

---

updateDataRegistry

Update a structured data registry schema metadata.

Arguments

input:

updateDataRegistry(input: UpdateDataRegistry!): DataRegistry

See also:
UpdateDataRegistry, DataRegistry

---

updateEngine

Update an engine. Engines are subject to specific workflow steps. An engine's state determines what updates can be made to it. See the Veritone Developer Application documentation for details.

Arguments

input: Fields needed to update an engine

updateEngine(input: UpdateEngine): Engine

See also:
UpdateEngine, Engine

---

updateEngineBuild

Update an engine build. Engine builds are subject to specific workflow steps. A build's state determines what updates can be made to it. See the Veritone Developer Application documentation for details.

Arguments

input: Fields needed to update an engine build.

updateEngineBuild(input: UpdateBuild!): Build

See also:
UpdateBuild, Build

---

updateEntity

Update an entity.

Arguments

input: Fields required to update an entity.

updateEntity(input: UpdateEntity!): Entity

See also:
UpdateEntity, Entity

---

updateEntityIdentifier

Arguments

input: Fields required to update an entity identifier.

updateEntityIdentifier(input: UpdateEntityIdentifier!): EntityIdentifier

See also:
UpdateEntityIdentifier, EntityIdentifier

---

updateEntityIdentifierType

Update an entity identifier type.

Arguments

input: Fields required to update an entity identifier type.

updateEntityIdentifierType(
  input: UpdateEntityIdentifierType!
): EntityIdentifierType

See also:
UpdateEntityIdentifierType, EntityIdentifierType

---

updateEvent

Update an event.

Arguments

input:

updateEvent(input: UpdateEvent!): Event!

See also:
UpdateEvent, Event

---

updateExportRequest

Update an export request

Arguments

input: Input data required to update an export request

updateExportRequest(input: UpdateExportRequest!): ExportRequest!

See also:
UpdateExportRequest, ExportRequest

---

updateFolder

Update an existing folder.

Arguments

input: Fields needed to update a folder.

updateFolder(input: UpdateFolder): Folder

See also:
UpdateFolder, Folder

---

updateFolderContentTempate

Update existing content template by folderContentTemplateId.

Arguments

input:

updateFolderContentTempate(
  input: UpdateFolderContentTempate!
): FolderContentTemplate!

See also:
UpdateFolderContentTempate, FolderContentTemplate

---

updateIngestionConfiguration

Update an ingestion configuration.

Arguments

input:

updateIngestionConfiguration(
  input: UpdateIngestionConfiguration
): IngestionConfiguration

See also:
UpdateIngestionConfiguration, IngestionConfiguration

---

updateJobs

Arguments

input:

updateJobs(input: UpdateJobs!): JobList

See also:
UpdateJobs, JobList

---

updateLibrary

Update an existing library.

Arguments

input: Fields needed to update a library

updateLibrary(input: UpdateLibrary!): Library

See also:
UpdateLibrary, Library

---

updateLibraryConfiguration

Update Dataset Library Configuration.

Arguments

input: Fields required to create library configuration

updateLibraryConfiguration(
  input: UpdateLibraryConfiguration!
): LibraryConfiguration

See also:
UpdateLibraryConfiguration, LibraryConfiguration

---

updateLibraryEngineModel

Update a library engine model

Arguments

input: Fields required to update a library engine model

updateLibraryEngineModel(
  input: UpdateLibraryEngineModel!
): LibraryEngineModel

See also:
UpdateLibraryEngineModel, LibraryEngineModel

---

updateLibraryType

Update a library type.

Arguments

input: Fields needed to update a library type.

updateLibraryType(input: UpdateLibraryType!): LibraryType

See also:
UpdateLibraryType, LibraryType

---

updateMention

Update a mentioned object.

Arguments

input:

updateMention(input: UpdateMention!): Mention

See also:
UpdateMention, Mention

---

updateMentionComment

Update a mention comment

Arguments

input: Fields needed to update a mention comment

updateMentionComment(input: UpdateMentionComment): MentionComment

See also:
UpdateMentionComment, MentionComment

---

updateMentionExportRequest

Update status or assetURI of a mentionExportRequest Often use when the file export was completed or downloaded.

Arguments

input:

updateMentionExportRequest(
  input: UpdateMentionExportRequest!
): ExportRequest!

See also:
UpdateMentionExportRequest, ExportRequest

---

updateMentionRating

Update a mention rating.

Arguments

input: Fields needed to update a mention rating

updateMentionRating(input: UpdateMentionRating): MentionRating

See also:
UpdateMentionRating, MentionRating

---

updateMentions

Update a set of mentions.

Arguments

input:

updateMentions(input: UpdateMentions!): [Mention]

See also:
UpdateMentions, Mention

---

updateOrganization

Update an organization.

Arguments

input: Fields required to update an organization.

updateOrganization(input: UpdateOrganization!): Organization

See also:
UpdateOrganization, Organization

---

updateProcessTemplate

Update a processTemplate by ID in Data Center.

Arguments

input:

updateProcessTemplate(input: UpdateProcessTemplate!): ProcessTemplate!

See also:
UpdateProcessTemplate, ProcessTemplate

---

updateSchemaState

Arguments

input:

updateSchemaState(input: UpdateSchemaState!): Schema

See also:
UpdateSchemaState, Schema

---

updateSubscription

Arguments

input:

updateSubscription(input: UpdateSubscription!): Subscription

See also:
UpdateSubscription, Subscription

---

updateTDO

Update a temporal data object.

Arguments

input: Fields required to update a TDO

updateTDO(input: UpdateTDO): TemporalDataObject

See also:
UpdateTDO, TemporalDataObject

---

updateTask

Update a task.

Arguments

input: Fields required to update a task.

updateTask(input: UpdateTask): Task

See also:
UpdateTask, Task

---

updateUser

Update an existing user.

Arguments

input: Fields needed to update a user

updateUser(input: UpdateUser): User

See also:
UpdateUser, User

---

updateWatchlist

Arguments

input:

updateWatchlist(input: UpdateWatchlist!): Watchlist

See also:
UpdateWatchlist, Watchlist

---

updateWidget

Updates a widget.

Arguments

input: Fields needed to update a widget

updateWidget(input: UpdateWidget): Widget

See also:
UpdateWidget, Widget

---

uploadEngineResult

Upload and store an engine result. The result will be stored as an asset associated with the target TemporalDataObject and the task will be updated accordingly. Use a multipart form POST for this mutation.

Arguments

input: Fields needed to upload and store an engine result

uploadEngineResult(input: UploadEngineResult!): Asset

See also:
UploadEngineResult, Asset

---

upsertSchemaDraft

Update a structured data registry schema.

Arguments

input:

upsertSchemaDraft(input: UpsertSchemaDraft!): Schema

See also:
UpsertSchemaDraft, Schema

---

userLogin

Login as a user. This mutation does not require an existing authentication context (via Authorization header with bearer token, cookie, etc.). Instead, the client supplies credentials to this mutation, which then authenticates the user and sets up the authentication context. The returned tokens can be used to authenticate future requests.

Arguments

input: Fields needed to log in

userLogin(input: UserLogin): LoginInfo

See also:
UserLogin, LoginInfo

---

userLogout

Logout user and invalidate user token

Arguments

token: User token that should be invalidated

userLogout(token: String!): Boolean

See also:
String, Boolean

---

validateEngineOutput

Validates if an engine output conforms to the engine output guidelines.

Arguments

input:

validateEngineOutput(input: JSONData!): Boolean!

See also:
JSONData, Boolean

---

validateToken

Validate a user token. This mutation is used by services to determine if the token provided by a given client is valid.

Arguments

token:

validateToken(token: String!): LoginInfo

See also:
String, LoginInfo

---

verifyJWT

Verify JWT token.

Arguments

jwtToken:

verifyJWT(jwtToken: String!): VerifyJWTPayload

See also:
String, VerifyJWTPayload