Reference

Full surface atlas

The exhaustive map of Vadyl's final public and operator surface: protocols, UCSA kinds, projection facets, execution surfaces, and controller endpoints.

Vadyl exposes one canonical backend plane through many caller shapes. The REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, realtime, webhook, event, and authored-runtime surfaces are projections of the same contract graph. This atlas is the broad map: it includes the current code-backed controllers and the final-form protocol/documentation surface the product commits to.

Coverage snapshot

Area	Count	Authority
Capability surface kinds	37	`CapabilitySurfaceKind`
Capability families	7	`CapabilitySurfaceFamily`
Contract projection facets	26	`ContractProjectionFacet`
Execution surfaces	7	`ExecutionSurfaceKind`
Project runtime topology surfaces	10	`ProjectExecutionSurfaceKind`
Exposure protocols	11	`ExposureProtocolKind`
Exposure shapes	20	`ExposureShapeKind`
API operation kinds	34	`ApiOperationKind`
API resource kinds	20	`ApiResourceKind`
Capability host imports	19	`CapabilityHostImportKind`
Final SDK namespaces	18	Generated SDK contract backbone
Coding environment surfaces	8	Workspace + runtime authoring contract
Controller surfaces	81	`Vadyl/Controllers`
Controller endpoints in this atlas	640	Route attributes plus canonical route templates

Protocol matrix

Each protocol exists for a reason, but none of them invents separate authority. A canonical operation fans out through exposure bindings into route names, operation IDs, SDK methods, CLI commands, MCP tools, and dashboard actions.

REST

Resource-shaped JSON routes compiled from entity, platform, and operation contracts.

Endpoint	`https://api.vadyl.app/v1 or /api`
Auth	Authorization: Bearer <token>, plus X-Vadyl-Tenant and X-Vadyl-Project for project-scoped calls.
Discovery	`GET /api/openapi.json` `GET /api/ContractProjection/descriptor` `GET /api/Introspection/surface`

rest.example

curl -X POST https://api.vadyl.app/v1/orders \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  -H "X-Vadyl-Tenant: acme" \
  -H "X-Vadyl-Project: billing" \
  -H "Idempotency-Key: order:cart_123" \
  -H "Content-Type: application/json" \
  -d '{ "customerId": "cus_123", "total": "29.99", "currency": "USD" }'

OpenAPI / Swagger

OpenAPI 3.1 projection of every REST operation, schema, auth scheme, response set, and error envelope.

Endpoint	`GET /api/openapi.json and GET /api/openapi.yaml`
Auth	Same as REST for operations; spec documents public and authenticated operations with security requirements.
Discovery	`GET /api/openapi.json` `GET /api/openapi.yaml` `GET /api/ContractProjection/descriptor`

openapi.example

curl https://api.vadyl.app/v1/openapi.json \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  -H "X-Vadyl-Tenant: acme" \
  -H "X-Vadyl-Project: billing"

GraphQL

Compiled SDL, query parser, executor, mutations, and subscriptions aligned with REST and SDK operations.

Endpoint	`POST /graphql and GET /graphql/schema`
Auth	Bearer metadata/header plus project scope headers.
Discovery	`GET /graphql/schema` `POST /graphql with introspection query`

graphql.example

query RecentOrders($first: Int!) {
  orders(first: $first, filter: { status: { eq: PAID } }) {
    edges { node { id total status } cursor }
    pageInfo { hasNextPage endCursor }
  }
}

gRPC

Proto projection and request handler for unary and streaming canonical operations.

Endpoint	`grpc://api.vadyl.app:443`
Auth	authorization, x-vadyl-tenant, x-vadyl-project metadata.
Discovery	`GET /grpc/proto/vadyl-app.proto` `server reflection`

grpc.example

grpcurl -H "authorization: Bearer $VADYL_TOKEN" \
  -H "x-vadyl-tenant: acme" \
  -H "x-vadyl-project: billing" \
  -d '{ "pageSize": 25 }' \
  api.vadyl.app:443 vadyl.app.v1.OrderService/List

Realtime

WebSocket and SSE subscriptions over canonical change events. Events carry field names only.

Endpoint	`GET /api/realtime and GET /api/realtime/sse`
Auth	Bearer token in header, WebSocket protocol metadata, or signed short-lived subscription token.
Discovery	`GET /api/realtime/sse?entity=Order` `GraphQL subscription transport`

realtime.example

wscat -c "wss://api.vadyl.app/v1/realtime" \
  -H "Authorization: Bearer $VADYL_TOKEN"
> {"type":"subscribe","entity":"Order","filter":{"status":{"eq":"paid"}}}

Webhooks

Outbound signed deliveries plus inbound signed receivers, receipts, retry, replay, rotation, and diagnostics.

Endpoint	`POST /api/webhooks/inbound/{publicReceiverKey}; outbound deliveries to your URL`
Auth	Outbound uses HMAC signature headers. Management uses bearer auth. Inbound verifies before parsing.
Discovery	`GET /api/webhooks/endpoints` `GET /api/webhooks/receivers` `GET /api/webhooks/diagnostics`

webhooks.example

POST /webhooks/vadyl HTTP/1.1
Vadyl-Signature: t=1778157600,v1=4e7...
Vadyl-Event-Id: evt_123

{ "type": "order.paid", "data": { "orderId": "ord_123" } }

Events

Event exposure bindings for canonical event producers and consumers. Entity mutation events flow through the outbox, not through private publish paths.

Endpoint	`Event producers/consumers through the canonical outbox and event router`
Auth	Producer and consumer permissions use project grants and execution-surface capability checks.
Discovery	`GET /api/Event` `GET /api/Event/Diagnostics` `GET /api/ContractProjection/descriptor`

events.example

curl https://api.vadyl.app/v1/events \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  -H "X-Vadyl-Tenant: acme" \
  -H "X-Vadyl-Project: billing"

MCP

Model Context Protocol JSON-RPC transport. Tools dispatch through IApiOperationDispatcher.

Endpoint	`POST /mcp/{tenantSlug}/{projectSlug}`
Auth	Bearer token bound to MCP exposure and project grants.
Discovery	`GET /mcp/{tenantSlug}/{projectSlug}/.well-known/oauth-protected-resource` `JSON-RPC tools/list`

mcp.example

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": { "name": "Order.list", "arguments": { "filter": { "status": { "eq": "paid" } } } }
}

SDKs

Typed language clients generated from the same exposure binding and contract projection facets.

Endpoint	`Generated packages for TypeScript, Python, C#, Go, Rust, plus final-form Java, Kotlin, Swift, Ruby, PHP`
Auth	Client options carry token, tenant, project, branch, telemetry, and transport hooks.
Discovery	`GET /api/Sdk/languages` `POST /api/Sdk/generate` `GET /api/Sdk/versioning`

sdk.example

const vadyl = createClient({ token, tenant: "acme", project: "billing" });
const order = await vadyl.orders.read("ord_123", { include: ["customer"] });

CLI

Descriptor-driven CLI. Bootstrap commands ship locally; all platform commands come from the Cli facet.

Endpoint	`vadyl <group> <command>`
Auth	Global options or environment variables: VADYL_API_BASE_URL, VADYL_API_KEY, VADYL_API_SECRET, VADYL_TENANT_ID, VADYL_PROJECT_ID.
Discovery	`GET /api/ContractProjection/cli` `vadyl --help` `vadyl introspection surface`

cli.example

vadyl schema preview --target production --output json

Dashboard

Dashboard actions are protocol bindings over the same canonical operations. The dashboard has no private mutation authority.

Endpoint	`Generated dashboard actions and admin routes`
Auth	Bearer/session auth plus grants, policy envelope, and dashboard action exposure binding.
Discovery	`GET /api/ContractProjection/descriptor` `GET /api/Introspection/surface` `GET /api/Platform/admin-surface`

dashboard.example

POST /api/Schema/entities/preview HTTP/1.1
Authorization: Bearer ...
X-Vadyl-Tenant: acme
X-Vadyl-Project: billing
Content-Type: application/json

{ "entityName": "Order", "fields": [{ "name": "refundedAt", "type": "Instant", "nullable": true }] }

Unified Capability Surface Architecture

The UCSA taxonomy is closed at the platform level. Projects author implementations and bindings; they do not invent new surface kinds. Every kind maps to exactly one family, one descriptor vocabulary, one router path, and one conformance story.

Substrate (1-9)

Foundational provider-facing substrates for data, runtime, delivery, storage, cache, models, and secrets. Provider SDKs stay behind the capability boundary while project intent declares scale, resources, ingress, and routing canonically.

