Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Build an async client for the SystemOne API.

Settings resolve in priority order: explicit builder value → OPENKIND_* environment variable → TYPESAFE_* environment variable (for drop-in parity with the Python SDK) → SDK default. The API key is required unless allow_unauthenticated is selected; everything else has a default. Cloudflare mode selects its own account URL and typesafe/jev model unless overridden explicitly.

Examples

use openkind_client::Client;

// Hosted TypeSafe API (default base URL).
let client = Client::builder().api_key("sk-...").build()?;

// Local daemon.
let local = Client::builder()
    .api_key("dev-key")
    .base_url("http://127.0.0.1:18080")
    .build()?;

Implementations

impl ClientBuilder

pub fn new() -> Self

A builder with every setting unset (environment/defaults apply).

pub fn api_key(self, api_key: impl Into<String>) -> Self

Bearer API key. Falls back to OPENKIND_API_KEY, then TYPESAFE_API_KEY, when unset.

pub fn allow_unauthenticated(self) -> Self

Allow a missing API key when connecting to an unauthenticated daemon. Supplied and environment keys still resolve and validate normally.

pub fn base_url(self, base_url: impl Into<String>) -> Self

API base URL, e.g. http://127.0.0.1:18080. Falls back to OPENKIND_BASE_URL, then TYPESAFE_BASE_URL, then DEFAULT_BASE_URL.

pub fn cloudflare_account(self, account_id: impl Into<String>) -> Self

Use Cloudflare Workers AI Jev through the account’s /ai/run API. The API token is supplied with api_key. An explicit base_url may override the Cloudflare host for a proxy or test server. Cloudflare mode ignores base URL and model env defaults.

pub fn default_model(self, model: impl Into<String>) -> Self

Model alias used by Client::system_one when the request does not name one. Falls back to OPENKIND_DEFAULT_MODEL, then TYPESAFE_DEFAULT_MODEL, then DEFAULT_MODEL.

pub fn timeout(self, timeout: Duration) -> Self

Per-attempt request timeout. Default 10s.

pub fn connect_timeout(self, timeout: Duration) -> Self

TCP connect timeout. Unset by default.

pub fn retry(self, retry: RetryPolicy) -> Self

Retry behavior. Defaults to RetryPolicy::default.

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

A header sent with every request.

pub fn http_client(self, client: Client) -> Self

Supply a preconfigured reqwest::Client (connection pooling, proxy, TLS settings). Default headers and timeouts are still applied per-request by this SDK.

pub fn build(self) -> Result<Client, Error>

Validate settings and construct the Client.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.