Struct Synth 

pub struct Synth { /* private fields */ }

Main Synth AI client.

This is the primary entry point for interacting with Synth AI APIs.

Example

use synth_ai::Synth;

let synth = Synth::from_env()?;

// Or with explicit credentials
let synth = Synth::new("sk_live_...", None)?;

Implementations

impl Synth

pub fn new(api_key: impl Into<String>, base_url: Option<&str>) -> Result<Self>

Create a new Synth client with explicit credentials.

Arguments

• api_key - Your Synth API key
• base_url - Optional custom API base URL

pub fn from_env() -> Result<Self>

Create a client from the SYNTH_API_KEY environment variable.

pub fn api_key_masked(&self) -> String

Get the API key (masked for display).

pub fn base_url(&self) -> &str

Get the base URL.

pub fn core(&self) -> &SynthClient

Access the underlying core client.

pub fn optimize(&self) -> OptimizeBuilder

Start a prompt optimization job.

Returns a builder to configure the optimization.

pub fn eval(&self) -> EvalBuilder

Start an evaluation job.

Returns a builder to configure the evaluation.

pub async fn tunnel( &self, port: u16, backend: TunnelBackend, ) -> Result<TunnelHandle>

Open a tunnel to a local port.

Arguments

• port - Local port to tunnel
• backend - Tunnel backend (cloudflare_managed_lease recommended)

pub async fn submit_gepa(&self, request: GepaJobRequest) -> Result<String>

Submit a raw GEPA job.

pub async fn submit_mipro(&self, request: MiproJobRequest) -> Result<String>

Submit a raw MIPRO job.

pub async fn get_job_status(&self, job_id: &str) -> Result<PromptLearningResult>

Get job status.

pub async fn poll_job( &self, job_id: &str, timeout_secs: f64, interval_secs: f64, ) -> Result<PromptLearningResult>

Poll job until complete.

pub async fn cancel_job(&self, job_id: &str, reason: Option<&str>) -> Result<()>

Cancel a job.

pub async fn complete( &self, request: GraphCompletionRequest, ) -> Result<GraphCompletionResponse>

Run graph completion.

pub async fn verify( &self, trace: Value, rubric: Value, options: Option<VerifierOptions>, ) -> Result<VerifierResponse>

Run verifier on a trace.

Trait Implementations

impl Debug for Synth

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

Formats the value using the given formatter.