Ordinal	Kind	Description
`1`	`GovernedConnectionAdapter`	Typed external integration adapter; returns host-validated egress plans.
`2`	`DatabaseInfrastructure`	Database access descriptor surface for SQL, document, KV, graph, wide-column, time-series, and vector workloads.
`3`	`RuntimeSubstrate`	Realizes workloads, manual horizontal scale, autoscale, load-balanced ingress, per-surface partitions, vertical resources, and runtime measures onto ECS, Kubernetes, Cloud Run, Nomad, Fly.io, edge, or local substrate bindings.
`4`	`Distribution`	CDN and delivery substrate for CloudFront, Cloudflare, Front Door, Fastly, custom adapters, and runtime-origin routing to load-balanced project services.
`5`	`AnalyticsSubstrate`	Executes canonical analytics queries and materializations.
`6`	`StorageInfrastructure`	Blob/object/asset storage substrate with signed URL and multipart support.
`7`	`CacheInfrastructure`	Foundational cache descriptor for local, distributed, and provider-backed cache layers.
`8`	`ModelInferenceAdapter`	LLM/model inference adapter surface for OpenAI, Anthropic, DeepSeek, Moonshot, self-hosted, and future providers.
`9`	`SecretProviderSurface`	KMS/vault/external secret provider with strict host-import redaction.

Projection (20-29)

External projections of the canonical contract graph: wire protocols, SDKs, CLI, MCP, and UI.

Ordinal	Kind	Description
`20`	`WireSurface`	REST, OpenAPI, GraphQL, and gRPC wire family.
`21`	`OperationProjectionSurface`	Canonical operations projected into every caller surface.
`22`	`SdkSurface`	Generated client SDK surface.
`23`	`CommandSurface`	Generated and project-published CLI command surface.
`24`	`ToolSurface`	MCP tool/resource/prompt projection.
`25`	`UiProjectionSurface`	Dashboard and admin projection; no private mutation authority.

Operational (40-59)

Runtime traffic planes and durable operational records.

Ordinal	Kind	Description
`40`	`EventVocabularySurface`	Canonical project-published event vocabulary.
`41`	`SubscriptionSurface`	Typed subscription filter surface for realtime, webhooks, GraphQL subscriptions, and automation.
`42`	`WebhookSurface`	Inbound and outbound webhook endpoints, deliveries, receipts, and diagnostics.
`43`	`RealtimeSurface`	WebSocket and SSE channel surface.
`44`	`SchedulingHandlerSurface`	Task definitions, triggers, runs, attempts, and publication pinning.
`45`	`TriggerSurface`	Typed entity/schema/operational trigger definitions and audit.
`46`	`WorkflowSurface`	Durable workflow start, signal, query, compensation, and replay contracts.
`47`	`AutomationActionSurface`	Declarative automation action surface compiled above existing execution surfaces.
`48`	`AgentSkillSurface`	Agent skill declarations and derived tool exposure.
`49`	`EmailTransportSurface`	Email provider transport projection.
`50`	`SmsTransportSurface`	SMS provider transport projection.
`51`	`DistributionPublicationSurface`	Project-published distribution-backed resources.

Knowledge (60-79)

Project-publishable knowledge planes.

Ordinal	Kind	Description
`60`	`SourceAssetSurface`	Folders, files, modules, blobs, scopes, and build-input lineage.
`61`	`AnalyticsSurface`	Models, metrics, perspectives, reports, dashboards, materializations, lineage.

Governance (80-99)

Authority planes that shape every other decision.

Ordinal	Kind	Description
`80`	`IdentityProviderSurface`	Identity, federation, sessions, MFA challenges, actor materialization.
`81`	`AuthSchemeSurface`	Bearer, session, API-key, service profile, and auth scheme declarations.
`82`	`BillingMeterSurface`	Usage events, rollups, quota checks, reservations, and settlements.
`83`	`GovernancePolicySurface`	Policy definitions, inheritance, grants, envelopes, and fail-closed merge.

Execution (100-119)

Authored runtime and sandbox execution envelopes.

Ordinal	Kind	Description
`100`	`AuthoredRuntimeSurface`	Publication envelope for core handlers, workflows, consumers, jobs, webhooks, edge, and management handlers.
`101`	`SandboxSurface`	Isolated execution and real-resource test surface with checkpoints, forks, and budgets.

Cross-cutting (120-139)

Derived planes every other family contributes to and consumes.

Ordinal	Kind	Description
`120`	`ObservabilitySurface`	Audit trails, operational trails, debug traces, metrics, and OpenTelemetry spans.
`121`	`ExplainabilitySurface`	Reason-code explainers projected from canonical authorities only.

Contract projection facets

The contract projection graph is the source of every downstream developer surface. Unsupported language/provider projections fail closed rather than silently dropping facets.

Facet	What it projects
`0. Entities`	Fields, relations, keys, indexes, access masks, value generation, owned/component/value-object shape.
`1. EntityFunctions`	Entity-scoped functions, lifecycle hooks, overrides.
`2. Operations`	Canonical operations with typed input/output schemas.
`3. Handlers`	Authored handlers across all seven execution surfaces.
`4. Edge`	Constrained edge handler projection.
`5. Workflows`	Durable workflows, signals, steps, compensation contracts, inputs, outputs.
`6. Events`	Canonical event vocabulary, event consumers, schedules.
`7. Webhooks`	Inbound and outbound webhooks with payload contracts, signing, delivery.
`8. Connections`	Governed connection operations, auth, egress, retry, idempotency, redaction.
`9. Storage`	Buckets, assets, objects, upload/download/presign/copy/move operations.
`10. Branches`	Branches, branch protection, deployment intents.
`11. Workspaces`	Mutable overlays and staged changes.
`12. Sandboxes`	Isolation, checkpoints, undo/redo, fork ancestry.
`13. SourceAssets`	Folders, files, modules, blobs, scope shape.
`14. RuntimeUnits`	Handler/workflow/consumer/job modules and publication lineage.
`15. Publications`	Versioned snapshots of compiled project state.
`16. Observability`	Operational trails, audit logs, debug traces, OTel spans.
`17. Explainability`	Access, read-plan, surface, publication, project-runtime explainers.
`18. Installations`	Installed surfaces from publisher projects.
`19. Analytics`	UMG subjects, dimensions, measures, metrics, perspectives, reports, dashboards, materializations, lineage.
`20. PlaneCapabilityGraph`	Typed resources, actions, triggers, measures, effects, policies, transforms, and edges.
`21. Automations`	Definition AST, triggers, flow, policies, grants, approvals, compensation, transforms.
`22. Measures`	Semantic kind, unit, instrument, aggregation, freshness, grants, redaction.
`23. Agents`	Agent definitions, skills, runs, plans, memory, model bindings, MCP exposure controls.
`24. Cli`	Generated command descriptor facet consumed by Vadyl.Cli.
`25. ExposureBindings`	Canonical protocol bindings for REST, OpenAPI, GraphQL, gRPC, SDK, CLI, MCP, dashboard, events, realtime, webhooks.

Execution surfaces

User-authored logic runs on exactly seven surfaces. Automation and agents orchestrate across them; they do not add an eighth runtime surface.

Surface	Authority
`CoreHandler`	Synchronous authored logic with host-owned transaction participation.
`DurableWorkflow`	Journaled workflow with worker-executed steps, signals, compensation, and replay.
`EventConsumer`	Publication-aware event consumer with outbox-backed delivery and at-least-once semantics.
`ScheduledJob`	Cron, interval, or one-shot scheduled job body under scheduler kernel authority.
`WebhookHandler`	Handler invoked after signature verification, idempotency receipt, and receiver policy checks.
`EdgeHandler`	Reduced-authority low-latency stateless handler with build-time and runtime import gates.
`ManagementHandler`	Privileged authored surface for schema, branching, publication, and platform mutation authority.

Runtime fabric surfaces

Authored code uses the seven execution surfaces above. Runtime fabric topology has a wider project/runtime vocabulary for ingress, realtime gateways, operator workloads, scale targets, named groups, vertical resource policy, load-balanced runtime origins, autoscale decisions, and substrate realization.

Project execution surface kinds

Kind	Description
`Unspecified`	Fail-closed default. Never silently resolves or applies.
`ApiIngress`	Project HTTP API ingress surface; commonly load-balanced and scaled on request pressure.
`CoreHandler`	Authored core handlers in the project runtime topology; can scale independently from consumers and jobs.
`DurableWorkflow`	Authored durable workflows in the project runtime topology; pinned to publication and governed by workflow runtime policy.
`EventConsumer`	Authored event consumers; commonly autoscaled on queue depth, consumer lag, or custom PCG measures.
`ScheduledJob`	Authored scheduled jobs served by platform scheduling operators; often fixed or tightly capped.
`WebhookHandler`	Authored inbound webhook handlers; can be separately exposed, load balanced, and autoscaled.
`EdgeHandler`	Constrained authored edge handlers with edge-resource policy and distribution-origin integration.
`ManagementHandler`	Privileged authored management handlers; usually fixed, private, and heavily governed.
`RealtimeGateway`	Project realtime WebSocket/SSE subscription gateway; scales on connection and fanout pressure.

Runtime substrate kinds

