A Rust client library for the Runpod API. This SDK provides a type-safe, ergonomic interface for managing Pods, Serverless endpoints, templates, network volumes, and more.
This crate is a fork of the original runpod.rs developed by Patrick Barker.
- Serverless Endpoints: Full endpoint management with configuration
- Type Safety: Strongly typed models with comprehensive validation
- Async/Await: Built on modern async Rust with
tokioandreqwest
Add this to your Cargo.toml:
[dependencies]
tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }
runpod-sdk = { version = "0.2", features = ["serverless"] }use runpod_sdk::{RunpodClient, Result};
use runpod_sdk::service::PodsService;
use std::time::Duration;
#[tokio::main]
async fn main() -> Result<()> {
let client = RunpodClient::builder()
.with_api_key("your-api-key")
.with_timeout(Duration::from_secs(60))
.build_client()?;
let pods = client.list_pods(Default::default()).await?;
println!("Found {} pods", pods.len());
Ok(())
}The SDK can be configured using environment variables:
| Variable | Required | Default | Description |
|---|---|---|---|
RUNPOD_API_KEY |
Yes | - | Your RunPod API key from console settings |
RUNPOD_REST_URL |
No | https://rest.runpod.io/v1 |
Custom REST API base URL |
RUNPOD_API_URL |
No | https://api.runpod.io/v2 |
Custom API URL for serverless endpoints (requires serverless feature) |
RUNPOD_TIMEOUT_SECS |
No | 30 |
Request timeout in seconds (max: 300) |
use runpod_sdk::{RunpodClient, Result};
#[tokio::main]
async fn main() -> Result<()> {
let client: RunpodClient = RunpodClient::from_env()?;
Ok(())
}Choose between two TLS implementations:
# Default: rustls-tls (recommended)
runpod-sdk = { version = "0.2", features = [] }
# Alternative: native-tls
runpod-sdk = { version = "0.2", features = ["native-tls"], default-features = false }Enable comprehensive logging and tracing via the tracing crate.
Tracing targets are defined in lib.rs for fine-grained control over log output:
runpod-sdk = { version = "0.2", features = ["tracing"] }The examples/ directory contains comprehensive usage examples:
# Set your API key
export RUNPOD_API_KEY="your-api-key"
# Run the basic usage example
cargo run --example basic_usage
# Run the endpoint lifecycle management example
cargo run --example manage_endpoint
# Run the serverless endpoint example (requires serverless feature)
export RUNPOD_ENDPOINT_ID="your-endpoint-id"
cargo run --example run_endpoint --features serverlessContributions are welcome! Please read our Contributing Guide for details on how to submit pull requests, report issues, and contribute to the project.
This project is licensed under the MIT License - see the LICENSE.txt file for details.