SCALAR
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
1 scalar String
link Required by
- AddMediaSegment
- AddMediaSegments
- AddNotificationAction
- AddNotificationTemplate
- AddTaskReplacementEngine
- AddTasksToJobsError
- AlwaysUpFlowA AlwaysUpFlow object.
- AlwaysUpFlowInput
- ApiTokenInfo
- AppCreateContextMenuExtension
- ApplicationAn application is a set of Veritone functionality that customers can sign up for.
- ApplicationBillingPlanId
- ApplicationConfig
- ApplicationConfigDefinition
- ApplicationConfigDefinitionCreate
- ApplicationConfigDefinitionDelete
- ApplicationConfigDefinitionFilter
- ApplicationConfigDefinitionInput
- ApplicationConfigDefinitionUpdate
- ApplicationConfigDefinitionUpdateApp
- ApplicationConfigDelete
- ApplicationConfigInput
- ApplicationConfigValueInput
- ApplicationFilter
- ApplicationHeaderbar
- ApplicationHeaderbarConfig
- ApplicationHeaderbarConfigInput
- ApplicationHeaderbarInput
- ApplicationHeaderbarUpdate
- ApplicationJWTTokenInfo
- ApplicationPlatformTODO
- ApplicationRole
- ApplicationSetting
- ApplicationViewer
- ApplicationViewerBuild
- AssetAn asset represents a single unit of data, such as a file or URL, and basic metadata about that data. An asset must be contained within a TemporalDataObject.
- AssetFileDataA structured containing metadata about an asset file.
- AssetScrollList
- AssetSourceDataA structure containing metadata about the source engine and task for an asset.
- AuditEvent
- AuditLogEntry
- AuthResource
- AuthRoleRequirementWIP:
- AutocompleteFieldConfig
- AutomateFlowInputInput fields used to create an automate flow. Name is required.
- BasicUserInfo
- BatchJobTemplateInputinput for the mutator executeJobTemplate
- BatchTDOInputinput for a new batch
- BooleanPropertyType representing a boolean property
- Build
- Campaign
- ChangePassword
- CloneDataMetadata that represents a clone of a recording.
- CloneRequest
- Cluster
- ClusterNode
- ClusterSubscription
- Collection
- CollectionMention
- CompoundProperty
- ContextMenuExtension
- CopyFlow
- CreateAppEventInput
- CreateApplication
- CreateApplicationRole
- CreateApplicationViewer
- CreateApplicationViewerBuild
- CreateAsset
- CreateAssetInTDO
- CreateBuild
- CreateBundle
- CreateBundleSelectDetail
- CreateBundleService
- CreateClusterThis API creates an edge cluster for this core Example: mutation createCluster { createCluster (input: { name: "YOUR_CLUSTER_NAME", allowedEngines: ["all"], dockerCredentials: {}, type: RT, containerTag: "YOUR_CONTAINER_TAG", paused: false, memorySize: "20gb", storageSize: "10gb", bypassAllowedEngines: true, collaborators: [], subscriptions: [], tags: ["aiware-agent"], status: active, mediaStorage: core, mediaStoragePath: "", serviceToken: "fake-token", edgeVersion: 3, } ) { id } }
- CreateClusterNode
- CreateCognitiveSearch
- CreateCognitiveSearchInWatchlist
- CreateCollection
- CreateContextMenuExtension
- CreateCreative
- CreateCustomDashboard
- CreateDagTemplate
- CreateDataRegistry
- CreateDatasetSchema
- CreatedMediaShare
- CreateEngineInput fields used to create a new engine.
- CreateEngineDependency
- CreateEngineField
- CreateEngineFieldPicklistOptionRepresents one allowed option in a picklist.
- CreateEngineJobTemplate
- CreateEntity
- CreateEntityIdentifier
- CreateEntityIdentifierType
- CreateEntityType
- CreateEvent
- CreateEventActionTemplate
- CreateEventCustomRule
- CreateExportRequestFormatConfig
- CreateFlow
- CreateFlowExecution
- CreateFlowFromTemplate
- CreateFlowRevision
- CreateFlowTemplate
- CreateFolderInformation required to create a new folder. After creation, a folder can be renamed with the `updateFolder` mutation, but no other changes are supported.
- CreateInstanceLoginConfiguration
- CreateJob
- CreateJobTemplate
- CreateLibrary
- CreateLibraryCollaborator
- CreateLibraryEngineModel
- CreateLibraryType
- CreateMediaShare
- CreateMention
- CreateMentionComment
- CreateMentionExportRequest
- CreateMentions
- CreateNotebook
- CreateOpenIdProvider
- CreateOrganization
- CreateOrganizationInviteInput
- CreatePasswordResetRequest
- CreatePasswordResetRequestPayload
- CreateProcessTemplate
- CreateRoute
- CreateSavedSearch
- CreateScheduledJobExample to create a scheduleJob: mutation createScheduleJob { createScheduledJob(input: { name: "every5Min" runMode:Recurring recurringScheduleParts: [ { repeatIntervalUnit: Minutes repeatInterval: 5 }] jobTemplates:[ { #clusterId: "rt-242c1beb-653a-4299-bb33-2d8fb105d70b" clusterId: "YOUR OWN CLUSTER ID" taskTemplates : [ { engineId: "9e611ad7-2d3b-48f6-a51b-0a1ba40fe255" webstream adapter payload: { url:"https://s3.amazonaws.com/src-veritone-tests/stage/20190505/0_40_Eric%20Knox%20BWC%20Video_40secs.mp4" } }, { engineId: "352556c7-de07-4d55-b33f-74b1cf237f25" playback }, { engineId: "8bdb0e3b-ff28-4f6e-a3ba-887bd06e6440" chunk audio payload:{ ffmpegTemplate: "audio" chunkOverlap: 15 customFFMPEGProperties:{ chunkSizeInSeconds: "30" } } }, { #engine to run engineId: "c0e55cde-340b-44d7-bb42-2e0d65e98255" } ] } ] } ) { id } }
- CreateSourceData used to create a new source
- CreateSourceType
- CreateStructuredData
- CreateSubscription
- CreateSubscriptionContact
- CreateSubscriptionInWatchlistUsed to create a subscription while creating a watchlist. The subscription will be for the new watchlist.
- CreateTaskFields required to create a task. Used when creating a job.
- CreateTaskTemplate
- CreateTDOPayload required to create a temporal data object
- CreateTDOForJob
- CreateTDOInJobPayload required to create a temporal data object
- CreateTDOWithAsset
- CreateTriggers
- CreateUser
- CreateWatchlist
- CreateWidget
- CreateWorkflowRuntimeStorageData
- Creative
- CustomDashboard
- DagTemplate
- DailyTaskMetrics
- DashboardAnalytics Dashboards
- DataRegistry
- Dataset
- DatasetInput
- DatasetMetric
- DatasetRowInput
- DatasetSchemaTags
- DatasetTags
- DeleteDatasetPayload
- DeleteIntegrationConfigPayload
- DeleteLibraryDatasetPayload
- DeleteOrganizationIntegrationConfig
- DeletePayloadPayload required to delete an object
- EmitAuditEvent
- EmitEvent
- EmitEventResponse
- EmitSystemEventAuth required: "task_type.internal", "superadmin", "task_type:org_system" # Example of mention_inserted event { "type": "mention", "event": "mention_inserted", "payload": { "mentionId": 149703607, "organizationId": 12345, "mentionDate": "Mon, 23 Jul 2018 21:03:52 GMT", "transactionTimestamp": "Mon, 24 Jul 2018 21:03:52 GMT" } }
- Engine
- EngineCategory
- EngineClass
- EngineDependency
- EngineFieldRepresents a custom input field on an engine.
- EngineFieldPicklistOptionRepresents one allowed option in a picklist.
- EngineFieldValue
- EngineFilter
- EngineJobTemplate
- EngineResultRepresents single chunk of engine results for date range
- EngineSearchConfigurationRepresents configuration on how the results of engines within a given category are indexed and searched. Primarily used by Veritone platform applications.
- EngineTemplateInputTypes
- EngineType
- Entity
- EntityIdentifier
- EntityIdentifierItem
- EntityIdentifierType
- EntityTag
- EntityTagFilter
- EntityTagInput
- EntityType
- Event
- EventActionTemplate
- EventCustomRule
- EventFilter
- EventFilterInput
- EventSubscription
- EventSubscriptionInput
- ExportFormat
- ExportRequest
- FileData
- FlowExecution
- FlowFromTemplate
- FlowRevision
- FlowTemplate
- Folder
- FolderOverview
- FolderSummaryDetail
- GetCurrentUserPasswordToken
- Group
- InstanceAuditLogEntry
- InstanceAuditLogInput
- IntegrationConfig
- IntPropertyType representing an integer property.
- Invitee
- Job
- JobTemplateA job template is a reusable template for job creation.
- JSONObject
- JWTRolesField
- JWTTokenInfoContains information about engineJWTToken context
- KVPKey-value pairs -- a generic way to represent metadata
- LaunchDAGTemplateInput
- Library
- LibraryCollaborator
- LibraryEngineModel
- LibraryType
- LoginConfiguration
- LoginInfoContains information about the user's authentication context.
- MatchEntityTagInput
- MediaShare
- MediaShareInfo
- Mention
- MentionComment
- MentionHit
- MentionSnippets
- MentionStatus
- MentionUserSnippets
- Metadata
- MFAInfoType that holds multi-factor authentication for a user
- MoveFoldersPayload
- MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.
- NodeModule
- NodeModuleInput
- NodePair
- NotificaionPostInput
- Notification
- NotificationAction
- NotificationMailbox
- NotificationMailboxInput
- NotificationTemplate
- OktaConfiguration
- OpenIdProvider
- OpenIdProviderLoginButtonStyle
- OperationResult
- OpResult
- Organization
- OrganizationBasicInfo
- OrganizationBilling
- OrganizationInfo
- OrganizationInfoSimple
- OrganizationInvite
- OrganizationInviteActionAudit
- PackageA Package is an object that groups dependent aiWARE resources together.
- PackageCreateInput
- PackageDeleteResult
- PackageGrantFilter
- PackageOpResult
- PackageResourceA Resource is an aiWARE asset that a package is dependent on, such as an application, engine, schema, engine build, and so on. Refer to __PackageResourceType__ for the aiWARE assets that can be added to a package.
- PackageResourceInput
- PackageUpdateInput
- PasswordTokenInfo
- Permission
- PlatformInfoPlatformInfo
- PlatformVersionPlatformVersion
- PlatformVersionInputInformation required to create a new PlatforVersion. After creation, a version can be updated with the `setCurrentPlatformVersion` mutation, but no other changes are supported.
- ProcessTemplate
- ProgramMetadata that represents a program.
- ProgramAffiliate
- PropertyA property is a name-value pair. This is the base interface for properties.
- QueryQueries are used to retrieve data. If you're new to our API, try the `me` query to explore the information you have access to. Hit `ctrl-space` at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.
- ReplaceSavedSearch
- RightsListing
- RoleA role signifies a user's permissions within a given context.
- Route
- SavedSearch
- ScheduledJob
- Schema
- SchemaProperty
- SearchFieldConfig
- SearchInput
- SendEmail
- SetAssetFileDataInput type for AssetFileData
- SetAssetSourceDataInput type for AssetSourceData
- SetLoginConfiguration
- SetOktaConfiguration
- SetOrganizationIntegrationConfig
- SetPrimaryAssetInput used to set the primary asset of a given type on a TDO. The type must be supported by the server; primary asset is used by certain engines and front end components. Currently "media" and "transcript" are supported.
- Share
- ShareCollection
- SharedCollection
- SharedCollectionHistoryProvides status information on the creation or update of a shared collection.
- SharedMention
- ShareMention
- ShareMentionFromCollection
- ShareMentionInBulk
- SignedPropertyUrl
- SingleEngineJobInput
- SourceA source represents a source of data and is used by adapters to ingest data into the platform for use by an engine workflow.
- SourceTypeA source type represents a category of sources that share common attributes, such as "TV station" or "Real-time camera feed".
- SourceTypeCategorySource type categories are managed by Veritone.
- StaticAppConfig
- StringPropertyType representing a string property
- StructuredData
- StructuredJSONObjectAn object containing custom structured data. This type is not fully implemented.
- StructuredJSONSchemaA custom structured data schema, specified in JSON. This type is not fully implemented.
- SubscribeEvent
- Subscription
- SubscriptionContact
- SystemEventInfo
- TaskRepresents a single engine task
- TaskLog
- TaskTemplate
- TaskWarning
- TDOStreamDataDescribes a stream that is available on a TDO
- TemporalDataObject
- TestingDetailsField
- TestingDetailsType
- TimeZoneInformation about a time zone
- TimeZoneAbbreviationInformation about a time zone abbreviation or variant.
- Token
- TokenJson
- TriggerContains information of a event hook
- UnsubscribeEvent
- UpdateApplication
- UpdateApplicationEventEndpoint
- UpdateApplicationRole
- UpdateApplicationViewerInput
- UpdateAssetInput needed to update an asset. The asset data itself -- file or URI -- is immutable. Only supplemental metadata can be updated with this input type.
- UpdateBuild
- UpdateCluster
- UpdateClusterNode
- UpdateCognitiveSearch
- UpdateCollection
- UpdateCollectionMention
- UpdateContextMenuExtension
- UpdateCreative
- UpdateCurrentUser
- UpdateCustomDashboard
- UpdateDagTemplate
- UpdateDataRegistry
- UpdateEngineInput fields used to update an existing engine.
- UpdateEngineDependency
- UpdateEntity
- UpdateEntityIdentifier
- UpdateEntityIdentifierType
- UpdateEntityType
- UpdateEvent
- UpdateEventActionTemplate
- UpdateEventCustomRule
- UpdateExportRequest
- UpdateFlowExecution
- UpdateFlowRevision
- UpdateFlowTemplate
- UpdateFolderInformation required to update a folder. Currently, the folder can be renamed. No other changes are supported.
- UpdateJobOutput
- UpdateJobs
- UpdateJobTemplate
- UpdateLibrary
- UpdateLibraryCollaborator
- UpdateLibraryEngineModel
- UpdateLibraryType
- UpdateMention
- UpdateMentionComment
- UpdateMentionExportRequest
- UpdateMFAInfo
- UpdateOpenIdProvider
- UpdateOrganizationFields used to update an organization.
- UpdateOrganizationInviteInput
- UpdatePayloadPayload required ro update an object
- UpdateScheduledJob
- UpdateSharedCollectionHistory
- UpdateSourceData used to update an existing source
- UpdateSourceType
- UpdateTask
- UpdateTaskTemplate
- UpdateTDOPayload required to create a temporal data object
- UpdateUser
- UpdateUserSetting
- UpdateWatchlist
- UpdateWidget
- UploadEngineResultFields needed to upload and store an engine result using multipart form POST.
- UpsertEvent
- UpsertSchemaDraft
- Usage
- UsageByTaskType
- UserA user represents a user account within an organization.
- UserACL
- UserACLInput
- UserLoginInput fields required by the userLogin mutation.
- UserSettingType that holds user setting for a user
- UserSettingInfo
- VerifyJWTPayload
- Watchlist
- Widget
- WorkflowRuntimeResponse
- WorkflowRuntimeStorageData
- WritableUrlInfoContains information about a signed writable URL retrieved from the getSignedWritableUrl mutation.
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.