Kind	Description
`Unspecified`	Fail-closed default. Permitted only before topology resolution.
`HostManaged`	In-process on the main Vadyl host.
`FixedInstance`	Pinned VM or dedicated instance.
`AutoscaledInstanceGroup`	Scaling group of substrate-managed VMs with declared autoscale metrics and instance ceilings.
`ServerlessContainer`	Scale-to-zero request-driven or queue-driven container with concurrency and resource-class policy.
`DedicatedContainer`	Long-lived dedicated container realization with manual or native autoscale policy.
`ClusteredRuntime`	Orchestrated cluster substrate. Kubernetes is one realization, not a canonical type.
`EdgeSubstrate`	Edge point-of-presence runtime substrate with edge CPU-time and memory budgets.

Scaling and resource vocabulary

Runtime scaling remains under RuntimeSubstrate. These records describe project intent; connectors translate them into ECS, Kubernetes, Cloud Run, Fly.io, Nomad, edge, or local substrate shapes.

Scaling modes

Mode	Description
`Fixed`	Keep a fixed desired instance count; no manual mutation or autoscaler changes it.
`Manual`	Operators or automation set desired count inside canonical min/max and governance ceilings.
`Autoscale`	Desired count is driven by native or Vadyl-managed autoscale rules.

Scale partition modes

Mode	Description
`SharedPool`	All surfaces share one workload pool.
`PerSurface`	Each project execution surface realizes independently.
`NamedGroup`	Surfaces with the same scale group name share desired count and autoscale policy.

Autoscale strategies

Strategy	Description
`TargetTracking`	Keep a metric near a target value.
`StepScaling`	Apply explicit capacity changes when thresholds are crossed.
`Scheduled`	Apply planned min, max, or desired counts during time windows.
`Predictive`	Use a substrate or Vadyl model to forecast capacity before demand arrives.
`QueueDriven`	Scale from queue depth, consumer lag, or backlog age.

Autoscale metrics

Metric	Description
`SaturationPercent`	Running capacity divided by desired capacity.
`CpuUtilizationPercent`	CPU utilization from substrate telemetry.
`MemoryUtilizationPercent`	Memory utilization from substrate telemetry.
`RequestsPerSecondPerInstance`	Request rate normalized per running instance.
`InFlightRequestsPerInstance`	Concurrent request pressure per instance.
`LatencyP95Ms / LatencyP99Ms`	Tail latency measured at runtime or ingress.
`QueueDepth / ConsumerLagSeconds`	Backlog pressure for event and queue consumers.
`AcceleratorUtilizationPercent`	GPU, inference accelerator, or specialized device utilization.
`CustomPcgMeasure`	A PCG measure with compatible semantics, dimensions, freshness, grants, and a live sample source.

Resource classes

Class	Description
`Burstable`	Cost-efficient baseline with burst capacity.
`Standard`	General-purpose runtime class.
`ComputeOptimized`	CPU-heavy workloads.
`MemoryOptimized`	Memory-heavy workloads.
`AcceleratedTraining / AcceleratedInference`	GPU, neural accelerator, FPGA, or specialized inference class.
`EdgeIsolate`	Constrained edge runtime budget with CPU-time and isolate memory ceilings.
`ServerlessFunction`	Function-style runtime with request, concurrency, and wall-clock constraints.

Load-balancing modes

Mode	Description
`None`	No managed load balancer requested.
`ManagedPublic`	Public load-balanced service endpoint.
`ManagedPrivate`	Private load-balanced service endpoint for internal traffic.
`MeshOnly`	Service-mesh or internal routing fabric only.

Platform operators

Operator	Role
`Unspecified`	Fail-closed default.
`EventOutboxProcessor`	Drains transactional outbox rows into the platform event log.
`EventRouter`	Routes canonical events to registered consumers with at-least-once delivery.
`WebhookDeliveryDispatcher`	Dispatches pending outbound webhook deliveries.
`InboundWebhookReconciler`	Reconciles inbound webhook receipts against the canonical event log.
`ScheduledJobScanner`	Scans triggers and materializes due scheduled runs.
`ScheduledJobDispatcher`	Claims and dispatches scheduled runs.
`ScheduledJobWorker`	Executes scheduled handler work.
`RealtimeSubscriptionFanout`	Fans out entity change events to realtime subscribers.
`CacheInvalidationPump`	Propagates cross-instance cache invalidations.
`ObservabilityDrainAudit`	Append-only audit-log drain.
`ObservabilityDrainDebug`	Best-effort debug trace drain.
`ObservabilityDrainOperational`	Backpressure-aware operational trail drain.
`BillingDrainMetering`	Usage metering drain.
`BillingDrainRollup`	Usage rollup aggregator.
`ProvisioningRecoverer`	Recovers stuck project provisioning runs.
`SchemaTransitionRecoverer`	Recovers stuck schema transition runs.
`EvolutionRecoverer`	Recovers stuck graph evolution runs.
`WorkflowRecoverer`	Recovers stale durable workflow instances.
`RuntimeFabricRecoverer`	Recovers stale runtime-fabric deployment intents.
`DatabaseSourceJobDispatcher`	Dispatches external-database-source jobs.
`StagingTtlSweeper`	Sweeps expired external database source staging rows.
`GracefulShutdownCoordinator`	Coordinates graceful shutdown across host background services.
`AuthoredWorkerPool`	Platform-owned pool that executes authored runtime code.

API vocabulary

The API vocabulary below is the protocol-neutral model used before anything becomes REST routes, GraphQL fields, gRPC methods, SDK calls, CLI commands, or MCP tools.

Transports

Transport	Description
`Rest`	HTTP JSON/resource transport.
`WebSocket`	WebSocket realtime transport.
`Sse`	Server-sent event realtime transport.
`Internal`	Internal dispatcher/background transport.

Body kinds

Kind	Description
`None`	No request body.
`Json`	JSON request body.
`MultipartForm`	Multipart form upload body.
`OctetStream`	Binary octet-stream body.
`Stream`	Streaming body.

Resource kinds

Kind	Description
`Entity`	Dynamic entity CRUD/query resources.
`Storage`	Blob/object/source asset storage resources.
`Scheduling`	Task definition, run, trigger, and attempt resources.
`Operation`	Canonical operation plan/execute resources.
`ControlPlane`	Tenant, organization, project, and platform control-plane resources.
`Schema`	Schema, migration, snapshot, transition, validation resources.
`Realtime`	Realtime subscription resources.
`Auth`	Authentication resources.
`Branching`	Branch, workspace, sandbox, proposal, environment resources.
`Connector`	Connector contracts, implementations, bindings, invocation resources.
`Identity`	Identity provider, subject, membership, policy resources.
`Email`	Email transport resources.
`Sms`	SMS transport resources.
`Webhook`	Webhook endpoint, receiver, delivery, receipt resources.
`AuthoredHandler`	Authored handler invocation resources.
`Analytics`	Analytics catalog, query, model, metric, report, dashboard, materialization resources.
`PlaneCapabilityGraph`	PCG descriptor and node resources.
`Automation`	Automation definition, run, approval, attempt, signal resources.
`Measure`	Measure descriptor and query resources.
`Agent`	Agent, run, plan, memory, model binding, skill, knowledge corpus, MCP resources.

Operation kinds

Kind	Description
`Create`	Create one resource.
`Read`	Read one resource by id.
`Update`	Update one resource.
`Delete`	Delete one resource.
`Upsert`	Create or update by identity.
`ReadByAlternateKey`	Read one resource by named alternate key.
`List`	List resources.
`Query`	Execute typed query/filter AST.
`Count`	Count matching resources.
`Exists`	Check existence.
`BatchCreate`	Create multiple resources.
`BatchUpdate`	Update multiple resources.
`BatchDelete`	Delete multiple resources.
`Upload`	Upload binary or source content.
`Download`	Download binary or source content.
`Stream`	Stream binary or event content.
`PresignDownloadUrl`	Create a signed download URL.
`PresignUploadUrl`	Create a signed upload URL.
`Copy`	Copy storage/source content.
`Move`	Move storage/source content.
`Trigger`	Trigger a task/workflow/action.
`Pause`	Pause a task, workflow, or surface.
`Resume`	Resume a paused task, workflow, or surface.
`Cancel`	Cancel a run or operation.
`Execute`	Execute a planned operation.
`Plan`	Plan an operation without applying.
`Preview`	Preview a change or migration.
`Diff`	Diff model, branch, environment, or schema state.
`Migrate`	Apply migration/evolution work.
`Snapshot`	Create or read a snapshot.
`Validate`	Validate descriptor, input, schema, or build.
`Subscribe`	Subscribe to realtime or event updates.
`Custom`	Connector or domain-specific operation.
`Invoke`	Invoke an authored handler through the execution coordinator.

Change tracking kinds

Kind	Description
`None`	No change tracking or notification support.
`FieldNamesOnly`	Change events include field names only, never values.
`FullPayload`	Full-payload notification shape for explicitly safe internal or policy-granted surfaces.

