Skip to main content

Serverless Posttraining for Agents - Core AI functionality and tracing

Project description

Synth

Python PyPI Crates.io License

Prompt Optimization, Graphs, and Agent Infrastructure

Use the sdk in Python (uv add synth-ai) and Rust (beta) (cargo add synth-ai), or hit our serverless endpoints in any language

Synth Style

For engineering principles and coding standards, follow: specifications/tanha/references/synthstyle.md.

Shows a bar chart comparing prompt optimization performance across GPT-4.1 Nano, GPT-4o Mini, and GPT-5 Nano with baseline vs GEPA optimized.

Average accuracy on LangProBe prompt optimization benchmarks.

Demo Walkthroughs

Benchmark and demo runner source files have moved to the Benchmarking repo (../Benchmarking in a sibling checkout).

Highlights

  • 🎯 GEPA Prompt Optimization - Automatically improve prompts with evolutionary search. See 70%→95% accuracy gains on Banking77, +62% on critical game achievements
  • 🔍 Zero-Shot Verifiers - Fast, accurate rubric-based evaluation with configurable scoring criteria
  • 🧬 GraphGen - Train custom verifier graphs optimized for your specific workflows. Train custom pipelines for other tasks
  • 🧰 Environment Pools - Managed sandboxes and browser pools for coding and computer-use agents
  • 🚀 No Code Changes - Wrap existing code in a FastAPI app and optimize via HTTP. Works with any language or framework
  • ⚡️ Local Development - Run experiments locally with tunneled containers. No cloud setup required
  • 🗂️ Multi-Experiment Management - Track and compare prompts/models across runs with built-in experiment queues

Getting Started

SDK (Python)

pip install synth-ai==0.9.0
# or
uv add synth-ai

GEPA Compatibility (Python)

Drop-in usage for gepa-ai style workflows:

from synth_ai import gepa

trainset, valset, _ = gepa.examples.aime.init_dataset()
result = gepa.optimize(
    seed_candidate={"system_prompt": "You are a helpful assistant."},
    trainset=trainset,
    valset=valset,
    task_lm="openai/gpt-4.1-mini",
    max_metric_calls=150,
    reflection_lm="openai/gpt-5",
)
print(result.best_candidate["system_prompt"])

Requires SYNTH_API_KEY and access to the Synth backend. Full Banking77 runthrough: ../Benchmarking/demos/gepa_banking77_compat.py.

SDK (Rust - Beta)

cargo add synth-ai

TUI (Homebrew)

brew install synth-laboratories/tap/synth-ai-tui
synth-ai-tui

The TUI provides a visual interface for managing jobs, viewing events, and monitoring optimization runs.

OpenCode Skills (Synth API)

The Synth-AI TUI integrates with OpenCode and ships a synth-api skill.

# List packaged skills shipped with synth-ai
uvx synth-ai skill list
uvx synth-ai skill install synth-api --dir ~/custom/opencode/skill

Container Deploy (Cloud)

Deploy a Container with a Dockerfile and get a stable container_url:

export SYNTH_API_KEY=sk_live_...
synth container deploy \
  --name my-container \
  --app my_module:app \
  --dockerfile ./Dockerfile \
  --context . \
  --wait

Use the emitted container_url in training configs. Harbor auth uses SYNTH_API_KEY as the container API key.

Tunnels

Synth optimization jobs need HTTPS access to your local container. Two tunnel backends are available:

SynthTunnel (Recommended)

Relay-based tunnel — no external binary required, supports 128 concurrent requests:

from synth_ai.core.tunnels import TunneledContainer

tunnel = await TunneledContainer.create(local_port=8001, api_key="sk_live_...")
print(tunnel.url)            # https://st.usesynth.ai/s/rt_...
print(tunnel.worker_token)   # pass to job config

Use with optimization jobs:

job = PromptLearningJob.from_dict(
    config,
    container_url=tunnel.url,
    container_worker_token=tunnel.worker_token,
)

Cloudflare Quick Tunnel

Anonymous tunnel via trycloudflare.com — no API key needed:

from synth_ai.core.tunnels import TunneledContainer, TunnelBackend

tunnel = await TunneledContainer.create(
    local_port=8001,
    backend=TunnelBackend.CloudflareQuickTunnel,
)

Requires cloudflared installed (brew install cloudflared). For policy optimization, do not pass container_api_key in payloads; use container_worker_token and let backend resolve container auth.

