Examples - Nvisy

The Python SDK currently exposes a generic HTTP client. These examples call endpoints by path — see the API Reference for the full endpoint list.

Synchronous Usage

from nvisy import Client

with Client({"api_key": "your-api-token"}) as client:
    workspaces = client.get_sync("/workspaces")
    print(workspaces)

Async Usage

import asyncio

from nvisy import Client

async def main() -> None:
    async with Client({"api_key": "your-api-token"}) as client:
        workspaces = await client.get("/workspaces")
        print(workspaces)

asyncio.run(main())

Configuration from the Environment

import os

os.environ["NVISY_API_TOKEN"] = "your-api-token"

client = Client.from_environment()

Variable	Description
`NVISY_API_TOKEN`	API token (required)
`NVISY_BASE_URL`	Custom API endpoint
`NVISY_MAX_TIMEOUT`	Request timeout in milliseconds
`NVISY_MAX_RETRIES`	Maximum retry attempts
`NVISY_USER_AGENT`	Custom user agent
`DEBUG`	Set to `true`/`1`/`yes` to enable debug mode

Calling an Endpoint by Path

The SDK does not model resources, so requests are made by path and the response is returned as a plain dict. Consult the API Reference for the current paths, parameters, and response shapes.

response = client.get_sync(
    "/workspaces",
    params={"limit": 50},
)

for item in response["items"]:
    print(item["id"])

Because paths are passed as raw strings, nothing in the SDK validates them against the current API. Endpoint paths changed in the latest API revision — verify each path against the API Reference rather than copying from older code.

Error Handling

from nvisy import ApiError, ConfigError, NetworkError

workspace_id = "..."

try:
    response = client.get_sync(f"/workspaces/{workspace_id}")
except ApiError as error:
    print(f"[{error.status_code}] {error}")
    if error.request_id:
        print("request id:", error.request_id)
except NetworkError as error:
    print("network failure:", error)
except ConfigError as error:
    print("bad configuration:", error)

Custom Timeouts and Retries

client = (
    Client.builder()
    .with_api_key("your-api-token")
    .with_timeout(120.0)
    .with_max_retries(5)
    .with_debug(True)
    .build()
)