Struct Client 

pub struct Client { /* private fields */ }

Client for the UARP platform API.

Cloning is cheap: every clone shares one connection pool.

let client = uarp_sdk::Client::from_env()?;
let page = client.agents().list(&Default::default()).await?;

Implementations

impl Client

pub fn new(api_key: impl Into<String>) -> Result<Self>

Build a client for the production endpoint with the given API key.

pub fn from_env() -> Result<Self>

Read the API key from UARP_API_KEY (or SNAGA_API_KEY) and the base URL from UARP_BASE_URL.

pub fn builder() -> ClientBuilder

pub fn base_url(&self) -> &Url

pub fn with_options(&self, options: RequestOptions) -> Client

A clone of this client that applies options to every call made through it. The connection pool is shared, so this is cheap.

pub fn with_idempotency_key(&self, key: impl Into<String>) -> Client

Reuse a specific idempotency key, e.g. to safely replay a create.

pub fn with_timeout(&self, timeout: Duration) -> Client

pub fn with_max_retries(&self, retries: u32) -> Client

pub fn with_header( &self, name: impl Into<String>, value: impl Into<String>, ) -> Client

Add a header to every request made through the returned client.

pub fn with_query( &self, name: impl Into<String>, value: impl Into<String>, ) -> Client

Add a query parameter to every request made through the returned client.

pub fn with_stream_options(&self, stream: StreamOptions) -> Client

Reconnection behaviour for event streams opened through this clone.

