Reference

YAML schema

Experiments are authored as YAML and validated before apply.

Experiment YAML is loaded by packages/cli/src/yaml-loader.ts and validated against the domain schema.

Minimal shape:

id: homepage-cta
name: Homepage CTA
state: draft
audience:
  sampleRate: 1
variants:
  - key: control
    name: Current CTA
    weight: 50
  - key: treatment
    name: New CTA
    weight: 50
metrics:
  primary: signup

Run validation before applying:

fx validate experiments/

API reference

The API protocol package is the source of truth for hosted API routes and schemas.

Environment variables

Important environment variables for API, Studio, CLI, workers, and live smokes.