gRPC API

Call Nominal’s services over gRPC, with your API key.

Use the gRPC API from Python or Go, which have generated clients: nominal-api-protos on PyPI and the nominal-api-protos-go Go module. These are low-level packages that call the gRPC services directly. From other languages, use the REST API.

Connect over TLS to your base URL’s host on port 443, such as api.gov.nominal.io:443. Every call needs your API key in the authorization metadata: Bearer <api key>. API keys setup shows where to find your key and base URL.

Services

Data

• Containerized extractor service

• Data connector service

• Data deletion service

• Dataset retention service

• Ingest service

• Native extractor service

• SQL service

• Streaming session service

• Units service

Metadata

• Asset service

• Blob storage service

• Comments service

• Event service

Checklists and procedures

• Procedure executions service

• Procedures service

Access and administration

• Group service

• Marking service

• Permission service

• Role service

• Workspace service

Apps and integrations

• Application service

• Connect apps service

• Connect demo apps service

• Connect download service

• Registry service

Errors

A failed call returns a gRPC status with a code and a message. For an error a service defines, the status also has a google.rpc.ErrorInfo detail. Its reason says which error it is, such as GROUP_ERRORS_NOT_FOUND, and its domain is the service’s proto package, such as nominal.authentication.groups.v1. Each service’s page lists the errors it defines.