Capability host imports

Authored components and custom connectors reach platform services only through this closed import vocabulary. A component cannot invent arbitrary host calls or provider SDK access.

Host import	Description
`MemoryGet`	Read connector/capability memory.
`MemoryGetSnapshot`	Read a memory snapshot.
`MemoryPutIfAbsent`	Write memory only when absent.
`MemoryCompareExchange`	Atomic compare-and-exchange memory update.
`MemoryAppendJournal`	Append to a capability journal.
`MemoryAcquireLease`	Acquire a host-managed lease.
`MemoryReleaseLease`	Release a host-managed lease.
`MemoryDelete`	Delete host memory.
`MemoryExpire`	Set memory expiry.
`ObservabilityRecordSpan`	Record a structured span.
`ObservabilityLog`	Write a redacted observability log entry.
`SecretsSignRequest`	Sign a request without revealing raw secret material.
`SecretsHmac`	Compute HMAC without revealing raw secret material.
`SecretsAttachAuthToEgressPlan`	Attach auth to a host-validated egress plan.
`SecretsResolveRedactedMetadata`	Resolve redacted secret metadata only.
`SecretsDecryptForHostEgressOnly`	Decrypt only inside host egress boundary.
`EgressBuildPlan`	Build a governed egress plan.
`TimeNow`	Read host-provided current time.
`CapabilityAssert`	Assert a required capability grant at the host boundary.

Final SDK namespace atlas

These are the final SDK namespaces every language projection must understand. Language support can vary in syntax, but unsupported facets fail closed with explicit diagnostics.

Namespace	Coverage
`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.

Coding environment atlas

The coding workspace is not a separate product truth. It is a client over source assets, runtime SDK projection, build pipeline, sandbox invocation, connector conformance, and observability.

Surface	Coverage
`Workspace IDE`	Browser-native file tree, Monaco projection, extraLibs from ContractProjection, run/test/deploy actions.
`Source assets`	Folders, files, modules, blobs, content-addressed storage, branchable metadata.
`Runtime SDK`	Language-neutral bridge projected into TypeScript first, then Python, Go, Rust, C#, and future languages.
`Build pipeline`	Language adapter, diagnostics, unit artifact builder, signatures, publication finalization, rollback.
`Local development`	Dev descriptors, local worker, CLI parity, sandbox publish/invoke, contract projection invalidation.
`Custom connectors`	WIT world, Wasm component, host imports, conformance, memory, publication, binding.
`Testing`	Unit tests, live tests, sandbox tests, runtime invocation E2E, contract drift tests.
`Developer observability`	Build logs, invocation traces, bridge errors, source maps, operational trails, explainers.

Exposure binding vocabulary

Exposure bindings are the formal source of truth for every protocol projection. The complete binding contract is expanded in the exposure bindings reference.

Protocols

Protocol	Description
`Rest`	REST over HTTP route exposure.
`OpenApi`	OpenAPI operation emission derived from REST bindings.
`GraphQL`	GraphQL fields, mutations, and subscriptions.
`Grpc`	Generated proto contracts and gRPC method dispatch.
`Sdk`	Typed SDK method exposure.
`Cli`	Descriptor-driven CLI command exposure.
`Mcp`	MCP tools, resources, and prompts.
`Dashboard`	Official dashboard actions projected from canonical bindings.
`Webhook`	Outbound webhook topic delivery.
`Realtime`	WebSocket, SSE, and push subscription channels.
`Event`	Canonical event producers and consumers.

Shapes

Shape	Description
`RestRoute`	HTTP method plus route template.
`OpenApiOperation`	OpenAPI operation entry.
`GraphQLField`	GraphQL Query field.
`GraphQLMutation`	GraphQL Mutation field.
`GraphQLSubscription`	GraphQL Subscription field.
`GrpcMethod`	gRPC method on a generated service.
`SdkMethod`	Typed SDK method.
`CliCommand`	CLI command with arguments/options.
`McpTool`	MCP callable tool.
`McpResource`	MCP readable resource.
`McpPrompt`	MCP prompt template.
`DashboardAction`	Dashboard button, menu entry, or route action.
`WebhookTopic`	Outbound webhook topic.
`RealtimeChannel`	Realtime subscription channel.
`EventProducer`	Surface emits a canonical event.
`EventConsumer`	Surface consumes a canonical event.
`AnalyticsQuery`	Analytics query exposed for evaluation.
`AnalyticsReport`	Analytics report projection.
`AnalyticsDashboard`	Analytics dashboard projection.
`AuthSchemeExposure`	Identity/auth exposure such as login, refresh, federation, challenge.

Stability

State	Meaning
`Experimental`	Explicit opt-in required; no compatibility guarantees.
`Beta`	Broad availability; breaking changes possible with notice.
`Stable`	First-class support with compatibility guarantees.
`Deprecated`	Callable but superseded; requires deprecation policy and replacement.
`Retired`	Descriptor remains for traceability; runtime dispatch fails closed.

Error and limit atlas

Every protocol projects the same canonical error envelope and quota semantics. REST status, GraphQL error extensions, gRPC status details, CLI exit codes, SDK exceptions, and MCP JSON-RPC errors all preserve these meanings.

Errors

Status	Code	Meaning	Retry
`400`	`BAD_REQUEST`	Malformed JSON, invalid enum literal, unknown route binding, or impossible request shape.	Fix request before retrying.
`401`	`UNAUTHORIZED`	Missing, expired, malformed, or unsupported authentication material.	Refresh token or repair credentials.
`403`	`ACCESS_DENIED`	Authenticated actor lacks the required grant, row predicate, field permission, scope, or envelope authority.	Do not retry without a permission or input change.
`404`	`NOT_FOUND`	Resource is absent or hidden by access policy.	Re-read list/search or verify actor scope.
`409`	`CONFLICT`	Optimistic concurrency mismatch, unique-key collision, branch/proposal conflict, dependency conflict, or irreversible effect conflict.	Usually re-read and retry with a new concurrency token.
`412`	`PRECONDITION_FAILED`	If-Match, publication pin, branch head, approval gate, or compatibility precondition failed.	Refresh authority state and retry if still intended.
`422`	`VALIDATION_FAILED`	Entity validation, AST validation, capability validation, policy grammar, schema transition, or typed payload validation failed.	Fix the typed input.
`429`	`QUOTA_EXCEEDED`	Hard quota, rate limit, token budget, runtime budget, or plan reservation exceeded.	Retry after reset only when headers or quota policy allow.
`503`	`UPSTREAM_UNAVAILABLE`	Provider, connector, model, storage, cache, or runtime substrate unavailable.	Retry with backoff when idempotency guarantees exist.
`504`	`UPSTREAM_TIMEOUT`	Connector/runtime/provider call exceeded the platform or declared egress deadline.	Retry only idempotent operations or provide Idempotency-Key.
`gRPC`	`PERMISSION_DENIED`	gRPC projection of ACCESS_DENIED with Vadyl error details.	Same as ACCESS_DENIED.

Limits

Name	Default	Scope	Enforcement
REST request body	`10 MiB JSON; larger payloads use Storage or SourceAsset upload.`	Request	413 or VALIDATION_FAILED before business execution.
Entity list page size	`200 rows by default; final-form enterprise policy may raise by grant.`	Project and route	VALIDATION_FAILED when requested pageSize exceeds policy.
Batch mutation size	`1,000 rows or 10 MiB per operation.`	Entity operation	VALIDATION_FAILED before transaction opens.
Idempotency key retention	`24 hours default; configurable per operation class.`	Project	Duplicate keys return prior result or idempotency conflict.
Webhook retries	`10 attempts with exponential backoff plus jitter.`	Endpoint	Delivery moves to DeadLettered after retry policy exhausts.
Realtime subscriptions	`1,000 per project by default; enterprise scopes use quota grants.`	Project and actor	429 QUOTA_EXCEEDED on handshake or subscribe.
Runtime desired instances	`Per-surface and cumulative project ceilings from governance envelope.`	Project, environment, surface, scale group	Compile or mutation fail-closed when desired/max exceeds policy.
Runtime vertical resources	`CPU, memory, storage, bandwidth, and accelerators capped by project inheritance policy.`	Project, environment, surface	Capability satisfaction and governance checks before realization.
Autoscale decision cadence	`30 seconds default with cooldown, hysteresis, stale-sample, rollout, and drain gates.`	Autoscale target	Decision skipped with typed reason until the gate clears.
Workflow run duration	`30 days default; durable workflow policy can extend.`	Workflow definition	Cancellation and compensation policy fires at deadline.
Edge handler CPU time	`50 ms default CPU slice, 5 s wall-clock ceiling.`	Execution unit	Timed-out invocation with typed BridgeError.
Agent token budget	`Per-agent and per-run budget; preflight plus reconciliation.`	Agent run	Preflight deny or reconciled overage usage event.
Connector egress timeout	`30 seconds default, max set by connection policy.`	Governed connection	UPSTREAM_TIMEOUT with retry classification.
OpenAPI/SDL/proto size	`Publication descriptor size quota.`	Project publication	Publication compile fails closed with descriptor diagnostics.
CLI descriptor cache	`ETag validated on every CLI startup.`	Local CLI installation	304 reuse or descriptor refetch.

Controller endpoint atlas

This table mirrors the route surface in Vadyl/Controllersand the canonical route-template authority. Versioned siblings use/api/v{version}/... where the controller declares a versioned route.

Agent

Start native agent runs.

Base: /api/Agent

Method	Path tail
`POST`	`{agentId}/run`

AgentMemory

Namespaces, facts, recall, journal, and memory writes.

Base: /api/AgentMemory

Method	Path tail
`GET`	`namespaces`
`POST`	`namespaces`
`GET`	`namespaces/{namespaceId}`
`POST`	`apply`
`POST`	`recall`
`GET`	`facts/{factId}`
`GET`	`namespaces/{namespaceId}/journal`

AgentModelBinding

LLM/model bindings for agents.

Base: /api/AgentModelBinding

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`

