neptune-api is a low-level client library for accessing the Neptune API directly. It provides the underlying OpenAPI-generated client and protobuf models used by the higher-level `neptune` client library. As of version 0.26.0, it primarily serves as an internal dependency, receiving frequent updates, often monthly or bi-monthly, reflecting changes in the core Neptune API.
pip install neptune-apiVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to instantiate the low-level Neptune API client and perform a basic authenticated call to retrieve the current user's identity. This library is generally used internally by the `neptune` client, so direct interaction often requires a deeper understanding of the specific API endpoints and their corresponding request/response models. Ensure `NEPTUNE_API_TOKEN` is set as an environment variable or replaced directly.
Consider using the `neptune` library unless you specifically need low-level API access or are developing an integration for the Neptune platform.
Ensure your `protobuf` dependency is `~=4.0` or higher. Version 0.21.0 also updated allowed protobuf to include 6.x, so `protobuf>=4.0,<7.0` is generally safe.
Refer to the Neptune API documentation or the source code of the higher-level `neptune` client for examples on constructing appropriate request bodies and interpreting responses using `neptune_api.models`.
Pin your `neptune-api` version if relying on specific low-level API calls to ensure stability. Regularly review release notes for changes if you need to upgrade.