Reference

This reference hub includes detailed documentation for Soda’s key interfaces and configuration options, as well as information on Soda's architecture and specifics, including:

• Data Contract Language Reference – Author, validate, and manage data contracts using YAML-based definitions.
• CLI Command and Python Reference – Use Soda’s command-line interface to configure, run, and automate verification workflows.
• REST API Reference – Interact with Soda Cloud programmatically to manage datasets, run verifications, and retrieve results.
• Data flow and data source reference – Understand how Soda interacts with other systems and manage exceptions.

Each section includes practical, example-based documentation structured to help data engineers, analysts, and platform teams apply Soda in real-world use cases.

Nomenclature change: "Agent" is now "Runner"

The Soda Agent has been renamed to Soda Runner across all Soda products and interfaces. This change affects terminology throughout the platform, including:

• Soda Cloud UI labels
• API permission names: MANAGE_DATASOURCES_AND_AGENTS → MANAGE_DATASOURCES_AND_RUNNERS
• CLI flags: --use-agent → --use-runner
• Python API methods: verify_contract_on_agent → verify_contract_on_runner

The underlying functionality is unchanged, and both runner/agent nomenclatures are backward compatible at present. If you are following older documentation or have existing scripts and automation that reference "agent", we recommend to gradually replace every occurrence of "agent" / "Agent" with "runner" / "Runner".

---

You are not logged in to Soda and are viewing the default public documentation. Learn more about Documentation access & licensing.

If you do have a Soda license, make sure to log in to Soda Cloud in this same browser.