pub async fn request_json<Q, B, R>(&self, req: Request<'_, Q, B>) -> Result<R>

where Q: Serialize + ?Sized + Sync, B: Serialize + ?Sized + Sync, R: DeserializeOwned,

Send a request and decode a JSON response body.

pub async fn request_empty<Q, B>(&self, req: Request<'_, Q, B>) -> Result<()>

where Q: Serialize + ?Sized + Sync, B: Serialize + ?Sized + Sync,

Send a request and discard the response body.

pub async fn request_bytes<Q, B>(&self, req: Request<'_, Q, B>) -> Result<Bytes>

where Q: Serialize + ?Sized + Sync, B: Serialize + ?Sized + Sync,

Send a request and return the raw response bytes (file downloads).

pub async fn request_text<Q, B>(&self, req: Request<'_, Q, B>) -> Result<String>

where Q: Serialize + ?Sized + Sync, B: Serialize + ?Sized + Sync,

Send a request and return the response body as text.

Separate from request_json because a text payload is not JSON that happens to be a string: deserialising JSONL or CSS into a String fails, and on the one input where it would succeed — a body that is a single quoted JSON string — it would silently strip the quotes.

pub async fn request_multipart<Q, R, F>( &self, req: Request<'_, Q, ()>, make_form: F, ) -> Result<R>

where Q: Serialize + ?Sized + Sync, R: DeserializeOwned, F: Fn() -> Result<Form> + Send + Sync,

Send a multipart/form-data request. The form is rebuilt for each retry.

pub fn request_stream<Q>( &self, path: &str, query: Option<&Q>, headers: Vec<(&'static str, String)>, ) -> EventStream

where Q: Serialize + ?Sized,

Open a server-sent event stream.

pub async fn raw<R: DeserializeOwned>( &self, method: Method, path: &str, body: Option<&Value>, ) -> Result<R>

Escape hatch for endpoints the generated surface does not cover.

impl Client

pub fn a2a(&self) -> A2AApi

Agent-to-Agent protocol: discovery and task execution

impl Client

pub fn acp(&self) -> ACPApi

Agent Communication Protocol bridge sessions

impl Client

pub fn admin(&self) -> AdminApi

Platform admin: tenants, audit, reconciliation, DLQ, analytics

impl Client

pub fn admin_config(&self) -> AdminConfigApi

Platform configuration: pricing, plans, feature flags, rate limits, runtime

impl Client

pub fn agents(&self) -> AgentsApi

Agent CRUD and versioning

impl Client

pub fn analytics(&self) -> AnalyticsApi

Tenant-scoped usage analytics

impl Client

pub fn auth(&self) -> AuthApi

User registration and OTP authentication

impl Client

pub fn billing(&self) -> BillingApi

Usage tracking, quota management, and Stripe webhooks

impl Client

pub fn bootstrap(&self) -> BootstrapApi

First-time platform setup

impl Client

pub fn bridge(&self) -> BridgeApi

Local agent bridge for Snaga desktop connections

impl Client

pub fn canvas(&self) -> CanvasApi

Canvas documents attached to a session

impl Client

pub fn companies(&self) -> CompaniesApi

Company management

impl Client

pub fn data_explorer(&self) -> DataExplorerApi

KV data explorer for admin diagnostics

impl Client

pub fn evaluations(&self) -> EvaluationsApi

Agent evaluation datasets and runs

impl Client

pub fn feed(&self) -> FeedApi

Activity feed and real-time event streaming

impl Client

pub fn feedback(&self) -> FeedbackApi

Error reports from any tenant; the inbox is super-admin only

impl Client

pub fn files(&self) -> FilesApi

File upload for multimodal content

impl Client

pub fn gdpr(&self) -> GDPRApi

Data subject access and erasure requests

impl Client

pub fn governance(&self) -> GovernanceApi

Agent governance: constitution, voting, permissions, emergency protocols

impl Client

pub fn guardrails(&self) -> GuardrailsApi

Guardrail policies

impl Client

pub fn health(&self) -> HealthApi

Health checks, readiness, and metrics

impl Client

pub fn integrations(&self) -> IntegrationsApi

OAuth integrations and connector management

impl Client

pub fn knowledge(&self) -> KnowledgeApi

Knowledge base management

impl Client

pub fn llm_credentials(&self) -> LLMCredentialsApi

LLM provider API key management

impl Client

pub fn marketplace(&self) -> MarketplaceApi

Agent marketplace: publish, search, rate

impl Client

pub fn mcp(&self) -> MCPApi

Model Context Protocol server endpoints

impl Client

pub fn me(&self) -> MeApi

The calling identity: profile, tenants, head agent

impl Client

pub fn memory(&self) -> MemoryApi

Agent memory management

impl Client

pub fn meta(&self) -> MetaApi

API metadata

impl Client

pub fn missions(&self) -> MissionsApi

Mission Execution Framework: goal → objectives → authorization gate → execution → after-action review

impl Client

pub fn notifications(&self) -> NotificationsApi

User notifications

impl Client

pub fn open_ai_compat(&self) -> OpenAiCompatApi

OpenAI-compatible ChatCompletion endpoint

impl Client

pub fn playground(&self) -> PlaygroundApi

Visual builder and agent playground

impl Client

pub fn programs(&self) -> ProgramsApi

Program (curriculum) management

impl Client

pub fn projects(&self) -> ProjectsApi

Projects — a workspace grouping agents, sessions and files

impl Client

pub fn providers(&self) -> ProvidersApi

LLM provider discovery and model listing

impl Client

pub fn public(&self) -> PublicApi

Unauthenticated public-facing endpoints

impl Client

pub fn registry(&self) -> RegistryApi

Spec registry — publish, search, yank, share spec artifacts

impl Client

pub fn reports(&self) -> ReportsApi

Content reports — abuse/moderation reporting for authenticated users and anonymous public-chat visitors, plus the operator inbox

impl Client

pub fn runs(&self) -> RunsApi

Agent execution runs, SSE streaming, HITL, continuation

impl Client

pub fn scheduler(&self) -> SchedulerApi

Cron-based scheduling

impl Client

pub fn sessions(&self) -> SessionsApi

Conversation sessions

impl Client

pub fn squads(&self) -> SquadsApi

Squads — multi-agent groups that run a shared brief

impl Client

pub fn teams(&self) -> TeamsApi

Team management and team chat

impl Client

pub fn tenants(&self) -> TenantsApi

Tenant management and API keys

impl Client

pub fn users(&self) -> UsersApi

User management, invites, roles

impl Client

pub fn webhooks(&self) -> WebhooksApi

Webhook subscriptions

impl Client

pub fn workspaces(&self) -> WorkspacesApi

Workspace management, file storage, and sharing

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.