Struct CoreClient 

pub struct CoreClient { /* private fields */ }

Synth API client.

This is the main entry point for interacting with the Synth API. It provides access to sub-clients for different API endpoints.

Example

use synth_ai_core::api::SynthClient;

// Create from environment variable
let client = SynthClient::from_env()?;

// Or with explicit API key
let client = SynthClient::new("sk_live_...", None)?;

// Access sub-clients
let jobs = client.jobs();
let eval = client.eval();
let graphs = client.graphs();

Implementations

impl SynthClient

pub fn new( api_key: &str, base_url: Option<&str>, ) -> Result<SynthClient, CoreError>

Create a new Synth client with an API key.

Arguments

• api_key - Your Synth API key
• base_url - Optional base URL (defaults to https://api.usesynth.ai)

Example

let client = SynthClient::new("sk_live_...", None)?;

pub fn with_timeout( api_key: &str, base_url: Option<&str>, timeout_secs: u64, ) -> Result<SynthClient, CoreError>

Create a new Synth client with custom timeout.

Arguments

• api_key - Your Synth API key
• base_url - Optional base URL
• timeout_secs - Request timeout in seconds

pub fn from_env() -> Result<SynthClient, CoreError>

Create a client from environment variables.

Reads the API key from SYNTH_API_KEY environment variable. Optionally reads base URL from SYNTH_BACKEND_URL.

Example

std::env::set_var("SYNTH_API_KEY", "sk_live_...");
let client = SynthClient::from_env()?;

pub async fn from_env_or_mint( allow_mint: bool, base_url: Option<&str>, ) -> Result<SynthClient, CoreError>

Create a client, minting a demo key if needed.

This will:

1. Try to get an API key from environment
2. If not found and allow_mint is true, mint a demo key

Arguments

• allow_mint - Whether to mint a demo key if no key is found
• base_url - Optional base URL

pub fn base_url(&self) -> &str

Get the base URL for this client.

pub fn http(&self) -> &HttpClient

Get a reference to the HTTP client.

pub fn jobs(&self) -> JobsClient<'_>

Get a Jobs API client.

Use this to submit, poll, and cancel optimization jobs.

Example

let job_id = client.jobs().submit_gepa(request).await?;
let result = client.jobs().poll_until_complete(&job_id, 3600.0, 15.0).await?;

pub fn eval(&self) -> EvalClient<'_>

Get an Eval API client.

Use this to run evaluation jobs.

Example

let job_id = client.eval().submit(request).await?;
let result = client.eval().poll_until_complete(&job_id, 3600.0, 15.0).await?;

pub fn graphs(&self) -> GraphsClient<'_>

Get a Graphs API client.

Use this for graph completions and verifier inference.

Example

let result = client.graphs().verify(trace, rubric, None).await?;

pub fn graph_evolve(&self) -> GraphEvolveClient<'_>

Get a Graph Evolve API client.

Use this for Graph Evolve / GraphGen optimization endpoints.

pub fn inference(&self) -> InferenceClient<'_>

Get an Inference API client.

Use this for chat completions via the inference proxy.

pub fn localapi(&self) -> LocalApiDeployClient<'_>

Get a LocalAPI Deployments client.

Use this to deploy and manage managed LocalAPI deployments.

Trait Implementations

impl Debug for SynthClient

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

Formats the value using the given formatter.