Registry / database / neptune-api

neptune-api

JSON →
library0.26.0pypypi✓ verified 22d ago

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-api
INSTALL
IMPORT
SIG · NEPTUNE-API
N
neptune-api
databasepythonv0.26.0
Install
3.1s avg
Import
272ms
Disk
27MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.26.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.284s · 27.8MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 3.1s · import 0.260s · 29MB
27MB installed
● package 27MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Client
from neptune_api import Client
from neptune_api.api.client import Client as ApiClient
AuthenticatedClient
from neptune_api import AuthenticatedClient

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.

import os from neptune_api.api.client import Client as ApiClient from neptune_api.exceptions import UnauthorizedException NEPTUNE_API_TOKEN = os.environ.get("NEPTUNE_API_TOKEN", "YOUR_API_TOKEN") if NEPTUNE_API_TOKEN == "YOUR_API_TOKEN": print("Please set the NEPTUNE_API_TOKEN environment variable or replace 'YOUR_API_TOKEN' directly.") exit(1) try: # Initialize the low-level API client api_client = ApiClient(api_token=NEPTUNE_API_TOKEN) # Example: Get the current user's identity # This is a basic authenticated call to verify setup. user_identity = api_client.post_get_user_identity() print(f"Successfully authenticated as user ID: {user_identity.id}") # To interact with specific resources (e.g., runs, projects), you would use # methods like `api_client.post_create_run` or `api_client.post_get_project_member_v2` # along with corresponding models from `neptune_api.models`. except UnauthorizedException: print("Authentication failed. Please check your NEPTUNE_API_TOKEN.") except Exception as e: print(f"An error occurred: {e}")
Debug
Known issues
gotchaThis library (`neptune-api`) is primarily an internal dependency for the main `neptune` client library. For most users, it is recommended to install and use the `neptune` library (`pip install neptune`) for a higher-level, more user-friendly experience.
fix
Consider using the `neptune` library unless you specifically need low-level API access or are developing an integration for the Neptune platform.
affects: All versions
breakingVersion 0.25.0 removed support for `protobuf` versions older than 4.0.0. If you are using an older `protobuf` version, this will cause dependency resolution issues or runtime errors.
fix
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.
affects: >=0.25.0
gotchaThe `ApiClient` methods are often low-level, directly mapping to HTTP verbs and API endpoints (e.g., `post_create_run`, `get_project_details`). Interacting with them often requires detailed knowledge of the Neptune API's request/response structure and protobuf models.
fix
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`.
affects: All versions
deprecatedThe `neptune-api` library is under continuous development, and internal API structures (like storage, ingestion APIs) are frequently updated. This can lead to breaking changes in specific service methods or models between minor versions, even without explicit 'breaking change' notes if used directly.
fix
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.
affects: All versions
Upgrade
Version history
0.26.0latest on PyPI · released Jan 7, 2026
Audit
Dependencies
protobufrequiredUsed for serializing and deserializing data models; strict version compatibility is enforced.
Agent activity
7 hits · last 30 days
node
6
Resources
neptune-api — pip install neptune-api · libregistry