Expand description
§nvisy-sdk
Rust client for the Nvisy Server API.
The Nvisy Server provides authentication, workspace management, persistence, and task routing for the Nvisy multimodal redaction platform. Use this crate when connecting through the managed Nvisy service rather than directly to a runtime instance.
§Installation
[dependencies]
nvisy-sdk = { version = "0.1", features = [] }
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }§Quick Start
use nvisy_sdk::{Nvisy, Result};
use nvisy_sdk::service::MonitorService;
#[tokio::main]
async fn main() -> Result<()> {
let client = Nvisy::with_api_key("your-api-key")?;
// Check service health
let health = client.health(None).await?;
println!("Status: {:?}", health.status);
println!("Checked: {}", health.timestamp);
Ok(())
}See the examples/ folder for more.
§Features
rustls-tls(default): use rustls for HTTPSnative-tls: use platform-native TLS (mutually exclusive withrustls-tls)tracing: emit tracing spans and events for HTTP requests and client lifecycle
§Deployment
The fastest way to get started is with Nvisy Cloud.
To run locally, see the nvisycom/runtime and nvisycom/server repositories.
§License
MIT License, see LICENSE.txt
§Support
- Documentation: docs.nvisy.com
- API reference: docs.rs/nvisy-sdk
- Issues: github.com/nvisycom/sdk-rs/issues
- Email: support@nvisy.com
Modules§
- model
- Data models for the Nvisy Server API.
- service
- Service modules for interacting with Nvisy Server API endpoints.
Structs§
- Nvisy
- Main Nvisy Server API client.
- Nvisy
Builder - Builder for configuring and creating a
Nvisyclient.
Enums§
- Error
- Error type for Nvisy Server API operations.
Constants§
- DEFAULT_
BASE_ URL - Default base URL for the Nvisy API.
- DEFAULT_
MAX_ RETRIES - Default maximum number of retries for transient failures.
- DEFAULT_
TIMEOUT - Default request timeout.
- DEFAULT_
USER_ AGENT - Default User-Agent header value.
Type Aliases§
- Result
- Result type for Nvisy API operations.