AgentPlan

Agent plan authoring, validation, preview, approval, execution, cancellation.

Base: /api/AgentPlan

Method	Path tail
`GET`	`/`
`GET`	`{planId}`
`POST`	`/`
`POST`	`{planId}/validate`
`POST`	`{planId}/preview`
`POST`	`{planId}/submit`
`POST`	`{planId}/approve`
`POST`	`{planId}/reject`
`POST`	`{planId}/execute`
`POST`	`{planId}/cancel`

AgentRun

Agent run inspection, step stream, reasoning, human prompt answers.

Base: /api/AgentRun

Method	Path tail
`GET`	`/`
`GET`	`{runId}`
`POST`	`{runId}/cancel`
`GET`	`{runId}/steps`
`GET`	`{runId}/reasoning`
`POST`	`{runId}/human-prompts/{promptId}/answer`

AgentSkill

Agent skill CRUD surface.

Base: /api/AgentSkill

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`

Analytics

Catalog, query, models, metrics, perspectives, reports, dashboards, materializations, lineage.

Base: /api/Analytics

Method	Path tail
`GET`	`catalog`
`GET`	`catalog/subjects/{subjectId}`
`GET`	`catalog/dimensions`
`GET`	`catalog/measures`
`GET`	`catalog/metrics`
`GET`	`catalog/comparisons`
`POST`	`query/validate`
`POST`	`query/explain`
`POST`	`query/execute`
`GET`	`models`
`POST`	`models`
`GET`	`models/{modelId}`
`PUT`	`models/{modelId}`
`DELETE`	`models/{modelId}`
`POST`	`models/{modelId}/publish`
`GET`	`metrics`
`POST`	`metrics`
`GET`	`metrics/{metricId}`
`PUT`	`metrics/{metricId}`
`DELETE`	`metrics/{metricId}`
`GET`	`perspectives`
`POST`	`perspectives`
`GET`	`perspectives/{perspectiveId}`
`PUT`	`perspectives/{perspectiveId}`
`DELETE`	`perspectives/{perspectiveId}`
`GET`	`reports`
`POST`	`reports`
`GET`	`reports/{reportId}`
`PUT`	`reports/{reportId}`
`DELETE`	`reports/{reportId}`
`POST`	`reports/{reportId}/run`
`GET`	`dashboards`
`POST`	`dashboards`
`GET`	`dashboards/{dashboardId}`
`PUT`	`dashboards/{dashboardId}`
`DELETE`	`dashboards/{dashboardId}`
`POST`	`dashboards/{dashboardId}/render`
`GET`	`materializations`
`POST`	`materializations`
`GET`	`materializations/{materializationId}`
`PUT`	`materializations/{materializationId}`
`DELETE`	`materializations/{materializationId}`
`POST`	`materializations/{materializationId}/refresh`
`GET`	`materializations/{materializationId}/runs`
`GET`	`lineage/{subjectId}`

Asset

Asset namespace and blob lookup diagnostics.

Base: /api/Asset

Method	Path tail
`GET`	`namespaces`
`GET`	`namespaces/{purpose}`
`GET`	`summary`
`GET`	`namespaces/{purpose}/blobs/by-hash/{contentHash}`

AuthoredManagement

Invoke management handlers.

Base: /api/AuthoredManagement

Method	Path tail
`POST`	`{handlerName}`

AuthoredRuntime

Validate, preview-build, publish, sandbox publish, and sandbox invoke.

Base: /api/AuthoredRuntime

Method	Path tail
`POST`	`validate`
`POST`	`preview-build`
`POST`	`publish`
`POST`	`sandbox/{sandboxId}/publish`
`POST`	`sandbox/{sandboxId}/invoke`

AuthoredWorkflow

Start, signal, query, cancel, compensate authored workflows.

Base: /api/AuthoredWorkflow

Method	Path tail
`POST`	`{workflowName}/start`
`POST`	`{instanceId}/signal/{signalName}`
`GET`	`{instanceId}`
`POST`	`{instanceId}/cancel`
`POST`	`{instanceId}/compensate`
`POST`	`{instanceId}/compensate/resume`

AuthoringCatalog

Language, runtime, surface, compatibility, projection, diagnostics, and editor providers.

Base: /api/AuthoringCatalog

Method	Path tail
`GET`	`languages`
`GET`	`runtime-families`
`GET`	`surfaces`
`GET`	`compatibility`
`GET`	`declaration-projections`
`GET`	`diagnostics-providers`
`GET`	`editor-assistance-providers`

Automation

Definitions, compiler, runs, approvals, attempts, signals, compensation.

Base: /api/Automation

Method	Path tail
`POST`	`compile`
`POST`	`runs/start`
`GET`	`runs/{runId}`
`GET`	`runs/{runId}/approvals`
`GET`	`runs/{runId}/attempts`
`POST`	`runs/{runId}/cancel`
`POST`	`runs/{runId}/compensate`
`POST`	`runs/{runId}/signal`
`POST`	`approvals/{approvalTaskId}/approve`
`POST`	`approvals/{approvalTaskId}/reject`
`POST`	`attempts/{attemptId}/retry`
`GET`	`definitions`
`GET`	`definitions/{id}`
`POST`	`definitions`
`PUT`	`definitions/{id}`
`POST`	`definitions/{id}/lifecycle`
`DELETE`	`definitions/{id}`
`GET`	`definitions/{id}/synthesized-workflow`

Branch

Branches, commits, workspaces, sandboxes, proposals, environments, history, snapshots, deployment preview.

Base: /api/Branch

Method	Path tail
`GET`	`branches`
`POST`	`branches`
`GET`	`branches/{id}`
`DELETE`	`branches/{id}`
`PATCH`	`branches/{id}/protected`
`PUT`	`branches/{id}/protected`
`GET`	`branches/{id}/log`
`POST`	`branches/{id}/revert`
`POST`	`branches/{id}/reset`
`GET`	`commits/{id}`
`GET`	`commits/{id}/ancestry`
`GET`	`commits/{id}/snapshot`
`GET`	`workspaces`
`POST`	`workspaces`
`GET`	`workspaces/{id}`
`POST`	`workspaces/{id}/stage`
`DELETE`	`workspaces/{id}/stage/{index}`
`GET`	`workspaces/{id}/preview`
`POST`	`workspaces/{id}/commit`
`POST`	`workspaces/{id}/reset`
`DELETE`	`workspaces/{id}`
`POST`	`sandboxes`
`GET`	`sandboxes`
`GET`	`sandboxes/{id}`
`POST`	`sandboxes/{id}/overlay`
`GET`	`sandboxes/{id}/compare`
`GET`	`sandboxes/{id}/preview`
`POST`	`sandboxes/{id}/retry`
`DELETE`	`sandboxes/{id}`
`POST`	`sandboxes/{id}/convert`
`POST`	`sandboxes/{id}/checkpoints`
`GET`	`sandboxes/{id}/checkpoints`
`POST`	`sandboxes/{id}/restore/{checkpointId}`
`POST`	`sandboxes/{id}/undo`
`POST`	`sandboxes/{id}/redo`
`GET`	`sandboxes/{id}/history`
`GET`	`sandboxes/checkpoints/{idA}/diff/{idB}`
`POST`	`sandboxes/{id}/fork`
`GET`	`sandboxes/{id}/compare/{otherId}`
`POST`	`sandboxes/{id}/merge-to-parent`
`POST`	`sandboxes/{id}/propose`
`GET`	`proposals`
`POST`	`proposals`
`GET`	`proposals/{id}`
`POST`	`proposals/{id}/evaluate`
`POST`	`proposals/{id}/approve`
`POST`	`proposals/{id}/merge`
`POST`	`proposals/{id}/resolve-conflicts`
`POST`	`proposals/{id}/close`
`GET`	`environments`
`POST`	`environments`
`GET`	`environments/{id}`
`POST`	`environments/{id}/deploy`
`POST`	`environments/{id}/apply`
`POST`	`environments/{id}/rollback`
`GET`	`environments/{id}/history`
`GET`	`environments/{id}/diff/{commitId}`
`GET`	`history/path`
`GET`	`history/path/cross-branch`
`GET`	`history/domain`
`GET`	`snapshots/{id}`
`GET`	`branches/{sourceId}/compare/{targetId}`
`POST`	`branches/{id}/preview-deploy`
`POST`	`environments/{id}/assess-rollback`

Build

Build trigger and artifact lookup.

Base: /api/Build

Method	Path tail
`POST`	`trigger`
`GET`	`artifact/{artifactId}`

CacheProviderBinding

Cache provider bindings and runtime descriptor.

Base: /api/CacheProviderBinding

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`
`GET`	`runtime`

