Reference

SDK reference model

Generated SDK namespaces, method semantics, retries, idempotency, pagination, realtime, errors, versioning, and language parity.

SDKSDK method referenceEvery client method across TypeScript, Python, C#, Go, and Rust with inputs, returns, and errors.RESTREST controller atlasEvery controller-backed endpoint with parameters, request examples, responses, errors, and samples.RESTREST API modelBase URLs, resource conventions, pagination, idempotency, error envelopes, OpenAPI discovery, and examples.CLICLI command referenceEvery command group, subcommand, flag, sample output, and exit code for automation and CI.ErrorsErrors referenceCanonical error envelopes, HTTP status mapping, machine-readable codes, reason codes, and correlation IDs.

The searchable method list is in the SDK reference. This page documents what every official SDK must implement in the final complete platform: identical operation semantics across languages, syntax adapted per language.

Final SDK namespaces

Namespace	Surface
`client`	Initialization, auth material, retry policy, telemetry hooks, branch/project scoping.
`entities.<Entity>`	list, read, create, update, upsert, delete, count, exists, alternate-key, batch, subscribe.
`schema`	metadata, preview, diff, validate, snapshots, migrations, journals, transitions.
`branching`	branches, commits, workspaces, sandboxes, proposals, environments, deploy, rollback.
`authoredRuntime`	validate, previewBuild, publish, invoke, runtime units, workflows, execution sessions.
`connections`	governed connection CRUD, operation invocation, diagnostics, secrets, egress.
`storage`	upload, download, stream, exists, delete, list, presign, copy, move, metadata.
`events`	emit, list, get, tail, replay, consumer offsets, ordered stream helpers.
`webhooks`	endpoint and receiver management, delivery replay, signature helpers, diagnostics.
`realtime`	entity and channel subscriptions over WebSocket or SSE.
`analytics`	catalog, query validate/explain/execute, models, metrics, reports, dashboards, materializations.
`automation`	compile, definitions, runs, approvals, attempts, signals, compensation.
`agents`	definitions, runs, plans, memory, skills, model bindings, token accounting, MCP exposure.
`mcp`	token issuance, exposure descriptors, tool invocation, resources, prompts.
`surfaces`	publish, validate, describe, install, upgrade, grant, consume, invoke, explain, suspend, resume, revoke project capability surfaces.
`observability`	audit, operational, debug, metrics, traces, diagnostics, reason-code correlation.
`explainability`	access, read-plan, surface, publication, analytics, automation, PCG, measure explanations.
`platform`	provider health/capabilities, runtime fabric scaling, distribution, version governance, data portability.

Client setup

create-client.example

import { createClient } from "@vadyl/sdk";

const vadyl = createClient({
  apiUrl: "https://api.vadyl.app/v1",
  token: process.env.VADYL_TOKEN!,
  tenant: "acme",
  project: "billing",
  branch: "main",
});

Universal method contract

Concern	Behavior
Pagination	Every list returns `Page<T>` with cursor support and optional total count.
Errors	SDK exceptions wrap the canonical error envelope and preserve `code`, `reasonCode`, and `correlationId`.
Retries	SDKs retry only safe/idempotent operations by default. Writes need explicit idempotency keys.
Telemetry	Hooks attach correlation IDs, request IDs, operation names, and publication versions.
Versioning	SDK manifests declare platform compatibility windows and generated format versions.
Realtime	Subscriptions are reconnect-safe and expose async iterables/streams idiomatic to the language.

Request and output example

list-output.example

const page = await vadyl.orders.list({
  filter: { status: { eq: "paid" } },
  pageSize: 2,
});
console.log(page.data, page.page.next);

CLI reference model

Errors