Grafeas: Node.js Client

release level npm version

Grafeas API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Grafeas API.
  3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/grafeas

Using the client library

// const projectId = 'my-project';

// instantiate the client.
const grpc = require('@grpc/grpc-js');
const {GrafeasClient} = require('@google-cloud/grafeas');
const client = new GrafeasClient({
  sslCreds: grpc.credentials.createInsecure(), // or any other credentials object.
  servicePath: '', // overriding the service path.
  port: 8080, // overriding the port.

// populate the request.
const formattedName = client.projectPath(projectId);
const request = {
  parent: formattedName,

// fetch the list of occurrences.
const [resp] = await client.listOccurrences(request);;


Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Grafeas.batch_create_notessource codeOpen in Cloud Shell
Grafeas.batch_create_occurrencessource codeOpen in Cloud Shell
Grafeas.create_notesource codeOpen in Cloud Shell
Grafeas.create_occurrencesource codeOpen in Cloud Shell
Grafeas.delete_notesource codeOpen in Cloud Shell
Grafeas.delete_occurrencesource codeOpen in Cloud Shell
Grafeas.get_notesource codeOpen in Cloud Shell
Grafeas.get_occurrencesource codeOpen in Cloud Shell
Grafeas.get_occurrence_notesource codeOpen in Cloud Shell
Grafeas.list_note_occurrencessource codeOpen in Cloud Shell
Grafeas.list_notessource codeOpen in Cloud Shell
Grafeas.list_occurrencessource codeOpen in Cloud Shell
Grafeas.update_notesource codeOpen in Cloud Shell
Grafeas.update_occurrencesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Grafeas Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/grafeas@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0