Connection

Governed connection CRUD and lookup.

Base: /api/Connection

Method	Path tail
`POST`	`/`
`GET`	`/`
`GET`	`{id}`
`GET`	`by-name/{name}`
`PUT`	`{id}`
`DELETE`	`{id}`

Connector

Capability contracts, implementations, bindings, isolation profiles, and invocation.

Base: /api/Connector

Method	Path tail
`GET`	`contracts`
`GET`	`contracts/{kind}/{majorVersion:int}`
`GET`	`implementations`
`GET`	`implementations/{implementationId}`
`POST`	`bindings`
`GET`	`bindings`
`GET`	`bindings/{alias}`
`GET`	`isolation/profiles`
`POST`	`invoke`

ContractProjection

Contract descriptor, language declarations, CLI descriptor, SSE invalidation.

Base: /api/ContractProjection

Method	Path tail
`GET`	`descriptor`
`GET`	`{language}/declarations`
`GET`	`cli`
`GET`	`events`

Credential

Credential list, rotation, revocation, and deletion.

Base: /api/Credential

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`{id}/revoke`
`POST`	`{id}/rotate`
`DELETE`	`{id}`

DatabaseConnector

Database connector binding management, validation, health, drift.

Base: /api/DatabaseConnector

Method	Path tail
`GET`	`/`
`GET`	`{alias}`
`POST`	`/`
`PUT`	`{alias}`
`DELETE`	`{alias}`
`POST`	`{alias}/validate`
`GET`	`{alias}/describe`
`GET`	`{alias}/health`
`GET`	`{alias}/drift`

DatabaseSources

Database source import/probe/discover/infer/preview/apply/reconcile/artifact/import manifest.

Base: /api/database-sources

Method	Path tail
`POST`	`/`
`POST`	`{alias}/retire`
`POST`	`{alias}/probe`
`POST`	`{alias}/discover`
`POST`	`{alias}/infer`
`POST`	`{alias}/decisions`
`POST`	`{alias}/revert`
`POST`	`{alias}/acceptance`
`POST`	`{alias}/preview`
`POST`	`{alias}/apply`
`POST`	`{alias}/reconcile`
`POST`	`{alias}/artifacts`
`POST`	`{alias}/import`
`GET`	`manifest`

DataPortability

Import, export, backup, restore validation, portability verification.

Base: /api/DataPortability

Method	Path tail
`POST`	`import`
`GET`	`export`
`POST`	`schema/backup`
`POST`	`restore/validate`
`POST`	`portability/verify`

Distribution

Distribution bindings, policy, asset policies, realization, delivery, invalidation, replica policies, topology.

Base: /api/Distribution

Method	Path tail
`GET`	`projects/{projectId}/bindings`
`POST`	`projects/{projectId}/bindings`
`DELETE`	`projects/{projectId}/bindings/{bindingId}`
`GET`	`projects/{projectId}/policy`
`PUT`	`projects/{projectId}/policy`
`GET`	`projects/{projectId}/asset-policies`
`PUT`	`projects/{projectId}/asset-policies`
`GET`	`projects/{projectId}/descriptor`
`GET`	`projects/{projectId}/environments/{environmentId}/realization`
`POST`	`projects/{projectId}/environments/{environmentId}/assets/{namespaceId}/{assetClass}/delivery`
`POST`	`projects/{projectId}/environments/{environmentId}/assets/{namespaceId}/{assetClass}/invalidate`
`GET`	`projects/{projectId}/replica-policies`
`GET`	`projects/{projectId}/replica-policies/{entityName}`
`PUT`	`projects/{projectId}/replica-policies/{entityName}`
`DELETE`	`projects/{projectId}/replica-policies/{entityName}`
`GET`	`projects/{projectId}/topology`
`POST`	`projects/{projectId}/replica-policies/{entityName}/preview-route`

Entity

Dynamic entity CRUD/query/count/exists/alternate-key/batch/restore operations.

Base: /api/Entity

Method	Path tail
`POST`	`/`
`POST`	`{entityName}`
`GET`	`{entityName}/{id}`
`POST`	`{entityName}/{id}/restore`
`PUT`	`{entityName}/{id}`
`DELETE`	`{entityName}/{id}`
`PUT`	`{entityName}/upsert`
`POST`	`{entityName}/query`
`POST`	`query`
`GET`	`{entityName}`
`GET`	`{entityName}/count`
`HEAD`	`{entityName}/{id}`
`GET`	`{entityName}/by/{keyGroup}`
`POST`	`{entityName}/batch`
`DELETE`	`{entityName}/batch`
`PUT`	`{entityName}/batch`

Event

Canonical event log and diagnostics.

Base: /api/Event

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`GET`	`Diagnostics`

Evolution

Evolution run state, nodes, barriers, events, status.

Base: /api/Evolution

Method	Path tail
`GET`	`runs/{runId}`
`GET`	`runs/active`
`GET`	`runs/{runId}/nodes`
`GET`	`runs/{runId}/barriers`
`GET`	`runs/{runId}/events`
`GET`	`status`

Explainability

Canonical decision reasoning for API surface, runtime, publication, access, read plan, analytics, PCG, automation, measure, companions, family resolution.

Base: /api/Explainability

Method	Path tail
`GET`	`surface`
`GET`	`project-runtime`
`GET`	`publication/latest`
`GET`	`publication/{publicationVersion:long}`
`POST`	`access/read`
`POST`	`access/write`
`POST`	`read-plan`
`POST`	`analyticsQuery`
`GET`	`analyticsGraph`
`GET`	`planeCapabilityGraph/node/{nodeIdEncoded}`
`POST`	`planeCapabilityGraph/compatibility`
`POST`	`automation`
`GET`	`measure/{nodeIdEncoded}`
`GET`	`companions`
`GET`	`family-resolution`

IdentityEntrypoint

Discovery, login, registration, refresh, logout, federation, challenges.

Base: /api/identity

Method	Path tail
`GET`	`discovery`
`POST`	`login`
`POST`	`register`
`POST`	`refresh`
`POST`	`logout`
`GET`	`federation/{alias}/initiate`
`GET`	`federation/{alias}/callback`
`POST`	`challenge/start`
`POST`	`challenge/verify`

IdentityManagement

Subjects, memberships, policies, deactivation, revocation.

Base: /api/IdentityManagement

Method	Path tail
`GET`	`subjects`
`GET`	`subjects/{id}`
`POST`	`subjects/{id}/deactivate`
`GET`	`memberships`
`POST`	`memberships`
`POST`	`memberships/{id}/revoke`
`GET`	`policies`

Introspection

Versions, compiled surface, breaking change metadata.

Base: /api/Introspection

Method	Path tail
`GET`	`versions`
`GET`	`surface`
`GET`	`breaking-changes`

KnowledgeCorpus

Knowledge corpus CRUD.

