Use these APIs to retrieve information.
Get assets for TDO
Retrieves assets for a TDO.
Example:
query getAssets {
temporalDataObject(id: "280670774") {
assets {
records {
sourceData {
engine {
id
name
}
}
id
createdDateTime
assetType
signedUri
}
}
}
}
Retrieves engine results in the Veritone AION standard file format.
Example:
query getEngineOutput {
engineResults(tdoId: "102014611", engineIds: ["transcribe-speechmatics-container-en-us"]) {
records {
tdoId
engineId
startOffsetMs
stopOffsetMs
jsondata
assetId
userEdited
}
}
}
Retrieves transcription and speaker detection results in Veritone's AION standard file format.
Example:
query vtn {
engineResults(tdoId: "107947027", engineIds: ["40356dac-ace5-46c7-aa02-35ef089ca9a4", "transcribe-speechmatics-container-en-us"]) {
records {
jsondata
}
}
}
Get task output by job ID
Retrieves task output by an indicated job ID. The task output displays the debug/log information reported by the engine after the task is completed.
Example:
query getEngineOutputByJob {
job(id: "18083316_nNXUOSnxJH") {
tasks {
records {
id
output
status
engine {
id
name
category {
name
}
}
}
}
}
}
Retrieves the task information by the TDO ID. The task output displays the debug/log information reported by the engine after the task is completed.
Example:
query getEngineOutputByTDO {
temporalDataObject(id: "102014611") {
tasks {
records {
id
engine {
id
name
category {
name
}
}
status
output
}
}
}
}
Export transcription results
Exports transcription results. This example shows how to limit line length to 32 characters for 3 of the 4 transcript formats, while setting it to 50 for txt.
Example:
mutation createExportRequest {
createExportRequest(input: {
includeMedia: true
tdoData: [{tdoId: "96972470"}, {tdoId: "77041379"}]
outputConfigurations:[
{
engineId:"transcribe-speechmatics"
categoryId:"67cd4dd0-2f75-445d-a6f0-2f297d6cd182"
formats:[
{
extension:"srt"
options: {
maxCharacterPerLine:32
linesPerScreen: 3
newLineOnPunctuation: true
}
},
{
extension:"vtt"
options: {
maxCharacterPerLine:32
linesPerScreen: 2
newLineOnPunctuation: false
}
},
{
extension:"ttml"
options: {
maxCharacterPerLine:32
newLineOnPunctuation: true
}
},
{
extension:"txt"
options: {
maxCharacterPerLine:50
}
}
]
}
]
}) {
id
status
organizationId
createdDateTime
modifiedDateTime
requestorId
assetUri
}
}
Check the status of an export request
Checks the status of an export request.
Example:
query checkExportStatus {
exportRequest(id:"10f6f809-ee36-4c12-97f4-d1d0cf04ea85") {
status
assetUri
requestorId
}
}
Search structured data
Searches for structured data. This example looks for media where the QUANTITY value equals 2 or the ORG_ID value equals "12343".
Example:
query searchSDO {
searchMedia(search: {
index: ["mine"],
limit: 20,
offset: 0,
query: {
conditions: [
{ operator: "term", field: "QUANTITY", value: 2 }
{ operator: "term", field: "ORG_ID", value: "12343" }
],
operator: "or"
},
type: "<schemaId goes here>"
})
{
jsondata
}
}
Get currently published schema ID
The ID in the Developer's URL is the dataRegistry ID, which contains multiple schemas. To get the ID of the currently published one (for use in the createStructuredData mutation for example), use this query:
Example
query {
dataRegistry(id: "<data registry ID>") {
publishedSchema {
id
}
}
}
More API examples
