The table below gives a quick summary of GraphQL query methods, alphabetized by name.
Click any name to see the complete method signature and other info.
application
Retrieve a single application.
Arguments
id: The application ID
application(id: ID!): Application
See also:
ID, Application
applications
Retrieve applications. These are custom applications integrated into the Veritone platform using the Veritone Developer Application framework.
Arguments
id: Provide an ID to retrieve a single specific application.
status: Provide a status, such as "draft" or "active"
owned: If true, return only applications owned by the user's organization.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
applications(
id: ID,
status: ApplicationStatus,
owned: Boolean,
offset: Int,
limit: Int
): ApplicationList
See also:
ID, ApplicationStatus, Boolean, Int, ApplicationList
asset
Retrieve a single asset.
Arguments
id: The asset ID
asset(id: ID!): Asset
See also:
ID, Asset
auditLog
Examine entries from the audit log. All operations that modify data are written to the audit log. Only entries for the user's organization can be queried. All queries are bracketed by a time window. A default time window is applied if the toDateTime and/or fromDateTime parameters are not provided. The maximum time window length is 30 days. Only Veritone and organization administrators can use this query.
Arguments
toDateTime: Date/time up to which entries will be returned. In other words, the end of the query time window. Defaults to the current time.
fromDateTime: Date/time from which entries will be returned. In other words, the start of the query time window. Defaults to the toDateTime minus 7 days.
organizationId: Organization ID to query records for. This value can only be used by Veritone administrators. Any value provided by user administrators will be ignored.
userName: User name on audit entry. Must be exact match.
clientIpAddress: IP address of the client that generated the audit action. Must be exact match.
clientUserAgent: HTTP user agent of the client that generated the audit action. Must be exact match.
eventType: The event type, such as Create, Update, or Delete. Must be exact match.
objectId:The ID of the object involved in the audit action. The format of this ID varies by object type. Must be exact match.
objectType:The type of the object involved in the audit action, such as Watchlist or TemporalDataObject. Must be exact match.
success:Whether or not the action was successful.
id:The unique ID of an audit log entry. Multiple values can be provided.
offset:Offset into result set, for paging.
limit:Limit on result size, for paging (page size). Audit queries are lightweight so the default of 100 is higher than the default offset used elsewhere in the API.
orderBy:Order information. Default is ordered by createdDateTime descending.
auditLog(
toDateTime: DateTime,
fromDateTime: DateTime,
organizationId: ID,
userName: String,
clientIpAddress: String,
clientUserAgent: String,
eventType: String,
objectId: ID,
objectType: String,
success: Boolean,
id: [ID!],
offset: Int,
limit: Int,
orderBy: [AuditLogOrderBy!]
): AuditLogEntryList!
See also:
DateTime, ID, String, Boolean, Int, AuditLogOrderBy, AuditLogEntryList
cloneRequests
Retrieve clone job entries.
Arguments
id: Provide an ID to retrieve a single specific clone request.
applicationId: Application ID to get clone requests for. Defaults to the user's own application.
offset:
limit:
cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
See also:
ID, Int, CloneRequestList
cognitiveSearch
Arguments
cognitiveSearch(id: ID!): CognitiveSearch!
See also:
ID, CognitiveSearch
collection
Arguments
id:
collection(id: ID!): Collection!
See also:
ID, Collection
collections
Arguments
collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
See also:
ID, String, Int, CollectionList
creative
Get creative by id with current organizationId.
Arguments
id:
creative(id: ID!): Creative!
}
See also:
ID, Creative
dataRegistries
Arguments
dataRegistries(
id: ID,
name: String,
nameMatch: StringMatch,
offset: Int,
limit: Int,
orderBy: DataRegistryOrderBy,
orderDirection: OrderDirection,
filterByOwnership: SchemaOwnership
): DataRegistryList
See also:
ID, String, StringMatch, Int, DataRegistryOrderBy, OrderDirection, SchemaOwnership, DataRegistryList
dataRegistry
Arguments
dataRegistry(id: ID!): DataRegistry
See also:
ID, DataRegistry
engine
Retrieve a single engine by ID.
Arguments
id: Provide the engine ID
engine(id: ID!): Engine
See also:
ID, Engine
engineBuild
Arguments
id: Provide the build ID
engineBuild(id: ID!): Build
See also:
ID, Build
engineCategories
Retrieve engine categories
Arguments
id: Provide an ID to retrieve a single specific engine category.
name: Provide a name, or part of one, to search by category name
type: Return all categories of an engine type
offset: Specify maximum number of results to retrieve in this result. Page size.
limit: Specify maximum number of results to retrieve in this result.
engineCategories(
id: ID,
name: String,
type: String,
offset: Int,
limit: Int
): EngineCategoryList
See also:
ID, String, Int, EngineCategoryList
engineCategory
Retrieve a specific engine category.
Arguments
id: Supply the ID of the engine category to retrieve
engineCategory(id: ID!): EngineCategory
See also:
ID, EngineCategory
engineResults
Retrieves engine results by TDO and engine ID or by job ID.
Arguments
tdoId: Provide the ID of the TDO containing engine results to retrieve. If this parameter is used, engineIds or engineCategoryIds must also be set. Results for only the specified TDO will be returned.
sourceId: Provide the ID of the Source containing engine results to retrieve. If this parameter is used, engineIds or engineCategoryIds must also be set. This takes priority over tdoId.
engineIds: Provide one or more engine IDs to retrieve engine results by ID. This parameter is mandatory if tdoId is used, but optional if jobId or engineCategory is used.
engineCategoryIds: Provide one or more category IDs to get all results from that categroy.
jobId: Provide a job ID to retrieve engine results for the job.
mentionId: Provide a mention ID to retrieve engine results for the mention.
startOffsetMs: Start offset ms for the results.
stopOffsetMs: End offset ms for the results.
startDate: Start date for the results. Takes priority over startOffsetMs.
stopDate: End date for the results. Takes priority over stopOffsetMs.
ignoreUserEdited: Whether or not to exclude user edited engine results. Defaults to false.
fallbackTdoId: A TDO ID can be provided for use if the provided sourceIdand/or mentionId parameters do not resolve to a logical set of TDOs. Depending on parameter settings and available data, results from other TDOs can be included in the response.
engineResults(
tdoId: ID,
sourceId: ID,
engineIds: [ID!],
engineCategoryIds: [ID!],
jobId: ID,
mentionId: ID,
startOffsetMs: Int,
stopOffsetMs: Int,
startDate: DateTime,
stopDate: DateTime,
ignoreUserEdited: Boolean,
fallbackTdoId: ID
): EngineResultList
See also:
ID, Int, DateTime, Boolean, EngineResultList
engines
Retrieve engines.
Arguments
id: Provide an ID to retrieve a single specific engine.
ids:
categoryId: Provide a category ID to filter by engine category.
category: provide a category name or ID to filter by engine category
state: Provide a list of states to filter by engine state.
owned: If true, return only engines owned by the user's organization.
libraryRequired: If true, return only engines that require a library.
createsTDO: If true, return only engines that create their own TDO. If false, return only engines that do not create a TDO. If not set, return either.
name: Provide a name, or part of a name, to search by engine name
offset: Specify maximum number of results to retrieve in this result. Page size.
limit: Specify maximum number of results to retrieve in this result.
filter: Filters for engine attributes
orderBy: Provide a list of EngineSortField to sort by.
engines(
id: ID,
ids: [ID!],
categoryId: String,
category: String,
state: [EngineState],
owned: Boolean,
libraryRequired: Boolean,
createsTDO: Boolean,
name: String,
offset: Int,
limit: Int,
filter: EngineFilter,
orderBy: [EngineSortField]
): EngineList
See also:
ID, String, EngineState, Boolean, Int, EngineFilter, EngineSortField, EngineList
entities
Retrieve a list of entities across libraries.
Arguments
ids: Provide a list of entity IDs to retrieve those entities
libraryIds: Provide a list of library IDs to retrieve entities across multiple libraries.
isPublished:
identifierTypeId:
name:
offset:
limit:
orderBy:
orderDirection:
entities(
ids: [ID!],
libraryIds: [ID!],
isPublished: Boolean,
identifierTypeId: ID,
name: String,
offset: Int,
limit: Int,
orderBy: LibraryEntityOrderBy,
orderDirection: OrderDirection
): EntityList
See also:
ID, Boolean, String, Int, LibraryEntityOrderBy, OrderDirection, EntityList
entity
Retrieve a specific entity.
Arguments
id: Provide an entity ID.
entity(id: ID!): Entity
See also:
ID, Entity
entityIdentifierType
Arguments
id: Provide the entity identifier type ID
entityIdentifierType(id: ID!): EntityIdentifierType
See also:
ID, EntityIdentifierType
entityIdentifierTypes
Retrieve entity identifier types.
Arguments
id: Provide an ID to retrieve a single specific entity identifier type.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
See also:
ID, Int, EntityIdentifierTypeList
event
Retrieve an event by id.
Arguments
id:
event(id: ID!): Event!
See also:
ID, Event
events
Retrieve a list of events by application.
Arguments
application: Provide an application to retrieve all its events. Use 'system' to list all public system events.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
events(application: String!, offset: Int, limit: Int): EventList!
See also:
String, Int, EventList
exportRequest
Arguments
id:
event: Provide an event to retrieve export request. Should be exportRequest or mentionExportRequest. Default value is 'exportRequest'
exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
See also:
ID, ExportRequestEvent, ExportRequest
exportRequests
Retrieve a list of export requests.
Arguments
id: Provide an ID to retrieve a single export request
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
status: Provide a list of status options to filter by status
event: Provide an event to retrieve export request. Should be exportRequest' or 'mentionExportRequest' Default value is 'exportRequest'
exportRequests(
id: ID,
offset: Int,
limit: Int,
status: [ExportRequestStatus!],
event: ExportRequestEvent
): ExportRequestList!
See also:
ID, Int, ExportRequestStatus, ExportRequestEvent, ExportRequestList
folder
Retrieve a single folder. Used to navigate the folder tree structure.
Arguments
id: Provide an ID to retrieve a single specific user.
folder(id: ID!): Folder
See also:
ID, Folder
getSignedWritableUrl
Returns a signed writable S3 URL. A client can then upload to this URL with an HTTP PUT without providing any additional authorization (Note: The push must be a PUT. A POST will fail.)
Arguments
key: Optional key of the object to generate a writable URL for. If not provided, a new, unique key will be generated. If a key is provided and resembles a file name with extension delimited by .), a UUID will be inserted into the file name, leaving the extension intact. If a key is provided and does not resemble a file name, a UUID will be appended.
type: Optional type of resource, such as asset, thumbnail, or preview
path: Optional extended path information. If the uploaded content will be contained within a container such as a TemporalDataObject (for asset) or Library for entityIdentifier), the ID of the object should be provided here.
organizationId: Optional organization ID. Normally this value is computed by the server based on the authorization token used for the request. Is is used only by Veritone platform components.
getSignedWritableUrl(
key: String,
type: String,
path: String,
organizationId: ID
): WritableUrlInfo
See also:
String, ID, WritableUrlInfo
getSignedWritableUrls
Return writable storage URLs in bulk. A maximum of 1000 can be created in one call. See getSignedWritableUrl for details on the usage of the response contents.
Arguments
number: Number of signed URLs to return
type: Optional type of resource, such as asset, thumbnail, or preview
path: Optional extended path information. If the uploaded content will be contained within a container such as a TemporalDataObject (for asset) or Library for entityIdentifier), the ID of the object should be provided here.
organizationId: Optional organization ID. Normally this value is computed by the server based on the authorization token used for the request. Is is used only by Veritone platform components.
getSignedWritableUrls(
number: Int!,
type: String,
path: String,
organizationId: ID
): [WritableUrlInfo!]!
See also:
Int, String, ID, WritableUrlInfo
graphqlServiceInfo
Returns information about the GraphQL server, useful for diagnostics. This data is primarily used by Veritone development, and some fields may be restricted to Veritone administrators.
Arguments
graphqlServiceInfo: GraphQLServiceInfo
See also:
GraphQLServiceInfo
groups
Retrieve groups.
Arguments
id: Provide an ID to retrieve a specific group by ID
ids: Provide IDs to retrieve multiple groups by ID
name: Provide a name, or part of one, to search for groups by name
organizationIds: Provide a list of organization IDs to retrieve groups defined within certain organizations.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
See also:
ID, String, Int, GroupList
ingestionConfiguration
Retrieve a single ingestion configuration.
Arguments
id: The configuration ID
ingestionConfiguration(id: ID!): IngestionConfiguration
See also:
ID, IngestionConfiguration
ingestionConfigurations
Retrieve ingestion configurations.
Arguments
id: Supply an ingestion configuration ID to retrieve a single Ingestion
offset: Offset
limit: Limit
name:
startDate:
endDate:
sources: Specify one or more sources to filter by source type
applicationId: Supply an application ID to retrieve configurations only for that application.
emailAddress: Email address configured for ingestion
ingestionConfigurations(
id: ID,
offset: Int,
limit: Int,
name: String,
startDate: DateTime,
endDate: DateTime,
sources: [String!],
applicationId: ID,
emailAddress: String
): IngestionConfigurationList
See also:
ID, Int, String, DateTime, IngestionConfigurationList
job
Retrieve a single job
Arguments
id: the job ID
job(id: ID!): Job
See also:
ID, Job
jobs
Retrieve jobs.
Arguments
hasTargetTDO:
id: Provide an ID to retrieve a single specific job.
status: Provide a list of status strings to filter by status
applicationStatus:
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify the maximum number of results to included in this response, or page size.
applicationId: Provide an application ID to filter jobs for a given application. Defaults to the user's own application.
targetId: Provide a target ID to get the set of jobs running against a particular TDO.
clusterId: Provide a cluster ID to get the jobs running on a specific cluster
scheduledJobIds: Provide a list of scheduled job IDs to get jobs associated with the scheduled jobs
hasScheduledJobId: Return only jobs that are (true) or are not false) associated with a scheduled job
orderBy: Provide sort information. The default is to sort by createdDateTime descending.
dateTimeFilter: Filter by date/time field.
applicationIds: Provide list of application IDs to filter jobs. Defaults to the user's own application.
engineIds: Provide a list of engine IDs to filter for jobs that contain tasks for the specified engines.
engineCategoryIds: Provide a list of engine category IDs to filter for jobs that contain tasks for engines in the specific categories.
jobs(
hasTargetTDO: Boolean,
id: ID,
status: [JobStatusFilter!],
applicationStatus: String,
offset: Int,
limit: Int,
applicationId: ID,
targetId: ID,
clusterId: ID,
scheduledJobIds: [ID!],
hasScheduledJobId: Boolean,
orderBy: [JobSortField!],
dateTimeFilter: [JobDateTimeFilter!],
applicationIds: [ID],
engineIds: [ID!],
engineCategoryIds: [ID!]
): JobList
See also:
Boolean, ID, JobStatusFilter, String, Int, JobSortField, JobDateTimeFilter, JobList
libraries
Retrieve libraries and entities.
Arguments
id: Provide an ID to retrieve a single specific library.
name: Provide a name string to search by name.
type: Provide the name or ID of a library to search for libraries that contain that type.
entityIdentifierTypeIds: Provide the id of an entity identifier type to search for libraries that correlate to that type.
includeOwnedOnly: Specify true if only libraries owned by the user's organization should be returned. Otherwise, shared libraries will be included.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
orderBy: Specify a field to order by
orderDirection: Specify the direction to order by
libraries(
id: ID,
name: String,
type: String,
entityIdentifierTypeIds: [String!],
includeOwnedOnly: Boolean,
offset: Int,
limit: Int,
orderBy: LibraryOrderBy,
orderDirection: OrderDirection
): LibraryList
See also:
ID, String, Boolean, Int, LibraryOrderBy, OrderDirection, LibraryList
library
Retrieve a specific library.
Arguments
id: Provide a library ID.
library(id: ID!): Library
See also:
ID, Library
libraryConfiguration
Retrieve library configuration.
Arguments
id: Provide configuration id
libraryConfiguration(id: ID!): LibraryConfiguration
See also:
ID, LibraryConfiguration
libraryEngineModel
Retrieve a specific library engine model
Arguments
id: Provide the library engine model ID
libraryEngineModel(id: ID!): LibraryEngineModel
See also:
ID, LibraryEngineModel
libraryType
Retrieve a single library type.
Arguments
id: Provide an ID to retrieve a single specific library type.
libraryType(id: ID): LibraryType
See also:
ID, LibraryType
libraryTypes
Retrieve all library types.
Arguments
id: Provide an ID to retrieve a single specific library type.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
See also:
ID, Int, LibraryTypeList
me
Retrieve information for the current logged-in user.
Arguments
me: User
See also:
User
Get the media share by media shareId.
Arguments
id:
mediaShare(id: ID!): MediaShare!
See also:
ID, MediaShare
mention
Retrieve a single mention.
Arguments
mentionId: The mention ID
limit: Comments pagination - limit
offset: Comments pagination - limit
userId: The user who owns the mention.
mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
See also:
ID, Int, String, Mention
mentionStatusOptions
Arguments
mentionStatusOptions: [MentionStatus!]!
See also:
MentionStatus
mentions
Arguments
id:
watchlistId: Get mentions created from the specified watchlist
sourceId: Get mentions associated with the specified source
sourceTypeId: Get mentions associated with sources of the specified source type
tdoId: Get mentions associated directly with the specific TDO dateTimeFilter: Specify date/time filters against mention fields. Querying for mentions can be expensive. If the query does not include a filter by id, tdoId, sourceId, watchlistId, or a user-provided dateTimeFilter, a default filter of the past 7 days is applied.
orderBy: Set order information on the query. Multiple fields are supported.
offset:
limit:
mentions(
id: ID,
watchlistId: ID,
sourceId: ID,
sourceTypeId: ID,
tdoId: ID,
dateTimeFilter: [MentionDateTimeFilter!],
orderBy: [MentionOrderBy!],
offset: Int,
limit: Int
): MentionList
See also:
ID, MentionDateTimeFilter, MentionOrderBy, Int, MentionList
myRights
Arguments
myRights: RightsListing
See also:
RightsListing
organization
Retrieve a single organization.
Arguments
id: The organization ID TODO take application ID as well as org ID
organization(id: ID!): Organization
See also:
ID, Organization
organizations
Retrieve organizations.
Arguments
id: Provide an ID to retrieve a single specific organization.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
kvpProperty: Provide a property from the organization kvp to filter the organizaion list.
kvpValue: Provide value to for the kvpFeature filter. If not present the filter becomes kvpProperty existence filter.
organizations(
id: ID,
offset: Int,
limit: Int,
kvpProperty: String,
kvpValue: String
): OrganizationList
See also:
ID, Int, String, OrganizationList
permissions
Retrieve permissions.
Arguments
id: Provide an ID to retrieve a single specific permission.
name:
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
See also:
ID, String, Int, PermissionList
processTemplate
Get process templates by id. Arguments id: graphql
processTemplate(id: ID!): ProcessTemplate! See also:
ID, ProcessTemplate
processTemplates
Get list process templates by id or current organizationId.
Arguments
id:
offset:
limit:
processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
See also:
ID, Int, ProcessTemplateList
rootFolders
Retrieve the root folders for an organization.
Arguments
type: The type of root folder to retrieve
rootFolders(type: RootFolderType): [Folder]
See also:
RootFolderType, Folder
savedSearches
Fetch all saved searches that the current user has made Fetch all saved searches that have been shared with the current user's organization Include any saved searches that the user has created
Arguments
offset:
limit:
includeShared:
filterByName:
orderBy:
orderDirection:
savedSearches(
offset: Int,
limit: Int,
includeShared: Boolean,
filterByName: String,
orderBy: SavedSearchOrderBy,
orderDirection: OrderDirection
): SavedSearchList!
See also:
Int, Boolean, String, SavedSearchOrderBy, OrderDirection, SavedSearchList
schema
Arguments
id:
schema(id: ID!): Schema
See also:
ID, Schema
schemaProperties
Arguments
dataRegistryVersion:
search:
limit: Limit
offset: Offset
schemaProperties(
dataRegistryVersion: [DataRegistryVersion!],
search: String,
limit: Int,
offset: Int
): SchemaPropertyList
See also:
DataRegistryVersion, String, Int, SchemaPropertyList
schemas
Retrieve a list of schemas for structured data ingestions.
Arguments
id: Id of a schema to retrieve
ids: Ids of schemas to retrieve
dataRegistryId: Specify the id of the DataRegistry to get schemas
status: Specify one or more statuses to filter by schema status
majorVersion: Specify a major version to filter schemas
name: Specify a data registry name to filter schemas
nameMatch: The strategy used to find data registry name
limit: Limit
offset: Offset
orderBy: Specify one or more fields and direction to order results
schemas(
id: ID,
ids: [ID!],
dataRegistryId: ID,
status: [SchemaStatus!],
majorVersion: Int,
name: String,
nameMatch: StringMatch,
limit: Int,
offset: Int,
orderBy: [SchemaOrder]
): SchemaList
See also:
ID, SchemaStatus, Int, String, StringMatch, SchemaOrder, SchemaList
Search for media across an index. This query requires a user token.
Arguments
search: JSON structure containing the search query. TODO link to syntax documentation
searchMedia(search: JSONData!): SearchResult
See also:
JSONData, SearchResult
searchMentions
Search for mentions across an index. This query requires a user token.
Arguments
search: JSON structure containing the search query. TODO link to syntax documentation
searchMentions(search: JSONData!): SearchResult
See also:
JSONData, SearchResult
sharedCollection
Retrieve a shared collection.
Arguments
shareId: share token
sharedCollection(shareId: ID!): SharedCollection
See also:
ID, SharedCollection
sharedCollectionHistory
Retrieve shared collection history records.
Arguments
ids: Provide an ID to retrieve a single history record.
folderId: Provide a folder ID to filter by collection.
shareId: Provide a share ID to filter by share ID.
offset: Specify maximum number of results to retrieve in this result. Page size.
limit: Specify maximum number of results to retrieve in this result.
sharedCollectionHistory(
ids: [ID!],
folderId: ID,
shareId: String,
offset: Int,
limit: Int
): SharedCollectionHistoryList!
See also:
ID, String, Int, SharedCollectionHistoryList
sharedFolders
Retrieve the shared folders for an organization
Arguments
sharedFolders: [Folder]
See also:
Folder
sharedMention
Retrieve a shared mention.
Arguments
shareId: share token
sharedMention(shareId: ID!): SharedMention
See also:
ID, SharedMention
structuredData
Retrieve a structured data object.
Arguments
id: Supply the ID of the structured data object to retrieve. This will override filters.
schemaId: Schema Id for the structured data object to retrieve
structuredData(id: ID!, schemaId: ID!): StructuredData
See also:
ID, StructuredData
structuredDataObject
Retrieve a structured data object
Arguments
id: Supply the ID of the structured data object to retrieve. This will override filters.
schemaId: Schema Id for the structured data object to retrieve
structuredDataObject(id: ID!, schemaId: ID!): StructuredData
See also:
ID, StructuredData
structuredDataObjects
Retrieve a paginated list of structured data objects.
Arguments
id: Supply the ID of the structured data object to retrieve. This will override filters.
ids: List of Ids of the structured data objects to retrieve. This will override filters.
schemaId: Schema Id for the structured data object to retrieve
orderBy:
limit:
offset:
owned:
filter: Query to filter SDO. Supports operations such as and, or, eq, gt, lt, etc. TODO link to syntax documentation
structuredDataObjects(
id: ID,
ids: [ID!],
schemaId: ID!,
orderBy: [StructuredDataOrderBy!],
limit: Int,
offset: Int,
owned: Boolean,
filter: JSONData
): StructuredDataList
See also:
ID, StructuredDataOrderBy, Int, Boolean, JSONData, StructuredDataList
subscription
Arguments
id:
subscription(id: ID!): Subscription!
See also:
ID, Subscription
task
Retrieve a single task by ID.
Arguments
id: Provide the task ID.
task(id: ID!): Task
See also:
ID, Task
temporalDataObject
Retrieve a single temporal data object.
Arguments
id: the TDO ID
temporalDataObject(id: ID!): TemporalDataObject
See also:
ID, TemporalDataObject
temporalDataObjects
Retrieve a list of temporal data objects.
Arguments
applicationId: Application ID to get TDOs for. Defaults to the user's own application.
id: Provide an ID to retrieve a single specific TDO.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
sourceId: Optionally, specify a source ID. TDOs ingested from this source will be returned.
scheduledJobId: Optionally, specify a scheduled job ID. TDOs ingested under this scheduled job will be returned.
sampleMedia: Whether to retrieve only tdos with the specified sampleMedia value
includePublic: Whether to retrieve public data that is not part of the user's organization. The default is false. Pass true to include public data in the result set.
orderBy:
orderDirection:
dateTimeFilter: Provide optional filters against any date/time field to filter objects within a given time window. Matching objects must meet all of the given conditions.
mentionId: Retrieve TDOs associated with the given mention
temporalDataObjects(
applicationId: ID,
id: ID,
offset: Int,
limit: Int,
sourceId: ID,
scheduledJobId: ID,
sampleMedia: Boolean,
includePublic: Boolean,
orderBy: TemporalDataObjectOrderBy,
orderDirection: OrderDirection,
dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
mentionId: ID
): TDOList
See also:
ID, Int, Boolean, TemporalDataObjectOrderBy, OrderDirection, TemporalDataObjectDateTimeFilter, TDOList
timeZones
This query returns information about time zones recognized by this server. The information is static and does not change.
Arguments
timeZones: [TimeZone!]!
See also:
TimeZone
tokens
Retrieve user's organization API tokens
Arguments
tokens: [Token]
See also:
Token
trigger
Arguments
trigger(id: ID!): Trigger
See also:
ID, Trigger
triggers
Arguments
None.
triggers: [Trigger]
See also:
Trigger
user
Retrieve an individual user.
Arguments
id: The user ID. A user ID is a string in UUID format.
organizationIds:
user(id: ID!, organizationIds: [ID]): User
See also:
ID, User
users
Retrieve users.
Arguments
id: Provide an ID to retrieve a single specific user. A user ID is a string in UUID format.
ids: Provide IDs to retrieve multiple users by ID.
name: Provide a name, or part of one, to search by name.
organizationIds: Provide a list of organization IDs to filter your search by organization.
offset: Provide an offset to skip to a certain element in the result, for paging.
limit: Specify maximum number of results to retrieve in this result. Page size.
includeAllOrgUsers: Include all organization users.
users(
id: ID,
ids: [ID],
name: String,
organizationIds: [ID],
offset: Int,
limit: Int,
includeAllOrgUsers: Boolean
): UserList
See also:
ID, String, Int, Boolean, UserList
watchlist
Arguments
id:
watchlist(id: ID!): Watchlist
See also:
ID, Watchlist
watchlists
Arguments
isDisabled: Set true to include only disabled watchlist or false to include only enabled watchlists. By default, both are included.
watchlists(
id: ID,
maxStopDateTime: DateTime,
minStopDateTime: DateTime,
minStartDateTime: DateTime,
maxStartDateTime: DateTime,
name: String,
offset: Int,
limit: Int,
orderBy: WatchlistOrderBy,
orderDirection: OrderDirection,
isDisabled: Boolean
): WatchlistList
See also:
ID, DateTime, String, Int, WatchlistOrderBy, OrderDirection, Boolean, WatchlistList
widget
Retrieve a single Widget.
Arguments
id: The widget ID
collectionId:
organizationId:
widget(id: ID!, collectionId: ID!, organizationId: ID!): Widget
See also:
ID, Widget
workflowRuntime
Retrieve Veritone Workflow instance status by ID.
Arguments
workflowRuntimeId: an ID
workflowRuntime(workflowRuntimeId: ID!): WorkflowRuntimeResponse!
See also:
ID, WorkflowRuntimeResponse
workflowRuntimeStorageData
Get a specific WorkflowRuntimeStorageDataList based on workflow runtime ID.
Arguments
workflowRuntimeId: Unique ID of the workflow instance
storageKey: The unique ID to retrieve a single workflow data object
storageKeyPrefix: A prefix filter used to return a set of workflow data items whose dataKey starts with dataKeyPrefix
offset: Offset for paging
limit: Limit on result size, for paging (page size). Note that workflow runtime data can be arbitrarily large, therefore smaller paging should be preferred.
workflowRuntimeStorageData(
workflowRuntimeId: ID!,
storageKey: String,
storageKeyPrefix: String,
offset: Int,
limit: Int
): WorkflowRuntimeStorageDataList!
See also:
ID, String, Int, WorkflowRuntimeStorageDataList
