Salesforce

Ingestion and TDO APIs

« Go Back
Information
Ingestion and TDO APIs
000004254
Public
Product Selection
aiWare - aiWare
Article Details

Use these APIs to handle ingestion job and task related actions.

Create TDO and upload asset

Creates a TDO and uploads an asset. This is an easy way to upload a file. When you provide a public file URL, the query creates a container TDO and uploads the file as the primary media asset for that TDO.

[Note] The uri must be a public URL.

Example

mutation createTDOWithAsset {
  createTDOWithAsset(
    input: {
      startDateTime: 1533761172,
      stopDateTime: 1533761227,
      contentType: "video/mp4",
      assetType: "media",
      addToIndex: true,
      uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
    }
  )
  {
    id
    status
    assets {
      records {
        id
        assetType
        contentType
        signedUri
      }
    }
  }
}

Create empty TDO (no asset)

Creates an empty TDO with no assets. This query is useful for creating a container TDO to upload assets into with the createAsset mutation.

Example

mutation createTDO {
  createTDO(
    input: {
      startDateTime: 1548432520,
      stopDateTime: 1548436341
    }
  )
  {
    id
    status
  }
}

Get jobs for a given TDO

Retrieves jobs for a provided TDO.

Example

query getJobs {
  jobs(targetId: "102014611") {
    records {
      id
      createdDateTime
      status
      tasks {
        records {
          id
          status
          engine {
            id
            name
            category {
              name
            }
          }
        }
      }
    }
  }
}

Get TDO details

Retrieves TDO details such as filename, tags, and more.

Example

query getTDODetails {
  temporalDataObject(id: "102014611") {
    details
  }
}

Get duration of media file

Retrieves the duration of a media file in seconds.

Example

query getDuration {
  temporalDataObject(id: "112971783") {
    tasks {
      records {
        id
        mediaLengthSec
      }
    }
  }
}

Delete TDO

Deletes a TDO.

Example

mutation deleteTDO {
  deleteTDO(id: "64953347") {
    id
    message
  }
}

More API examples

Additional Technical Documentation Information
Properties
8/26/2024 10:02 PM
8/26/2024 10:02 PM
8/26/2024 10:02 PM
Documentation
Documentation
000004254
Translation Information
English

Powered by