Google Cloud Platform logo

Google Cloud Video Intelligence API: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Video Intelligence API .

Client API Reference


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Cloud Video Intelligence API API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save @google-cloud/video-intelligence

Using the client library

// Imports the Google Cloud Video Intelligence library
const Video = require('@google-cloud/video-intelligence');

// Instantiates a client
const video = Video();

// The GCS filepath of the video to analyze
const gcsUri = 'gs://nodejs-docs-samples-video/quickstart_short.mp4';

// Construct request
const request = {
  inputUri: gcsUri,
  features: ['LABEL_DETECTION'],

// Execute request
  .then(results => {
    const operation = results[0];
      'Waiting for operation to complete... (this may take a few minutes)'
    return operation.promise();
  .then(results => {
    // Gets annotations for video
    const annotations = results[0].annotationResults[0];

    // Gets labels for video from its annotations
    const labels = annotations.segmentLabelAnnotations;
    labels.forEach(label => {
      console.log(`Label ${label.entity.description} occurs at:`);
      label.segments.forEach(segment => {
        segment = segment.segment;
        if (segment.startTimeOffset.seconds === undefined) {
          segment.startTimeOffset.seconds = 0;
        if (segment.startTimeOffset.nanos === undefined) {
          segment.startTimeOffset.nanos = 0;
        if (segment.endTimeOffset.seconds === undefined) {
          segment.endTimeOffset.seconds = 0;
        if (segment.endTimeOffset.nanos === undefined) {
          segment.endTimeOffset.nanos = 0;
          `\tStart: ${segment.startTimeOffset.seconds}` +
            `.${(segment.startTimeOffset.nanos / 1e6).toFixed(0)}s`
          `\tEnd: ${segment.endTimeOffset.seconds}.` +
            `${(segment.endTimeOffset.nanos / 1e6).toFixed(0)}s`
  .catch(err => {
    console.error('ERROR:', err);


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Source Code
Video Intelligence source code

The Video Intelligence API Node.js Client API Reference documentation also contains samples.


This library follows Semantic Versioning .

This library is considered to be in beta . This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide .


Apache Version 2.0