See the tunnels documentation for the full comparison.

Auth Basics (Don’t Mix These)

There are three different keys in the Container + SynthTunnel flow:

  • Synth API key (SYNTH_API_KEY): Auth for the backend (SYNTH_BACKEND_URL).
    • Sent as Authorization: Bearer <SYNTH_API_KEY>.
    • Used when submitting jobs to http://127.0.0.1:8080 (local) or https://api.usesynth.ai (cloud).
  • Environment API key (ENVIRONMENT_API_KEY): Auth for your container.
    • Sent as x-api-key: <ENVIRONMENT_API_KEY> to /health, /info, /rollout, etc.
    • Minted/managed by ensure_container_auth().
  • SynthTunnel worker token (tunnel.worker_token): Auth for tunnel relay → container.
    • Passed to jobs as container_worker_token.
    • Never use this as a backend API key.

Common failures:

  • Invalid API key on /api/v1/offline/jobs/* means the backend received the wrong key.
  • SYNTH_TUNNEL_ERROR: Invalid worker token means the tunnel relay token is wrong.

CRITICAL: Container Auth Payload Rule (NO EXCEPTIONS)

  • Do not embed container_api_key or container_api_keys in policy-optimization job payloads (config_body, overrides, or nested prompt_learning.* fields).
  • Container auth for policy optimization is server-resolved from org credentials.
  • Client code may validate local availability of env keys, but payloads must not carry them.

Branching and CI

Branch model (all repos)

dev  ──PR──>  staging  ──PR──>  main
                 │
              integration
              tests run
Branch Purpose
dev Daily development
staging Pre-release gate with full CI
main Released / production code

How CI works for this repo

Cross-repo integration tests live in the testing repo (synth-laboratories/testing).

  1. When a PR targets staging in testing, CI checks out synth-ai at the matching branch (e.g. staging). Falls back to main if the branch doesn't exist.
  2. Tests that exercise synth-ai code:
    • synth_ai_unit_testspytest tests/unit (runs on every push)
    • synth_ai_all_tests — package-focused SDK tests from synth-ai-tests/ in the testing repo
    • testing_unit_testspytest synth-ai-tests/unit/

Standard workflow

  1. Work on dev.
  2. When ready to validate, push dev and open a PR in testing: dev -> staging.
  3. CI runs unit and cross-repo integration tests against the matching synth-ai branch.
  4. After staging is green, merge staging -> main in each repo.

Running tests locally

From the testing repo (sibling checkout):

cd ../testing
bazel test //:offline_tests             # unit tests only
bazel test //:no_llm_tests              # everything except LLM-dependent tests
bazel test //:all_tests                 # everything

Or directly:

uv run pytest tests/unit -v

See testing/CLAUDE.md for the full test tier and suite reference.

Testing

Run the TUI integration tests:

cd tui/app
bun test

Synth is maintained by devs behind the MIPROv2 prompt optimizer.

Documentation

docs.usesynth.ai

Community

Join our Discord

GEPA Prompt Optimization (SDK)

Run GEPA prompt optimization programmatically:

import asyncio
import os
from synth_ai.sdk.api.train.prompt_learning import PromptLearningJob
from synth_ai.sdk.container import ContainerConfig, create_container

# Create a local container: app = create_container(ContainerConfig(app_id="my_app", handler=my_handler))

# Create and submit a GEPA job
pl_job = PromptLearningJob.from_dict({
    "job_type": "prompt_learning",
    "config": {
        "prompt_learning": {
            "gepa": {
                "rollout": {"budget": 100},
                "population_size": 10,
                "generations": 5,
                "actionable_upfront_context": {
                    "source_uri": "s3://my-bucket/engine-bench-codebase.tar.gz",
                    "upload_route": "/upload_context",
                    "required": False,
                },
            }
        }
    },
    "container_id": "my_container",
})

pl_job.submit()
result = pl_job.stream_until_complete(timeout=3600.0)
print(f"Best score: {result.best_score}")

See the Banking77 walkthrough for a complete example with local containers. For proposer backend selection (prompt, rlm, agent), see ../specifications/tanha/current/systems/platform/gepa_proposer_backends.md.

Online MIPRO (SDK, Ontology Enabled)

Run online MIPRO so rollouts call a proxy URL and rewards stream back to the optimizer. Enable ontology by setting MIPRO_ONT_ENABLED=1 and HELIX_URL on the backend, then follow the Banking77 online MIPRO notes.

import os
from synth_ai.sdk.optimization.policy import MiproOnlineSession

# Use the demo config shape from Benchmarking/demos (see sibling repo)
mipro_config = {...}

session = MiproOnlineSession.create(
    config_body=mipro_config,
    api_key=os.environ["SYNTH_API_KEY"],
)
urls = session.get_prompt_urls()
proxy_url = urls["online_url"]

# Use proxy_url in your rollout loop, then report rewards
session.update_reward(
    reward_info={"score": 0.9},
    rollout_id="rollout_001",
    candidate_id="candidate_abc",
)

Graph Evolve: Optimize RLM-Based Verifier Graphs

Train a verifier graph with an RLM backbone for long-context evaluation. See the Image Style Matching walkthrough for a complete Graph Evolve example:

from synth_ai.sdk.api.train.graph_evolve import GraphEvolveJob

# Train an RLM-based verifier graph
verifier_job = GraphEvolveJob.from_dataset(
    dataset="verifier_dataset.json",
    graph_type="rlm",
    policy_models=["gpt-4.1"],
    proposer_effort="medium",  # Use "medium" (gpt-4.1) or "high" (gpt-5.2)
    rollout_budget=200,
)
verifier_job.submit()
result = verifier_job.stream_until_complete(timeout=3600.0)

# Run inference with trained verifier
verification = verifier_job.run_verifier(
    trace=my_trace,
    context={"rubric": my_rubric},
)
print(f"Reward: {verification.reward}, Reasoning: {verification.reasoning}")

Zero-Shot Verifiers (SDK)

Run a built-in verifier graph with rubric criteria passed at runtime. See the Crafter VLM demo for verifier optimization:

import asyncio
import os
from synth_ai.sdk.graphs import VerifierClient

async def run_verifier():
    client = VerifierClient(
        base_url=os.environ["SYNTH_BACKEND_BASE"],
        api_key=os.environ["SYNTH_API_KEY"],
    )
    result = await client.evaluate(
        job_id="zero_shot_verifier_single",
        trace={"session_id": "s", "session_time_steps": []},
        rubric={
            "event": [{"id": "accuracy", "weight": 1.0, "description": "Correctness"}],
            "outcome": [{"id": "task_completion", "weight": 1.0, "description": "Completed task"}],
        },
        options={"event": True, "outcome": True, "model": "gpt-5-nano"},
        policy_name="my_policy",
        container_id="my_task",
    )
    return result

asyncio.run(run_verifier())

You can also call arbitrary graphs directly with the Rust SDK:

use serde_json::json;
use synth_ai::{GraphCompletionRequest, Synth};

#[tokio::main]
async fn main() -> Result<(), synth_ai::Error> {
    let synth = Synth::from_env()?;

    let request = GraphCompletionRequest {
        job_id: "zero_shot_verifier_rubric_single".to_string(),
        input: json!({
            "trace": {"session_id": "s", "session_time_steps": []},
            "rubric": {"event": [], "outcome": []},
        }),
        model: None,
        prompt_snapshot_id: None,
        stream: None,
    };

    let resp = synth.complete(request).await?;
    println!("Output: {:?}", resp.output);
    Ok(())
}

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synth_ai-0.9.0.tar.gz (761.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

synth_ai-0.9.0-cp311-cp311-macosx_11_0_arm64.whl (10.6 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

File details

Details for the file synth_ai-0.9.0.tar.gz.

File metadata

  • Download URL: synth_ai-0.9.0.tar.gz
  • Upload date:
  • Size: 761.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for synth_ai-0.9.0.tar.gz
Algorithm Hash digest
SHA256 11c22b8d4c695a851268f89abdf4573286e0af3778fa97445225c1017a21cc0d
MD5 518394128c0ae82265fa6a929c4a593f
BLAKE2b-256 b7693601c3f84cd790dd3f38e20d12e170bd1c49cb76bc1c4deedd9dfa00f4af

See more details on using hashes here.

File details

Details for the file synth_ai-0.9.0-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for synth_ai-0.9.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0540b938430d58932148f76649c95bfaf9ffa546935f55a5746efaabbf457065
MD5 4bbc07320ff1ab6d53b660290c1a6aad
BLAKE2b-256 86557148b0cd59cfdd41914367089d82124660549ca53e2511024721c663a2e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page