Struct RunpodClient 

pub struct RunpodClient { /* private fields */ }

Main RunPod API client for interacting with all RunPod services.

The RunpodClient provides access to all RunPod API endpoints through specialized service interfaces. It handles authentication, request/response serialization, and provides a consistent async interface for all operations.

Features

• Thread-safe: Safe to use across multiple threads
• Cheap to clone: Uses Arc internally for efficient cloning
• Automatic authentication: Handles API key authentication automatically
• Comprehensive coverage: Access to all RunPod services (Pods, Endpoints, Templates, etc.)

Services

The client implements V1 API service traits that provide direct access to API methods:

• PodsService - Pod lifecycle management
• EndpointsService - Serverless endpoint operations
• TemplatesService - Template creation and management
• VolumesService - Network volume operations
• RegistryService - Registry authentication
• BillingService - Usage and billing information

Examples

Basic usage with environment configuration

use runpod_sdk::{RunpodClient, Result};
use runpod_sdk::model::ListPodsQuery;
use runpod_sdk::service::PodsService;

let client = RunpodClient::from_env()?;

// List all pods
let pods = client.list_pods(ListPodsQuery::default()).await?;
println!("Found {} pods", pods.len());

Custom configuration with builder pattern

use runpod_sdk::{RunpodConfig, RunpodClient, Result};
use runpod_sdk::service::{PodsService, EndpointsService, TemplatesService};
use std::time::Duration;

let client = RunpodConfig::builder()
    .with_api_key("your-api-key")
    .with_rest_url("https://rest.runpod.io/v1")
    .with_timeout(Duration::from_secs(30))
    .build_client()?;

// Use different services
let pods = client.list_pods(Default::default()).await?;
let endpoints = client.list_endpoints(Default::default()).await?;
let templates = client.list_templates(Default::default()).await?;

Multi-threaded usage

The client is cheap to clone (uses Arc internally):

use runpod_sdk::{RunpodClient, Result};
use runpod_sdk::service::PodsService;
use tokio::task;

let client = RunpodClient::from_env()?;

let handles: Vec<_> = (0..3).map(|i| {
    let client = client.clone();
    task::spawn(async move {
        let pods = client.list_pods(Default::default()).await?;
        println!("Thread {}: Found {} pods", i, pods.len());
        Ok::<(), runpod_sdk::Error>(())
    })
}).collect();

for handle in handles {
    handle.await.unwrap()?;
}

Implementations

impl RunpodClient

pub fn new(config: RunpodConfig) -> Result<Self>

Creates a new Runpod API client.

pub fn builder() -> RunpodBuilder

Creates a new configuration builder for constructing a RunPod client.

This is a convenience method that returns a RunpodConfigBuilder for building a custom client configuration.

Example

let client = RunpodClient::builder()
    .with_api_key("your-api-key")
    .with_timeout(Duration::from_secs(60))
    .build_client()?;

pub fn from_env() -> Result<Self>

Creates a new Runpod API client from environment variables.

This is a convenience method that creates a RunpodConfig from environment variables and then creates a client from that config.

Environment Variables

• RUNPOD_API_KEY - Your RunPod API key (required)
• RUNPOD_BASE_URL - Base URL for the API (optional, defaults to https://rest.runpod.io/v1)
• RUNPOD_TIMEOUT_SECS - Request timeout in seconds (optional, defaults to 30)

Example

let client = RunpodClient::from_env()?;

Trait Implementations

impl BillingService for RunpodClient

async fn get_pod_billing( &self, query: PodBillingQuery, ) -> Result<BillingRecords>

Retrieves detailed Pod billing history and usage data.

async fn get_endpoint_billing( &self, query: EndpointBillingQuery, ) -> Result<BillingRecords>

Retrieves comprehensive Serverless endpoint billing history and metrics.

async fn get_volume_billing( &self, query: NetworkVolumeBillingQuery, ) -> Result<BillingRecords>

Retrieves Network Volume billing history and storage usage metrics.

impl Clone for RunpodClient

fn clone(&self) -> RunpodClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunpodClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EndpointsService for RunpodClient

async fn create_endpoint(&self, input: EndpointCreateInput) -> Result<Endpoint>

Creates a new serverless endpoint.

async fn list_endpoints(&self, query: ListEndpointsQuery) -> Result<Endpoints>

Lists serverless endpoints with optional filtering.

async fn get_endpoint( &self, endpoint_id: &str, query: GetEndpointQuery, ) -> Result<Endpoint>

Gets a specific endpoint by ID.

async fn update_endpoint( &self, endpoint_id: &str, input: EndpointUpdateInput, ) -> Result<Endpoint>

Updates an existing endpoint.

async fn delete_endpoint(&self, endpoint_id: &str) -> Result<()>

Deletes an endpoint.

impl PodsService for RunpodClient

async fn create_pod(&self, input: PodCreateInput) -> Result<Pod>

Creates a new pod.

async fn list_pods(&self, query: ListPodsQuery) -> Result<Pods>

Lists pods with optional filtering.

async fn get_pod(&self, pod_id: &str, query: GetPodQuery) -> Result<Pod>

Gets a specific pod by ID.

async fn update_pod(&self, pod_id: &str, input: PodUpdateInput) -> Result<Pod>

Updates an existing pod.

async fn delete_pod(&self, pod_id: &str) -> Result<()>

Deletes a pod.

async fn start_pod(&self, pod_id: &str) -> Result<()>

Starts or resumes a pod.

async fn stop_pod(&self, pod_id: &str) -> Result<()>

Stops a pod.

async fn reset_pod(&self, pod_id: &str) -> Result<()>

Resets a pod.

async fn restart_pod(&self, pod_id: &str) -> Result<()>

Restarts a pod.

impl RegistryService for RunpodClient

async fn create_registry_auth( &self, input: ContainerRegistryAuthCreateInput, ) -> Result<ContainerRegistryAuth>

Creates a new container registry authentication.

async fn list_registry_auths(&self) -> Result<ContainerRegistryAuths>

Lists all container registry authentications.

async fn get_registry_auth( &self, auth_id: &str, ) -> Result<ContainerRegistryAuth>

Gets a specific container registry authentication by ID.

async fn delete_registry_auth(&self, auth_id: &str) -> Result<()>

Deletes a container registry authentication.

impl TemplatesService for RunpodClient

async fn create_template(&self, input: TemplateCreateInput) -> Result<Template>

Creates a new template.

async fn list_templates(&self, query: ListTemplatesQuery) -> Result<Templates>

Lists templates with optional filtering.

async fn get_template( &self, template_id: &str, query: GetTemplateQuery, ) -> Result<Template>

Gets a specific template by ID.

async fn update_template( &self, template_id: &str, input: TemplateUpdateInput, ) -> Result<Template>

Updates an existing template.

async fn delete_template(&self, template_id: &str) -> Result<()>

Deletes a template.

impl VolumesService for RunpodClient

async fn create_volume( &self, input: NetworkVolumeCreateInput, ) -> Result<NetworkVolume>

Creates a new network volume.

async fn list_volumes(&self) -> Result<NetworkVolumes>

Lists all network volumes.

async fn get_volume(&self, volume_id: &str) -> Result<NetworkVolume>

Gets a specific network volume by ID.

async fn update_volume( &self, volume_id: &str, input: NetworkVolumeUpdateInput, ) -> Result<NetworkVolume>

Updates an existing network volume.

async fn delete_volume(&self, volume_id: &str) -> Result<()>

Deletes a network volume.