Base: /api/KnowledgeCorpus

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`

Maintenance

Operator maintenance primitives.

Base: /api/Maintenance

Method	Path tail
`POST`	`clean-dynamic-state`

Mcp

MCP JSON-RPC and protected-resource metadata.

Base: /mcp/{tenantSlug}/{projectSlug}

Method	Path tail
`POST`	`/`
`GET`	`.well-known/oauth-protected-resource`

Measure

Measure descriptors and queries.

Base: /api/Measure

Method	Path tail
`GET`	`descriptors`
`GET`	`descriptors/{nodeIdEncoded}`
`POST`	`query`

Observability

Audit/operational/debug entries, trails, traces, diagnostics.

Base: /api/Observability

Method	Path tail
`GET`	`Entries`
`GET`	`Entries/{id}`
`GET`	`Trail/{entityName}`
`GET`	`Trails`
`GET`	`Trails/{id}`
`GET`	`Traces`
`GET`	`Traces/{id}`
`GET`	`Diagnostics`

OperationalResource

Ordered stream append/consume/ack/nack/seek/trim primitives.

Base: /api/OperationalResource

Method	Path tail
`POST`	`streams/{providerName}/{streamName}/append`
`POST`	`streams/{providerName}/{streamName}/consume`
`POST`	`streams/{streamName}/groups/{consumerGroup}/ack`
`POST`	`streams/{providerName}/{streamName}/nack`
`POST`	`streams/{streamName}/groups/{consumerGroup}/seek`
`POST`	`streams/{providerName}/{streamName}/trim`

Operation

Plan and execute canonical operations.

Base: /api/Operation

Method	Path tail
`POST`	`Execute`
`POST`	`Plan`

PlaneCapabilityGraph

PCG descriptor and node lookup.

Base: /api/PlaneCapabilityGraph

Method	Path tail
`GET`	`descriptor`
`GET`	`nodes/{kind}`

PlatformDiagnostics

Provider health/capabilities, matrix, status, admin surface, domains.

Base: /api/Platform

Method	Path tail
`GET`	`providers`
`GET`	`providers/{name}/health`
`GET`	`providers/{name}/health/capabilities`
`GET`	`providers/{name}/capabilities`
`GET`	`capabilities-matrix`
`GET`	`status`
`GET`	`admin-surface`
`GET`	`domains`

Projects

Self-service creation, hierarchy traversal, runtime, provider bindings, grants, lifecycle.

Base: /api/projects

Method	Path tail
`POST`	`create`
`GET`	`resolve`
`POST`	`{parentProjectId}/children`
`GET`	`{projectId}/provider-bindings`
`GET`	`{projectId}/runtime`
`POST`	`{projectId}/suspend`
`POST`	`{projectId}/resume`
`POST`	`{projectId}/archive`
`GET`	`{projectId}/children`
`GET`	`{projectId}/descendants`
`GET`	`{projectId}/ancestors`
`GET`	`{projectId}/capability-grants`
`POST`	`{projectId}/capability-grants`
`DELETE`	`{projectId}/capability-grants/{grantId}`

ProjectProviderBinding

Provider binding mutations and invalidation.

Base: /api/projects/{projectId}/provider-bindings

Method	Path tail
`POST`	`/`
`PUT`	`{alias}`
`DELETE`	`{alias}`
`POST`	`{alias}/restore`
`POST`	`invalidate`

Tenant/Organization/Project records

Control-plane record CRUD and template adoption.

Base: /api/{TenantRecord|OrganizationRecord|ProjectRecord}

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`
`GET`	`/api/ProjectRecord/ByOrganization/{organizationId}`
`POST`	`/api/ProjectRecord/{id}/adopt-template`

Publication

Publication list/read/latest.

Base: /api/Publication

Method	Path tail
`GET`	`/`
`GET`	`{pubVersion:long}`
`GET`	`latest`

RuntimeFabric

Project and platform fabric topology, scaling, resources, ingress, realization, health, binding, deployment plan/apply/reconcile/rollback/drain.

Base: /api/RuntimeFabric and /api/PlatformRuntimeFabric

Method	Path tail
`GET`	`{projectId}/fabric`
`GET`	`{projectId}/realization/{projectEnvironmentId}`
`GET`	`{projectId}/health/{projectEnvironmentId}`
`GET`	`{projectId}/topology`
`PUT`	`{projectId}/topology`
`POST`	`{projectId}/scaling/preview`
`GET`	`{projectId}/env/{projectEnvironmentId}/scaling/targets`
`GET`	`{projectId}/env/{projectEnvironmentId}/scaling/origins`
`GET`	`{projectId}/env/{projectEnvironmentId}/scaling/intents`
`POST`	`{projectId}/env/{projectEnvironmentId}/surfaces/{surfaceKind}/scale`
`PUT`	`{projectId}/topology/surfaces/{surfaceKind}/scaling`
`PUT`	`{projectId}/topology/surfaces/{surfaceKind}/resources`
`PUT`	`{projectId}/topology/surfaces/{surfaceKind}/ingress`
`POST`	`{projectId}/env/{projectEnvironmentId}/surfaces/{surfaceKind}/autoscale/suspend`
`POST`	`{projectId}/env/{projectEnvironmentId}/surfaces/{surfaceKind}/autoscale/resume`
`GET`	`{projectId}/env/{projectEnvironmentId}/surfaces/{surfaceKind}/autoscale/explain`
`PUT`	`{projectId}/env/{projectEnvironmentId}/binding`
`PUT`	`installation/{installationId}/env/{consumerEnvironmentId}`
`POST`	`installation/{installationId}/upgrade`
`POST`	`project/{projectId}/env/{projectEnvironmentId}/plan`
`POST`	`{intentId}/apply`
`POST`	`project/{projectId}/env/{projectEnvironmentId}/reconcile`
`POST`	`{intentId}/rollback`
`POST`	`project/{projectId}/env/{projectEnvironmentId}/drain`
`GET`	`fabric`
`GET`	`topology`
`PUT`	`topology`
`GET`	`realization/{platformEnvironmentId}`
`GET`	`health/{platformEnvironmentId}`
`POST`	`environment`
`PUT`	`environment/{platformEnvironmentId}/binding`
`PUT`	`env-assignment/{projectEnvironmentId}`
`POST`	`environment/{platformEnvironmentId}/plan`
`POST`	`environment/{platformEnvironmentId}/reconcile`
`POST`	`environment/{platformEnvironmentId}/drain`

RuntimeUnit

Runtime unit CRUD, validation, capability description, publication lineage.

