Docs

Concepts

switchYards is a dashboard plus a host. The dashboard authors the prompt. The host calls a generated method.

Dashboard and host

Product managers write prompts and a closed output schema. Developers save provider keys in the vault. Both read executions. The host application uses generated Go, TypeScript, Python, or Java and never talks to the provider directly.

Slug

A prompt has a stable slug such as triage_ticket. The slug stays the same when the contract changes. Generated methods are namespaced by project: client.support.triageTicket in TypeScript.

Two keys

The vault holds the provider key. The host holds SWITCHYARDS_SECRET_KEY_ plus the project slug in uppercase. Copy that project key from Project settings. Provider keys never leave the vault.

Gateway

Generated clients post slug, schema hash, and inputs to POST /v1/execute. The gateway defaults to https://api.switchyards.dev. SWITCHYARDS_API_URL overrides it. One attempt, then an error. No retry loop.