Base: /api/RuntimeUnit

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`
`POST`	`{id}/validate`
`POST`	`{id}/describe-capabilities`
`GET`	`{id}/publication-lineage`

Schema

Entity schema management, preview, diff, snapshots, migration history, hydrate, metadata, batch, validation, journal, migration apply/rollback.

Base: /api/Schema

Method	Path tail
`POST`	`entities`
`PUT`	`entities`
`POST`	`entities/delete`
`DELETE`	`entities`
`POST`	`entities/preview`
`GET`	`diff`
`POST`	`snapshots`
`GET`	`snapshots/{id}`
`GET`	`migration-history/{entityName}`
`POST`	`hydrate`
`GET`	`access-model/discriminators`
`GET`	`entities/metadata`
`GET`	`entities/metadata/{entityName}`
`POST`	`entities/batch`
`POST`	`entities/delete-batch`
`DELETE`	`entities/batch`
`POST`	`entities/validate`
`GET`	`journal`
`GET`	`journal/{id}`
`POST`	`journal/{id}/recover`
`POST`	`migrate/rollback/{journalId}`
`POST`	`migrate/apply`

SchemaTransition

Schema transition list/read/preview/create/execute/rollback.

Base: /api/SchemaTransition

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`preview`
`POST`	`/`
`POST`	`{id}/execute`
`POST`	`{id}/rollback`

Sdk

SDK generation, language listing, versioning metadata.

Base: /api/Sdk

Method	Path tail
`POST`	`generate`
`GET`	`languages`
`GET`	`versioning`

SourceAsset

Folders, files, blobs, uploads, downloads, tree, scope shape.

Base: /api/SourceAsset

Method	Path tail
`GET`	`folder`
`POST`	`folder`
`PUT`	`folder/{id}/rename`
`DELETE`	`folder/{id}`
`GET`	`file`
`GET`	`file/{id}`
`GET`	`file/by-path`
`POST`	`blob`
`POST`	`file`
`PUT`	`file/{id}/content`
`PUT`	`file/{id}/rename`
`DELETE`	`file/{id}`
`PUT`	`file/{id}/upload`
`GET`	`file/{id}/download`
`GET`	`tree`
`GET`	`scope/shape`

Storage

Upload, download, exists, delete, list, providers, info.

Base: /api/Storage

Method	Path tail
`POST`	`upload`
`GET`	`download/{**storagePath}`
`HEAD`	`exists/{**storagePath}`
`DELETE`	`{**storagePath}`
`GET`	`list`
`GET`	`providers`
`GET`	`info/{**storagePath}`

Surface

Installable surface CRUD/install/uninstall/upgrade/suspend/resume.

Base: /api/Surface

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`GET`	`{id}/is-installed`
`POST`	`/`
`POST`	`{id}/install`
`DELETE`	`{id}/uninstall`
`POST`	`{id}/upgrade`
`POST`	`{id}/suspend`
`POST`	`{id}/resume`

Scheduling

Task definitions, triggers, runs, attempts, pause/resume/cancel/manual trigger.

Base: /api/scheduling/{taskdefinition|taskrun|taskattempt}

Method	Path tail
`GET`	`taskdefinition/`
`GET`	`taskdefinition/{id}`
`PUT`	`taskdefinition/{id}`
`DELETE`	`taskdefinition/{id}`
`POST`	`taskdefinition/{id}/pause`
`POST`	`taskdefinition/{id}/resume`
`POST`	`taskdefinition/`
`GET`	`taskdefinition/{id}/triggers`
`POST`	`taskdefinition/{id}/triggers`
`DELETE`	`taskdefinition/{id}/triggers/{triggerId}`
`GET`	`taskrun/`
`GET`	`taskrun/{id}`
`POST`	`taskrun/{id}/cancel`
`POST`	`taskrun/{definitionId}/trigger`
`GET`	`taskattempt/`
`GET`	`taskattempt/{id}`

TriggerAudit

Trigger audit events, clear, summary, diagnostics.

Base: /api/TriggerAudit

Method	Path tail
`GET`	`Events`
`DELETE`	`Clear`
`GET`	`Summary`
`GET`	`Diagnostics`

Usage

Usage events, rollups, quotas, summary.

Base: /api/Usage

Method	Path tail
`GET`	`{projectId}/events`
`GET`	`{projectId}/rollups`
`GET`	`{projectId}/quotas`
`POST`	`{projectId}/quotas`
`PUT`	`{projectId}/quotas/{quotaId}`
`DELETE`	`{projectId}/quotas/{quotaId}`
`GET`	`{projectId}/summary`

VersionGovernance

Version vectors, project publication, platform baseline, foundation adoption, upgrade plan/approve/execute/rollback/preview, deprecations.

Base: /api/version

Method	Path tail
`GET`	`/`
`GET`	`projects/{projectId}`
`GET`	`projects/{projectId}/publication/{publicationVersion:long}`
`GET`	`platform-baseline`
`GET`	`foundations/{profileName}/{foundationVersion}`
`POST`	`projects/{projectId}/foundation/adopt`
`POST`	`projects/{projectId}/upgrade/plan`
`POST`	`projects/{projectId}/upgrade/plans/{planId}/approve`
`POST`	`projects/{projectId}/upgrade/plans/{planId}/execute`
`POST`	`projects/{projectId}/upgrade/executions/{executionId}/rollback`
`POST`	`projects/{projectId}/upgrade/preview`
`GET`	`deprecations`
`POST`	`deprecations/announce`

Webhook

Outbound endpoints, deliveries, secret rotation, inbound receivers, inbound dispatch, diagnostics.

Base: /api/webhooks and /api/Webhook

Method	Path tail
`GET`	`endpoints`
`GET`	`endpoints/{id}`
`POST`	`endpoints`
`PUT`	`endpoints/{id}`
`DELETE`	`endpoints/{id}`
`POST`	`endpoints/{id}/rotate-secret`
`GET`	`endpoints/{endpointId}/deliveries`
`GET`	`receivers`
`GET`	`receivers/{id}`
`POST`	`receivers`
`PUT`	`receivers/{id}`
`DELETE`	`receivers/{id}`
`POST`	`inbound/{publicReceiverKey}`
`GET`	`diagnostics`

AuthoredRuntimeAdmin

Admin worker controls for the authored runtime pool.

Base: /api/AuthoredRuntime

Method	Path tail
`POST`	`workers/reset`

BindingDiagnostics

Typed binder diagnostics, factory creation checks, and request pipeline inspection.

Base: /api/BindingDiagnostics

Method	Path tail
`POST`	`TestTypedBind`
`GET`	`TestFactoryCreate`
`GET`	`Pipeline`

ConnectorBuild

Declarative connector build surface under the canonical connector route.

Base: /api/Connector

Method	Path tail
`POST`	`build/declarative`

ConnectorConformance

Connector conformance execution surface.

Base: /api/Connector

Method	Path tail
`POST`	`conformance/run`

ConnectorMemory

Connector host memory and state lookup surface.

Base: /api/Connector

Method	Path tail
`GET`	`memory/get`

ConnectorPublication

Connector publication cache, version lookup, implementation lookup, and invalidation.

Base: /api/Connector

Method	Path tail
`GET`	`publication/latest`
`GET`	`publication/version/{publicationVersion:long}`
`GET`	`publication/version/{publicationVersion:long}/{implementationId}`
`POST`	`publication/invalidate`

CredentialReveal

Controlled credential reveal token exchange.

Base: /api/CredentialReveal

Method	Path tail
`POST`	`{tokenId}/reveal`

DescendantGovernance

Inherited governance envelope and descendant inheritance policy management.

Base: /api/projects/{projectId}/governance

Method	Path tail
`GET`	`envelope`
`GET`	`inheritance-policy`
`PUT`	`inheritance-policy`

DevBootstrapDescriptor

Development bootstrap descriptor for local and generated tooling.

Base: /api/DevBootstrapDescriptor

Method	Path tail
`GET`	`descriptor`

DynamicEntityTest

Dynamic entity integration diagnostics for create/delete/update, table and column checks, AST query/mutation, and cleanup.

Base: /api/DynamicEntityTest

Method	Path tail
`POST`	`Create`
`POST`	`Delete`
`DELETE`	`Delete`
`DELETE`	`CleanAllProvider/{entityName}`
`DELETE`	`DropTableProvider/{tableName}`
`GET`	`TableCheckProvider/{pattern}`
`GET`	`TableCheck/{pattern}`
`GET`	`ColumnCheckProvider/{tableName}`
`GET`	`ColumnCheck/{tableName}`
`GET`	`HydrationCheck/{entityName}`
`POST`	`Preview`
`POST`	`Update`
`PUT`	`Update`
`DELETE`	`CleanAll/{entityName}`
`DELETE`	`DropTable/{tableName}`
`POST`	`AstQuery`
`POST`	`AstMutate`

ExecutionCapabilityMatrix

Execution surface capability matrix describing grants, host imports, and runtime affordances.

Base: /api/ExecutionCapabilityMatrix

Method	Path tail
`GET`	`matrix`

Federation

Federation contracts, lookup, creation, revocation, and access checks.

Base: /api/Federation

Method	Path tail
`GET`	`contracts`
`GET`	`contracts/{id}`
`POST`	`contracts`
`DELETE`	`contracts/{id}`
`GET`	`contracts/check`

OrganizationRecord

Organization control-plane record CRUD.

Base: /api/OrganizationRecord

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`

PlatformSourceAssetDiagnostics

Source asset cache status, rebuild, and migration diagnostics.

Base: /api/PlatformSourceAssetDiagnostics

Method	Path tail
`GET`	`cache-status`
`POST`	`rebuild-cache`
`POST`	`migrate`

ProjectCapabilityGrant

Project-scoped capability grant list, grant, and revoke operations.

Base: /api/projects

Method	Path tail
`GET`	`{projectId}/capability-grants`
`POST`	`{projectId}/capability-grants`
`DELETE`	`{projectId}/capability-grants/{grantId}`

ProjectProvisioning

Project resolution, child project creation, provider binding lookup, runtime state, hierarchy traversal, and lifecycle actions.

Base: /api/projects

Method	Path tail
`GET`	`resolve`
`POST`	`{parentProjectId}/children`
`GET`	`{projectId}/provider-bindings`
`GET`	`{projectId}/runtime`
`POST`	`{projectId}/suspend`
`POST`	`{projectId}/resume`
`POST`	`{projectId}/archive`
`GET`	`{projectId}/children`
`GET`	`{projectId}/descendants`
`GET`	`{projectId}/ancestors`

ProjectRecord

Project control-plane record CRUD, organization lookup, and template adoption.

Base: /api/ProjectRecord

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`
`GET`	`ByOrganization/{organizationId}`
`POST`	`{id}/adopt-template`

ProjectSelfService

Self-service project creation.

Base: /api/projects

Method	Path tail
`POST`	`create`

RootProject

Current root project lookup.

Base: /api/root-project

Method	Path tail
`GET`	`current`

RuntimeConnectorBinding

Runtime connector bindings by scope, environment, and connector name.

Base: /api/RuntimeConnectorBinding

Method	Path tail
`GET`	`{scope}`
`GET`	`{scope}/{environmentId}/{connectorName}`
`PUT`	`{scope}/{environmentId}/{connectorName}`
`DELETE`	`{scope}/{environmentId}/{connectorName}`

TaskAttempt

Scheduling task attempt listing and inspection.

Base: /api/scheduling/taskattempt

Method	Path tail
`GET`	`/`
`GET`	`{id}`

TaskDefinition

Task definitions, pause/resume, triggers, and definition lifecycle.

Base: /api/scheduling/taskdefinition

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`PUT`	`{id}`
`DELETE`	`{id}`
`POST`	`{id}/pause`
`POST`	`{id}/resume`
`POST`	`/`
`GET`	`{id}/triggers`
`POST`	`{id}/triggers`
`DELETE`	`{id}/triggers/{triggerId}`

TaskRun

Task run listing, inspection, cancellation, and manual triggering.

Base: /api/scheduling/taskrun

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`{id}/cancel`
`POST`	`{definitionId}/trigger`

TenantRecord

Tenant control-plane record CRUD.

Base: /api/TenantRecord

Method	Path tail
`GET`	`/`
`GET`	`{id}`
`POST`	`/`
`PUT`	`{id}`
`DELETE`	`{id}`

Reference overview

Exposure bindings