REST API reference

Every endpoint, every parameter, every error code. Same canonical operations as GraphQL, gRPC, and the typed SDKs.

⌘ Kor/to search every method, command, and endpoint

OverviewAPI overviewThe product-level explanation of REST, GraphQL, gRPC, realtime, webhooks, and MCP.RESTREST API modelBase URLs, resource conventions, pagination, idempotency, error envelopes, OpenAPI discovery, and examples.OpenAPIOpenAPI & SwaggerSpec discovery, operation IDs, schema projection, Swagger UI behavior, and client generation.GraphQLGraphQL referenceCompiled SDL, query and mutation shapes, pagination, filters, subscriptions, errors, and examples.gRPCgRPC referenceProto services, metadata, streaming, status mapping, deadlines, reflection, and generated clients.RealtimeRealtime & eventsWebSocket, SSE, event envelopes, subscription filters, replay, and field-name-only delivery.WebhooksWebhooks referenceInbound and outbound delivery, signatures, retries, replay, idempotency, and receiver contracts.MCPMCP referenceJSON-RPC methods, resource metadata, token model, tools, resources, prompts, errors, and observability.

Entity CRUD (canonical pattern)

These six endpoints exist for EVERY entity in your project, generated from the canonical contract. Substitute `{entity}` with the entity name (e.g. orders, customers, products).

GET`/api/{entity}`

List entity rows with typed filters, sorting, pagination, and relation expansion.

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`filter`	query	JSON	Typed filter expression — eq, ne, gt, lt, in, between, like, isNull, and, or, not.
`sort`	query	string	Comma-separated, prefix with '-' for desc. e.g. '-createdAt,name'.
`fields`	query	csv	Sparse projection.
`include`	query	csv	Relations to expand.
`page`	query	int	Page number (1-indexed).
`pageSize`	query	int	Items per page (max 200).
`cursor`	query	string	Cursor pagination (preferred over page numbers).
`includeTotal`	query	bool	Add totalCount to response.

Response

200{ data: T[], page: { number, size, totalCount?, next?, prev? } }

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
401	`UNAUTHORIZED`	Missing or invalid bearer token.
403	`ACCESS_DENIED`	Actor lacks read on the entity or its row filter.
422	`VALIDATION_FAILED`	Filter expression invalid or references unknown fields.
429	`QUOTA_EXCEEDED`	Project read quota exceeded.

get-list.example

curl -G "https://api.vadyl.app/v1/orders" \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  --data-urlencode 'filter={"status":{"in":["paid","fulfilled"]}}' \
  --data-urlencode 'sort=-createdAt' \
  --data-urlencode 'pageSize=50'

POST`/api/{entity}`

Create a row. Idempotent when an Idempotency-Key header is provided.

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`Idempotency-Key`	header	string	Idempotency key for safe retries.

Request body

JSON object matching the entity's create-input schema.

Response

201Created row with generated fields filled (id, timestamps, etc.).

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
401	`UNAUTHORIZED`	Missing/invalid bearer.
403	`ACCESS_DENIED`	Insert-check denied.
409	`CONFLICT`	Unique-key violation.
422	`VALIDATION_FAILED`	Field invariant violated.

post-create.example

curl -X POST https://api.vadyl.app/v1/customers \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  -H "Idempotency-Key: signup:abc" \
  -H "Content-Type: application/json" \
  -d '{ "email":"ada@example.com", "name":"Ada Lovelace" }'

GET`/api/{entity}/{id}`

Read one row by primary key.

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`id`required	path	string	Primary key.
`include`	query	csv	Relations to expand.
`fields`	query	csv	Sparse projection.

Response

200Entity row.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
401	`UNAUTHORIZED`	Missing/invalid bearer.
403	`ACCESS_DENIED`	Read filter excludes this row.
404	`NOT_FOUND`	Row missing.

get-read.example

curl https://api.vadyl.app/v1/orders/ord_abc -H "Authorization: Bearer $VADYL_TOKEN"

PATCH`/api/{entity}/{id}`

Partial update with optimistic concurrency support.

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`id`required	path	string	Primary key.
`If-Match`	header	string	Expected ConcurrencyToken — 409 if changed.

Request body

JSON object with fields to update.

Response

200Updated row.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
401	`UNAUTHORIZED`	Missing/invalid bearer.
403	`ACCESS_DENIED`	Update target filter or result check denied.
404	`NOT_FOUND`	Row missing.
409	`CONFLICT`	If-Match mismatch — re-read and retry.
422	`VALIDATION_FAILED`	Field invariant violated.

patch-update.example

curl -X PATCH https://api.vadyl.app/v1/customers/c_abc \
  -H "Authorization: Bearer $VADYL_TOKEN" \
  -H "If-Match: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Ada L." }'

PUT`/api/{entity}/{id}`

Full replace (all required fields must be provided).

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`id`required	path	string	Primary key.

Request body

JSON object with all required fields (replaces the row).

Response

200Replaced row.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/{entity}/{id}`

Delete a row (soft on entities with that lifecycle, hard otherwise).

Parameters

Name	In	Type	Description
`entity`required	path	string	Pluralized entity name.
`id`required	path	string	Primary key.
`force`	query	bool	Hard-delete a soft-delete entity (admin).

Response

204No content.

HTTP/1.1 204 No Content

Errors

Status	Code	Description
401	`UNAUTHORIZED`	Missing/invalid bearer.
403	`ACCESS_DENIED`	Delete-filter rejected.
404	`NOT_FOUND`	Row missing.
409	`CONFLICT`	Foreign-key restrict; remove dependents first.

Runtime Fabric scaling

Canonical project scaling endpoints for previewing topology, setting desired count, updating scaling/resource/ingress policy, suspending autoscale, and explaining decisions.

POST`/api/RuntimeFabric/{projectId}/scaling/preview`

Dry-run scaling, resource, ingress, and capability changes before applying.

Parameters

Name	In	Type	Description
`projectId`required	path	string	Project id or slug.

Request body

ProjectRuntimeTopologyProfile or patch request with surfaces, resources, scaling, and networkExposure.

Response

200Capability, governance, and realization preview.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/RuntimeFabric/{projectId}/env/{environmentId}/scaling/targets`

List runtime scale targets with desired/running state and measure dimensions.

Parameters

Name	In	Type	Description
`projectId`required	path	string	Project id or slug.
`environmentId`required	path	string	Project environment id.

Response

200RuntimeScaleTarget[] with surface, scale group, connector, and current state.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/scale`

Set desired count for a manual runtime target.

Parameters

Name	In	Type	Description
`projectId`required	path	string	Project id or slug.
`environmentId`required	path	string	Project environment id.
`surfaceKind`required	path	string	Project execution surface kind.

Request body

{ desiredCount: number, targetIdentity: RuntimeScaleTargetIdentity, idempotencyKey?: string }

Response

202RuntimeScaleMutation accepted or applied.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
403	`ACCESS_DENIED`	Actor lacks runtime.scale grant.
422	`VALIDATION_FAILED`	Target identity, governance, or capability check failed.

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/scaling`

Update canonical scaling policy for one surface.

Request body

{ surfaceKind, partitionMode, connectorName, substrateKind, scaling: RuntimeScalingPolicy }

Response

200Updated topology profile and satisfaction report.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/resources`

Update vendor-neutral vertical resource policy for one surface.

Request body

{ surfaceKind, partitionMode, connectorName, substrateKind, resources: RuntimeVerticalResourcePolicy }

Response

200Updated topology profile and satisfaction report.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/ingress`

Update canonical ingress and load-balancing policy for one surface.

Request body

{ surfaceKind, partitionMode, connectorName, substrateKind, networkExposure: RuntimeNetworkExposureSpec }

Response

200Updated topology profile and satisfaction report.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/autoscale/explain`

Explain latest autoscale decision, skipped decision, stale measure, or rejection.

Response

200RuntimeAutoscaleExplanation with measure values, governance gates, and reason codes.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Entity relations

Auto-generated nested endpoints for traversing relations.

GET`/api/{entity}/{id}/{relation}`

List related rows for the relation.

Parameters

Name	In	Type	Description
`entity`required	path	string	Source entity.
`id`required	path	string	Source row id.
`relation`required	path	string	Relation name (declared on the source entity).
`filter`	query	JSON	Typed filter on the related entity.
`pageSize`	query	int	Items per page.
`cursor`	query	string	Pagination cursor.

Response

200Page of related rows.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/{entity}/{id}/{relation}`

Attach a related row (M:N through link tables, or set FK side).

Request body

{ relatedId: string }

Response

201Attached.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/{entity}/{id}/{relation}/{relatedId}`

Detach a related row.

Parameters

Name	In	Type	Description
`relatedId`required	path	string	Related row id.

Response

204Detached.

HTTP/1.1 204 No Content

Operations

Cross-entity / custom operations declared in your project.

POST`/api/{entity}/{id}/{operation}`

Invoke a custom operation defined on an entity.

Request body

Operation-specific JSON input.

Response

200Operation result (typed).

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/operations/{operation}`

Invoke a global custom operation.

Request body

Operation-specific JSON input.

Response

200Operation result (typed).

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Identity

Sessions, tokens, MFA challenges, federation flows.

GET`/api/identity/me`

Resolve the current actor.

Response

200Actor record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/identity/sessions`

List the actor's sessions.

Response

200Session[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/identity/sessions/{sessionId}`

Revoke a session.

Parameters

Name	In	Type	Description
`sessionId`required	path	string	Session id.

Response

204Revoked.

HTTP/1.1 204 No Content

POST`/api/identity/challenges`

Start an MFA / step-up challenge.

Request body

{ subjectId, requireStrength }

Response

201Challenge record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/identity/challenges/{challengeId}/complete`

Complete a challenge.

Parameters

Name	In	Type	Description
`challengeId`required	path	string	Challenge id.

Request body

{ proof }

Response

200Updated session with elevated AuthStrength.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/identity/tokens/refresh`

Refresh a token using the refresh-token family.

Request body

{ refreshToken }

Response

200{ accessToken, refreshToken, expiresAt }.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/identity/federation/start`

Start an OIDC / SAML federation flow.

Request body

{ provider, redirectUri }

Response

200{ url, state }.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/identity/federation/callback`

Complete a federation flow.

Request body

{ provider, code, state }

Response

200Session created/refreshed.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Events

Canonical event log.

GET`/api/events`

List events with filters.

Parameters

Name	In	Type	Description
`filter`	query	JSON	Filter by kind, entity, time, correlation.

Response

200Page of events.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/events/{id}`

Get a specific event.

Parameters

Name	In	Type	Description
`id`required	path	string	Event id.

Response

200Event record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/events/tail`

Server-Sent Events stream of live events.

Response

200text/event-stream of events.

event: vadyl.event
data: { "id": "evt_123", "type": "order.paid", "correlationId": "01HXZ..." }

POST`/api/events/{id}/replay`

Replay an event into its registered consumers.

Parameters

Name	In	Type	Description
`id`required	path	string	Event id.

Response

202Replay accepted.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Audit

Tamper-resistant audit trail.

GET`/api/audit`

Search audit trail.

Parameters

Name	In	Type	Description
`filter`	query	JSON	Filter by reasonCode, actor, entity, scope, time.

Response

200Page of audit rows.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/audit/tail`

SSE stream of new audit entries.

Response

200text/event-stream.

event: vadyl.event
data: { "id": "evt_123", "type": "order.paid", "correlationId": "01HXZ..." }

Explainability

Project canonical decision-record reasoning. Reads directly from authorities — never log-scraped.

POST`/api/Explainability/access`

Why was a read/write allowed/denied.

Request body

{ entity, operation, filter?, asActor? }

Response

200AccessExplanation { decision, reasonCode, evaluatedFilter, fieldMasks }.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Explainability/readPlan`

Show the AST plan, cache decision, chosen provider.

Request body

{ entity, filter?, sort?, include? }

Response

200ReadPlanExplanation.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/Explainability/projectRuntime`

Why this publication is serving traffic.

Response

200ProjectRuntimeExplanation.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/Explainability/authoredPublication`

Which authored artifacts are bound, why selected.

Response

200AuthoredPublicationExplanation.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/Explainability/apiSurface`

Why a route resolved to this operation.

Parameters

Name	In	Type	Description
`route`required	query	string	Route to explain.

Response

200ApiSurfaceExplanation.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Branching

Branches, sandboxes, proposals, deployments.

GET`/api/branches`

List branches.

Response

200Branch[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/branches`

Create a branch.

Request body

{ name, base? }

Response

201Branch record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/branches/{name}`

Show branch HEAD + protection policies.

Parameters

Name	In	Type	Description
`name`required	path	string	Branch name.

Response

200Branch record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/sandboxes`

List active sandboxes.

Response

200Sandbox[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/sandboxes`

Provision a sandbox.

Request body

{ branch, seedFrom? }

Response

201Sandbox.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/sandboxes/{id}`

Tear down a sandbox.

Parameters

Name	In	Type	Description
`id`required	path	string	Sandbox id.

Response

204Destroyed.

HTTP/1.1 204 No Content

GET`/api/proposals`

List proposals.

Response

200Proposal[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/proposals`

Open a proposal.

Request body

{ title, base, head, description? }

Response

201Proposal record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/proposals/{id}`

Show diff, validation, approvals.

Parameters

Name	In	Type	Description
`id`required	path	string	Proposal id.

Response

200Proposal record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/proposals/{id}/approve`

Sign approval.

Parameters

Name	In	Type	Description
`id`required	path	string	Proposal id.

Response

200Approval recorded.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/proposals/{id}/merge`

Merge once gates pass.

Parameters

Name	In	Type	Description
`id`required	path	string	Proposal id.

Response

200Merged.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/deployments/preview`

Preview a deployment.

Request body

{ target }

Response

200DeployPlan.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/deployments`

Apply a deployment.

Request body

{ target, ramp?, bake? }

Response

202Deployment record.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/deployments/{id}`

Show deployment status.

Parameters

Name	In	Type	Description
`id`required	path	string	Deployment id.

Response

200Deployment record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/deployments/{id}/rollback`

Roll back a deployment.

Parameters

Name	In	Type	Description
`id`required	path	string	Deployment id.

Request body

{ toVersion }

Response

202Rollback accepted.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Webhooks

Inbound + outbound webhooks.

GET`/api/webhooks/endpoints`

List webhook endpoints.

Response

200WebhookEndpoint[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/webhooks/endpoints`

Create a webhook endpoint.

Request body

{ url, eventTypeFilter?, signingSecretRef }

Response

201Endpoint record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

PATCH`/api/webhooks/endpoints/{id}`

Update an endpoint.

Parameters

Name	In	Type	Description
`id`required	path	string	Endpoint id.

Response

200Endpoint record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/webhooks/endpoints/{id}`

Delete an endpoint.

Parameters

Name	In	Type	Description
`id`required	path	string	Endpoint id.

Response

204Deleted.

HTTP/1.1 204 No Content

GET`/api/webhooks/deliveries`

List recent deliveries.

Response

200WebhookDelivery[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/webhooks/deliveries/{id}/replay`

Replay a delivery.

Parameters

Name	In	Type	Description
`id`required	path	string	Delivery id.

Response

202Replay scheduled.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/webhooks/{publicReceiverKey}`

Inbound webhook receiver (public, signature-verified).

Parameters

Name	In	Type	Description
`publicReceiverKey`required	path	string	Globally unique receiver key.

Response

202Accepted.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Realtime

WebSocket and SSE subscriptions for entity changes and broadcasts.

GET`/api/realtime`

WebSocket entrypoint. Pass token via header or query.

Response

101Switching Protocols (WebSocket).

HTTP/1.1 101 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/realtime/sse`

SSE entrypoint.

Parameters

Name	In	Type	Description
`entity`required	query	string	Entity to watch.
`filter`	query	JSON	Predicate.

Response

200text/event-stream of change events (field names only).

event: vadyl.event
data: { "id": "evt_123", "type": "order.paid", "correlationId": "01HXZ..." }

Usage & Billing

Quotas, usage rollups, billing events.

GET`/api/usage/events`

List append-only usage events.

Response

200UsageEvent[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/usage/rollups`

List periodic rollups.

Response

200UsageMeterRollup[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/usage/quotas`

List quota definitions.

Response

200ProjectQuota[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/usage/quotas`

Create a quota.

Request body

{ kind, limit, mode }

Response

201Quota record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

PATCH`/api/usage/quotas/{id}`

Update a quota.

Parameters

Name	In	Type	Description
`id`required	path	string	Quota id.

Response

200Quota record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

DELETE`/api/usage/quotas/{id}`

Delete a quota.

Parameters

Name	In	Type	Description
`id`required	path	string	Quota id.

Response

204Deleted.

HTTP/1.1 204 No Content

Federation

Cross-project per-entity directional grants.

GET`/api/Federation/contracts`

List federation contracts (as source or target).

Response

200FederatedContract[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Federation/contracts`

Create a federation contract.

Request body

{ sourceProjectId, targetProjectId, entityName, accessMode, expiresAt? }

Response

201Contract record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Federation/contracts/{id}/revoke`

Revoke a contract.

Parameters

Name	In	Type	Description
`id`required	path	string	Contract id.

Response

200Revoked.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Installable Surfaces

Publish / install / upgrade versioned capability bundles.

GET`/api/Surface/published`

List published surfaces.

Response

200PublishedSurface[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/publish`

Publish a surface version.

Request body

{ name, version, schema }

Response

201PublishedSurface record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/published/{id}/deprecate`

Deprecate a surface version.

Parameters

Name	In	Type	Description
`id`required	path	string	PublishedSurface id.

Response

200Deprecated.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/Surface/installations`

List the consumer's installations.

Response

200SurfaceInstallation[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/installations`

Install a surface.

Request body

{ publisherProjectId, surfaceName, version, manifest }

Response

201Installation record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/installations/{id}/suspend`

Suspend an installation.

Parameters

Name	In	Type	Description
`id`required	path	string	Installation id.

Response

200Suspended.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/installations/{id}/resume`

Resume an installation.

Parameters

Name	In	Type	Description
`id`required	path	string	Installation id.

Response

200Resumed.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/Surface/installations/{id}/uninstall`

Uninstall.

Parameters

Name	In	Type	Description
`id`required	path	string	Installation id.

Response

200Uninstalled.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Agents

Run agents, inspect runs, manage memory.

GET`/api/agents`

List agent definitions.

Response

200Agent[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/agents/{name}`

Show an agent.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.

Response

200Agent record.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/agents/{name}/run`

Run an agent.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.

Request body

{ prompt, userId?, budget? }

Response

202Run record.

HTTP/1.1 202 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/agents/{name}/runs`

List runs.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.

Response

200Run[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/agents/{name}/runs/{runId}`

Show run details.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.
`runId`required	path	string	Run id.

Response

200Run with plan / steps / tokens / cost.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/agents/{name}/runs/{runId}/stream`

SSE stream of live steps.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.
`runId`required	path	string	Run id.

Response

200text/event-stream.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/agents/{name}/memory`

Recall memory facts.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.
`kind`	query	string	Fact kind.
`subject`	query	string	Subject id.
`asOf`	query	time	Replay-stable temporal recall.

Response

200Fact[].

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

POST`/api/agents/{name}/memory`

Record a memory fact.

Parameters

Name	In	Type	Description
`name`required	path	string	Agent name.

Request body

{ kind, subject, body }

Response

201Fact record.

HTTP/1.1 201 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

MCP

Model Context Protocol (JSON-RPC 2.0 endpoint + RFC 9728 metadata).

POST`/mcp`

JSON-RPC 2.0 endpoint — supports tools/list and tools/call.

Request body

JSON-RPC 2.0 request — { jsonrpc:'2.0', id, method, params? }

Response

200JSON-RPC 2.0 response.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/mcp/.well-known/oauth-authorization-server`

OAuth Authorization Server Metadata (RFC 9728).

Response

200OAuth metadata document.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/mcp/.well-known/oauth-protected-resource`

OAuth Protected Resource Metadata.

Response

200Resource metadata document.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Spec discovery

Always-current specs compiled from the canonical entity model.

GET`/api/openapi.json`

OpenAPI 3.1 spec (JSON).

Response

200OpenAPI document.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/api/openapi.yaml`

OpenAPI 3.1 spec (YAML).

Response

200OpenAPI document (YAML).

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/graphql/schema`

GraphQL SDL.

Response

200GraphQL SDL (text).

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/grpc/proto/vadyl-app.proto`

gRPC proto bundle.

Response

200Protobuf .proto file.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Health

Standard liveness/readiness probes.

GET`/healthz/live`

Liveness probe — process alive (always 200 unless dead).

Response

200ok.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

GET`/healthz/ready`

Readiness probe — registered dependency checks.

Response

200ok or aggregate health document.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Errors

Status	Code	Description
503	`UNAVAILABLE`	One or more dependency checks failing.

GET`/healthz`

Aggregate health (alias for /healthz/ready).

Response

200ok.

HTTP/1.1 200 OK
{
  "data": { "id": "res_123", "state": "active" },
  "meta": { "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42" }
}

Complete controller atlas

Every code-backed controller route grouped by canonical surface. Versioned siblings use /api/v{version}/... when declared by the controller.

`/api/Agent`

Start native agent runs.

Method	Path tail	Sample output
`POST`	`{agentId}/run`	`200/201/202 JSON`

Request / response pattern

Request: /api/Agent/{agentId}/run
Response: {
  "surface": "Agent",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AgentMemory`

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

Method	Path tail	Sample output
`GET`	`namespaces`	`200 JSON`
`POST`	`namespaces`	`200/201/202 JSON`
`GET`	`namespaces/{namespaceId}`	`200 JSON`
`POST`	`apply`	`200/201/202 JSON`
`POST`	`recall`	`200/201/202 JSON`
`GET`	`facts/{factId}`	`200 JSON`
`GET`	`namespaces/{namespaceId}/journal`	`200 JSON`

Request / response pattern

Request: /api/AgentMemory/namespaces
Response: {
  "surface": "AgentMemory",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AgentModelBinding`

LLM/model bindings for agents.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/AgentModelBinding//
Response: {
  "surface": "AgentModelBinding",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AgentPlan`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{planId}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`POST`	`{planId}/validate`	`200/201/202 JSON`
`POST`	`{planId}/preview`	`200/201/202 JSON`
`POST`	`{planId}/submit`	`200/201/202 JSON`
`POST`	`{planId}/approve`	`200/201/202 JSON`
`POST`	`{planId}/reject`	`200/201/202 JSON`
`POST`	`{planId}/execute`	`200/201/202 JSON`
`POST`	`{planId}/cancel`	`200/201/202 JSON`

Request / response pattern

Request: /api/AgentPlan//
Response: {
  "surface": "AgentPlan",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AgentRun`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{runId}`	`200 JSON`
`POST`	`{runId}/cancel`	`200/201/202 JSON`
`GET`	`{runId}/steps`	`200 JSON`
`GET`	`{runId}/reasoning`	`200 JSON`
`POST`	`{runId}/human-prompts/{promptId}/answer`	`200/201/202 JSON`

Request / response pattern

Request: /api/AgentRun//
Response: {
  "surface": "AgentRun",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AgentSkill`

Agent skill CRUD surface.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/AgentSkill//
Response: {
  "surface": "AgentSkill",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Analytics`

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

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

Request / response pattern

Request: /api/Analytics/catalog
Response: {
  "surface": "Analytics",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Asset`

Asset namespace and blob lookup diagnostics.

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

Request / response pattern

Request: /api/Asset/namespaces
Response: {
  "surface": "Asset",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AuthoredManagement`

Invoke management handlers.

Method	Path tail	Sample output
`POST`	`{handlerName}`	`200/201/202 JSON`

Request / response pattern

Request: /api/AuthoredManagement/{handlerName}
Response: {
  "surface": "AuthoredManagement",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AuthoredRuntime`

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

Method	Path tail	Sample output
`POST`	`validate`	`200/201/202 JSON`
`POST`	`preview-build`	`200/201/202 JSON`
`POST`	`publish`	`200/201/202 JSON`
`POST`	`sandbox/{sandboxId}/publish`	`200/201/202 JSON`
`POST`	`sandbox/{sandboxId}/invoke`	`200/201/202 JSON`

Request / response pattern

Request: /api/AuthoredRuntime/validate
Response: {
  "surface": "AuthoredRuntime",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AuthoredWorkflow`

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

Method	Path tail	Sample output
`POST`	`{workflowName}/start`	`200/201/202 JSON`
`POST`	`{instanceId}/signal/{signalName}`	`200/201/202 JSON`
`GET`	`{instanceId}`	`200 JSON`
`POST`	`{instanceId}/cancel`	`200/201/202 JSON`
`POST`	`{instanceId}/compensate`	`200/201/202 JSON`
`POST`	`{instanceId}/compensate/resume`	`200/201/202 JSON`

Request / response pattern

Request: /api/AuthoredWorkflow/{workflowName}/start
Response: {
  "surface": "AuthoredWorkflow",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AuthoringCatalog`

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

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

Request / response pattern

Request: /api/AuthoringCatalog/languages
Response: {
  "surface": "AuthoringCatalog",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Automation`

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

Method	Path tail	Sample output
`POST`	`compile`	`200/201/202 JSON`
`POST`	`runs/start`	`200/201/202 JSON`
`GET`	`runs/{runId}`	`200 JSON`
`GET`	`runs/{runId}/approvals`	`200 JSON`
`GET`	`runs/{runId}/attempts`	`200 JSON`
`POST`	`runs/{runId}/cancel`	`200/201/202 JSON`
`POST`	`runs/{runId}/compensate`	`200/201/202 JSON`
`POST`	`runs/{runId}/signal`	`200/201/202 JSON`
`POST`	`approvals/{approvalTaskId}/approve`	`200/201/202 JSON`
`POST`	`approvals/{approvalTaskId}/reject`	`200/201/202 JSON`
`POST`	`attempts/{attemptId}/retry`	`200/201/202 JSON`
`GET`	`definitions`	`200 JSON`
`GET`	`definitions/{id}`	`200 JSON`
`POST`	`definitions`	`200/201/202 JSON`
`PUT`	`definitions/{id}`	`200 JSON`
`POST`	`definitions/{id}/lifecycle`	`200/201/202 JSON`
`DELETE`	`definitions/{id}`	`204 or 200 JSON`
`GET`	`definitions/{id}/synthesized-workflow`	`200 JSON`

Request / response pattern

Request: /api/Automation/compile
Response: {
  "surface": "Automation",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Branch`

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

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

Request / response pattern

Request: /api/Branch/branches
Response: {
  "surface": "Branch",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Build`

Build trigger and artifact lookup.

Method	Path tail	Sample output
`POST`	`trigger`	`200/201/202 JSON`
`GET`	`artifact/{artifactId}`	`200 JSON`

Request / response pattern

Request: /api/Build/trigger
Response: {
  "surface": "Build",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/CacheProviderBinding`

Cache provider bindings and runtime descriptor.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`
`GET`	`runtime`	`200 JSON`

Request / response pattern

Request: /api/CacheProviderBinding//
Response: {
  "surface": "CacheProviderBinding",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connection`

Governed connection CRUD and lookup.

Method	Path tail	Sample output
`POST`	`/`	`200/201/202 JSON`
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`GET`	`by-name/{name}`	`200 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/Connection//
Response: {
  "surface": "Connection",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connector`

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

Method	Path tail	Sample output
`GET`	`contracts`	`200 JSON`
`GET`	`contracts/{kind}/{majorVersion:int}`	`200 JSON`
`GET`	`implementations`	`200 JSON`
`GET`	`implementations/{implementationId}`	`200 JSON`
`POST`	`bindings`	`200/201/202 JSON`
`GET`	`bindings`	`200 JSON`
`GET`	`bindings/{alias}`	`200 JSON`
`GET`	`isolation/profiles`	`200 JSON`
`POST`	`invoke`	`200/201/202 JSON`

Request / response pattern

Request: /api/Connector/contracts
Response: {
  "surface": "Connector",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/ContractProjection`

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

Method	Path tail	Sample output
`GET`	`descriptor`	`200 JSON`
`GET`	`{language}/declarations`	`200 JSON`
`GET`	`cli`	`200 JSON`
`GET`	`events`	`200 JSON`

Request / response pattern

Request: /api/ContractProjection/descriptor
Response: {
  "surface": "ContractProjection",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Credential`

Credential list, rotation, revocation, and deletion.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`{id}/revoke`	`200/201/202 JSON`
`POST`	`{id}/rotate`	`200/201/202 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/Credential//
Response: {
  "surface": "Credential",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/DatabaseConnector`

Database connector binding management, validation, health, drift.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{alias}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{alias}`	`200 JSON`
`DELETE`	`{alias}`	`204 or 200 JSON`
`POST`	`{alias}/validate`	`200/201/202 JSON`
`GET`	`{alias}/describe`	`200 JSON`
`GET`	`{alias}/health`	`200 JSON`
`GET`	`{alias}/drift`	`200 JSON`

Request / response pattern

Request: /api/DatabaseConnector//
Response: {
  "surface": "DatabaseConnector",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/database-sources`

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

Method	Path tail	Sample output
`POST`	`/`	`200/201/202 JSON`
`POST`	`{alias}/retire`	`200/201/202 JSON`
`POST`	`{alias}/probe`	`200/201/202 JSON`
`POST`	`{alias}/discover`	`200/201/202 JSON`
`POST`	`{alias}/infer`	`200/201/202 JSON`
`POST`	`{alias}/decisions`	`200/201/202 JSON`
`POST`	`{alias}/revert`	`200/201/202 JSON`
`POST`	`{alias}/acceptance`	`200/201/202 JSON`
`POST`	`{alias}/preview`	`200/201/202 JSON`
`POST`	`{alias}/apply`	`200/201/202 JSON`
`POST`	`{alias}/reconcile`	`200/201/202 JSON`
`POST`	`{alias}/artifacts`	`200/201/202 JSON`
`POST`	`{alias}/import`	`200/201/202 JSON`
`GET`	`manifest`	`200 JSON`

Request / response pattern

Request: /api/database-sources//
Response: {
  "surface": "DatabaseSources",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/DataPortability`

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

Method	Path tail	Sample output
`POST`	`import`	`200/201/202 JSON`
`GET`	`export`	`200 JSON`
`POST`	`schema/backup`	`200/201/202 JSON`
`POST`	`restore/validate`	`200/201/202 JSON`
`POST`	`portability/verify`	`200/201/202 JSON`

Request / response pattern

Request: /api/DataPortability/import
Response: {
  "surface": "DataPortability",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Distribution`

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

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

Request / response pattern

Request: /api/Distribution/projects/{projectId}/bindings
Response: {
  "surface": "Distribution",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Entity`

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

Method	Path tail	Sample output
`POST`	`/`	`200/201/202 JSON`
`POST`	`{entityName}`	`200/201/202 JSON`
`GET`	`{entityName}/{id}`	`200 JSON`
`POST`	`{entityName}/{id}/restore`	`200/201/202 JSON`
`PUT`	`{entityName}/{id}`	`200 JSON`
`DELETE`	`{entityName}/{id}`	`204 or 200 JSON`
`PUT`	`{entityName}/upsert`	`200 JSON`
`POST`	`{entityName}/query`	`200/201/202 JSON`
`POST`	`query`	`200/201/202 JSON`
`GET`	`{entityName}`	`200 JSON`
`GET`	`{entityName}/count`	`200 JSON`
`HEAD`	`{entityName}/{id}`	`200/404 headers`
`GET`	`{entityName}/by/{keyGroup}`	`200 JSON`
`POST`	`{entityName}/batch`	`200/201/202 JSON`
`DELETE`	`{entityName}/batch`	`204 or 200 JSON`
`PUT`	`{entityName}/batch`	`200 JSON`

Request / response pattern

Request: /api/Entity//
Response: {
  "surface": "Entity",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Event`

Canonical event log and diagnostics.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`GET`	`Diagnostics`	`200 JSON`

Request / response pattern

Request: /api/Event//
Response: {
  "surface": "Event",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Evolution`

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

Method	Path tail	Sample output
`GET`	`runs/{runId}`	`200 JSON`
`GET`	`runs/active`	`200 JSON`
`GET`	`runs/{runId}/nodes`	`200 JSON`
`GET`	`runs/{runId}/barriers`	`200 JSON`
`GET`	`runs/{runId}/events`	`200 JSON`
`GET`	`status`	`200 JSON`

Request / response pattern

Request: /api/Evolution/runs/{runId}
Response: {
  "surface": "Evolution",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Explainability`

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

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

Request / response pattern

Request: /api/Explainability/surface
Response: {
  "surface": "Explainability",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/identity`

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

Method	Path tail	Sample output
`GET`	`discovery`	`200 JSON`
`POST`	`login`	`200/201/202 JSON`
`POST`	`register`	`200/201/202 JSON`
`POST`	`refresh`	`200/201/202 JSON`
`POST`	`logout`	`200/201/202 JSON`
`GET`	`federation/{alias}/initiate`	`200 JSON`
`GET`	`federation/{alias}/callback`	`200 JSON`
`POST`	`challenge/start`	`200/201/202 JSON`
`POST`	`challenge/verify`	`200/201/202 JSON`

Request / response pattern

Request: /api/identity/discovery
Response: {
  "surface": "IdentityEntrypoint",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/IdentityManagement`

Subjects, memberships, policies, deactivation, revocation.

Method	Path tail	Sample output
`GET`	`subjects`	`200 JSON`
`GET`	`subjects/{id}`	`200 JSON`
`POST`	`subjects/{id}/deactivate`	`200/201/202 JSON`
`GET`	`memberships`	`200 JSON`
`POST`	`memberships`	`200/201/202 JSON`
`POST`	`memberships/{id}/revoke`	`200/201/202 JSON`
`GET`	`policies`	`200 JSON`

Request / response pattern

Request: /api/IdentityManagement/subjects
Response: {
  "surface": "IdentityManagement",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Introspection`

Versions, compiled surface, breaking change metadata.

Method	Path tail	Sample output
`GET`	`versions`	`200 JSON`
`GET`	`surface`	`200 JSON`
`GET`	`breaking-changes`	`200 JSON`

Request / response pattern

Request: /api/Introspection/versions
Response: {
  "surface": "Introspection",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/KnowledgeCorpus`

Knowledge corpus CRUD.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/KnowledgeCorpus//
Response: {
  "surface": "KnowledgeCorpus",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Maintenance`

Operator maintenance primitives.

Method	Path tail	Sample output
`POST`	`clean-dynamic-state`	`200/201/202 JSON`

Request / response pattern

Request: /api/Maintenance/clean-dynamic-state
Response: {
  "surface": "Maintenance",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/mcp/{tenantSlug}/{projectSlug}`

MCP JSON-RPC and protected-resource metadata.

Method	Path tail	Sample output
`POST`	`/`	`200/201/202 JSON`
`GET`	`.well-known/oauth-protected-resource`	`200 JSON`

Request / response pattern

Request: /mcp/{tenantSlug}/{projectSlug}//
Response: {
  "surface": "Mcp",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Measure`

Measure descriptors and queries.

Method	Path tail	Sample output
`GET`	`descriptors`	`200 JSON`
`GET`	`descriptors/{nodeIdEncoded}`	`200 JSON`
`POST`	`query`	`200/201/202 JSON`

Request / response pattern

Request: /api/Measure/descriptors
Response: {
  "surface": "Measure",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Observability`

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

Method	Path tail	Sample output
`GET`	`Entries`	`200 JSON`
`GET`	`Entries/{id}`	`200 JSON`
`GET`	`Trail/{entityName}`	`200 JSON`
`GET`	`Trails`	`200 JSON`
`GET`	`Trails/{id}`	`200 JSON`
`GET`	`Traces`	`200 JSON`
`GET`	`Traces/{id}`	`200 JSON`
`GET`	`Diagnostics`	`200 JSON`

Request / response pattern

Request: /api/Observability/Entries
Response: {
  "surface": "Observability",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/OperationalResource`

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

Method	Path tail	Sample output
`POST`	`streams/{providerName}/{streamName}/append`	`200/201/202 JSON`
`POST`	`streams/{providerName}/{streamName}/consume`	`200/201/202 JSON`
`POST`	`streams/{streamName}/groups/{consumerGroup}/ack`	`200/201/202 JSON`
`POST`	`streams/{providerName}/{streamName}/nack`	`200/201/202 JSON`
`POST`	`streams/{streamName}/groups/{consumerGroup}/seek`	`200/201/202 JSON`
`POST`	`streams/{providerName}/{streamName}/trim`	`200/201/202 JSON`

Request / response pattern

Request: /api/OperationalResource/streams/{providerName}/{streamName}/append
Response: {
  "surface": "OperationalResource",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Operation`

Plan and execute canonical operations.

Method	Path tail	Sample output
`POST`	`Execute`	`200/201/202 JSON`
`POST`	`Plan`	`200/201/202 JSON`

Request / response pattern

Request: /api/Operation/Execute
Response: {
  "surface": "Operation",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/PlaneCapabilityGraph`

PCG descriptor and node lookup.

Method	Path tail	Sample output
`GET`	`descriptor`	`200 JSON`
`GET`	`nodes/{kind}`	`200 JSON`

Request / response pattern

Request: /api/PlaneCapabilityGraph/descriptor
Response: {
  "surface": "PlaneCapabilityGraph",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Platform`

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

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

Request / response pattern

Request: /api/Platform/providers
Response: {
  "surface": "PlatformDiagnostics",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects`

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

Method	Path tail	Sample output
`POST`	`create`	`200/201/202 JSON`
`GET`	`resolve`	`200 JSON`
`POST`	`{parentProjectId}/children`	`200/201/202 JSON`
`GET`	`{projectId}/provider-bindings`	`200 JSON`
`GET`	`{projectId}/runtime`	`200 JSON`
`POST`	`{projectId}/suspend`	`200/201/202 JSON`
`POST`	`{projectId}/resume`	`200/201/202 JSON`
`POST`	`{projectId}/archive`	`200/201/202 JSON`
`GET`	`{projectId}/children`	`200 JSON`
`GET`	`{projectId}/descendants`	`200 JSON`
`GET`	`{projectId}/ancestors`	`200 JSON`
`GET`	`{projectId}/capability-grants`	`200 JSON`
`POST`	`{projectId}/capability-grants`	`200/201/202 JSON`
`DELETE`	`{projectId}/capability-grants/{grantId}`	`204 or 200 JSON`

Request / response pattern

Request: /api/projects/create
Response: {
  "surface": "Projects",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects/{projectId}/provider-bindings`

Provider binding mutations and invalidation.

Method	Path tail	Sample output
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{alias}`	`200 JSON`
`DELETE`	`{alias}`	`204 or 200 JSON`
`POST`	`{alias}/restore`	`200/201/202 JSON`
`POST`	`invalidate`	`200/201/202 JSON`

Request / response pattern

Request: /api/projects/{projectId}/provider-bindings//
Response: {
  "surface": "ProjectProviderBinding",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/{TenantRecord|OrganizationRecord|ProjectRecord}`

Control-plane record CRUD and template adoption.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`
`GET`	`/api/ProjectRecord/ByOrganization/{organizationId}`	`200 JSON`
`POST`	`/api/ProjectRecord/{id}/adopt-template`	`200/201/202 JSON`

Request / response pattern

Request: /api/{TenantRecord|OrganizationRecord|ProjectRecord}//
Response: {
  "surface": "Tenant/Organization/Project records",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Publication`

Publication list/read/latest.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{pubVersion:long}`	`200 JSON`
`GET`	`latest`	`200 JSON`

Request / response pattern

Request: /api/Publication//
Response: {
  "surface": "Publication",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/RuntimeFabric and /api/PlatformRuntimeFabric`

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

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

Request / response pattern

Request: /api/RuntimeFabric and /api/PlatformRuntimeFabric/{projectId}/fabric
Response: {
  "surface": "RuntimeFabric",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/RuntimeUnit`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`
`POST`	`{id}/validate`	`200/201/202 JSON`
`POST`	`{id}/describe-capabilities`	`200/201/202 JSON`
`GET`	`{id}/publication-lineage`	`200 JSON`

Request / response pattern

Request: /api/RuntimeUnit//
Response: {
  "surface": "RuntimeUnit",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Schema`

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

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

Request / response pattern

Request: /api/Schema/entities
Response: {
  "surface": "Schema",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/SchemaTransition`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`preview`	`200/201/202 JSON`
`POST`	`/`	`200/201/202 JSON`
`POST`	`{id}/execute`	`200/201/202 JSON`
`POST`	`{id}/rollback`	`200/201/202 JSON`

Request / response pattern

Request: /api/SchemaTransition//
Response: {
  "surface": "SchemaTransition",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Sdk`

SDK generation, language listing, versioning metadata.

Method	Path tail	Sample output
`POST`	`generate`	`200/201/202 JSON`
`GET`	`languages`	`200 JSON`
`GET`	`versioning`	`200 JSON`

Request / response pattern

Request: /api/Sdk/generate
Response: {
  "surface": "Sdk",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/SourceAsset`

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

Method	Path tail	Sample output
`GET`	`folder`	`200 JSON`
`POST`	`folder`	`200/201/202 JSON`
`PUT`	`folder/{id}/rename`	`200 JSON`
`DELETE`	`folder/{id}`	`204 or 200 JSON`
`GET`	`file`	`200 JSON`
`GET`	`file/{id}`	`200 JSON`
`GET`	`file/by-path`	`200 JSON`
`POST`	`blob`	`200/201/202 JSON`
`POST`	`file`	`200/201/202 JSON`
`PUT`	`file/{id}/content`	`200 JSON`
`PUT`	`file/{id}/rename`	`200 JSON`
`DELETE`	`file/{id}`	`204 or 200 JSON`
`PUT`	`file/{id}/upload`	`200 JSON`
`GET`	`file/{id}/download`	`200 JSON`
`GET`	`tree`	`200 JSON`
`GET`	`scope/shape`	`200 JSON`

Request / response pattern

Request: /api/SourceAsset/folder
Response: {
  "surface": "SourceAsset",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Storage`

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

Method	Path tail	Sample output
`POST`	`upload`	`200/201/202 JSON`
`GET`	`download/{**storagePath}`	`200 JSON`
`HEAD`	`exists/{**storagePath}`	`200/404 headers`
`DELETE`	`{**storagePath}`	`204 or 200 JSON`
`GET`	`list`	`200 JSON`
`GET`	`providers`	`200 JSON`
`GET`	`info/{**storagePath}`	`200 JSON`

Request / response pattern

Request: /api/Storage/upload
Response: {
  "surface": "Storage",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Surface`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`GET`	`{id}/is-installed`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`POST`	`{id}/install`	`200/201/202 JSON`
`DELETE`	`{id}/uninstall`	`204 or 200 JSON`
`POST`	`{id}/upgrade`	`200/201/202 JSON`
`POST`	`{id}/suspend`	`200/201/202 JSON`
`POST`	`{id}/resume`	`200/201/202 JSON`

Request / response pattern

Request: /api/Surface//
Response: {
  "surface": "Surface",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/scheduling/{taskdefinition|taskrun|taskattempt}`

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

Method	Path tail	Sample output
`GET`	`taskdefinition/`	`200 JSON`
`GET`	`taskdefinition/{id}`	`200 JSON`
`PUT`	`taskdefinition/{id}`	`200 JSON`
`DELETE`	`taskdefinition/{id}`	`204 or 200 JSON`
`POST`	`taskdefinition/{id}/pause`	`200/201/202 JSON`
`POST`	`taskdefinition/{id}/resume`	`200/201/202 JSON`
`POST`	`taskdefinition/`	`200/201/202 JSON`
`GET`	`taskdefinition/{id}/triggers`	`200 JSON`
`POST`	`taskdefinition/{id}/triggers`	`200/201/202 JSON`
`DELETE`	`taskdefinition/{id}/triggers/{triggerId}`	`204 or 200 JSON`
`GET`	`taskrun/`	`200 JSON`
`GET`	`taskrun/{id}`	`200 JSON`
`POST`	`taskrun/{id}/cancel`	`200/201/202 JSON`
`POST`	`taskrun/{definitionId}/trigger`	`200/201/202 JSON`
`GET`	`taskattempt/`	`200 JSON`
`GET`	`taskattempt/{id}`	`200 JSON`

Request / response pattern

Request: /api/scheduling/{taskdefinition|taskrun|taskattempt}/taskdefinition/
Response: {
  "surface": "Scheduling",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/TriggerAudit`

Trigger audit events, clear, summary, diagnostics.

Method	Path tail	Sample output
`GET`	`Events`	`200 JSON`
`DELETE`	`Clear`	`204 or 200 JSON`
`GET`	`Summary`	`200 JSON`
`GET`	`Diagnostics`	`200 JSON`

Request / response pattern

Request: /api/TriggerAudit/Events
Response: {
  "surface": "TriggerAudit",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Usage`

Usage events, rollups, quotas, summary.

Method	Path tail	Sample output
`GET`	`{projectId}/events`	`200 JSON`
`GET`	`{projectId}/rollups`	`200 JSON`
`GET`	`{projectId}/quotas`	`200 JSON`
`POST`	`{projectId}/quotas`	`200/201/202 JSON`
`PUT`	`{projectId}/quotas/{quotaId}`	`200 JSON`
`DELETE`	`{projectId}/quotas/{quotaId}`	`204 or 200 JSON`
`GET`	`{projectId}/summary`	`200 JSON`

Request / response pattern

Request: /api/Usage/{projectId}/events
Response: {
  "surface": "Usage",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/version`

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

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

Request / response pattern

Request: /api/version//
Response: {
  "surface": "VersionGovernance",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/webhooks and /api/Webhook`

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

Method	Path tail	Sample output
`GET`	`endpoints`	`200 JSON`
`GET`	`endpoints/{id}`	`200 JSON`
`POST`	`endpoints`	`200/201/202 JSON`
`PUT`	`endpoints/{id}`	`200 JSON`
`DELETE`	`endpoints/{id}`	`204 or 200 JSON`
`POST`	`endpoints/{id}/rotate-secret`	`200/201/202 JSON`
`GET`	`endpoints/{endpointId}/deliveries`	`200 JSON`
`GET`	`receivers`	`200 JSON`
`GET`	`receivers/{id}`	`200 JSON`
`POST`	`receivers`	`200/201/202 JSON`
`PUT`	`receivers/{id}`	`200 JSON`
`DELETE`	`receivers/{id}`	`204 or 200 JSON`
`POST`	`inbound/{publicReceiverKey}`	`200/201/202 JSON`
`GET`	`diagnostics`	`200 JSON`

Request / response pattern

Request: /api/webhooks and /api/Webhook/endpoints
Response: {
  "surface": "Webhook",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/AuthoredRuntime`

Admin worker controls for the authored runtime pool.

Method	Path tail	Sample output
`POST`	`workers/reset`	`200/201/202 JSON`

Request / response pattern

Request: /api/AuthoredRuntime/workers/reset
Response: {
  "surface": "AuthoredRuntimeAdmin",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/BindingDiagnostics`

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

Method	Path tail	Sample output
`POST`	`TestTypedBind`	`200/201/202 JSON`
`GET`	`TestFactoryCreate`	`200 JSON`
`GET`	`Pipeline`	`200 JSON`

Request / response pattern

Request: /api/BindingDiagnostics/TestTypedBind
Response: {
  "surface": "BindingDiagnostics",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connector`

Declarative connector build surface under the canonical connector route.

Method	Path tail	Sample output
`POST`	`build/declarative`	`200/201/202 JSON`

Request / response pattern

Request: /api/Connector/build/declarative
Response: {
  "surface": "ConnectorBuild",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connector`

Connector conformance execution surface.

Method	Path tail	Sample output
`POST`	`conformance/run`	`200/201/202 JSON`

Request / response pattern

Request: /api/Connector/conformance/run
Response: {
  "surface": "ConnectorConformance",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connector`

Connector host memory and state lookup surface.

Method	Path tail	Sample output
`GET`	`memory/get`	`200 JSON`

Request / response pattern

Request: /api/Connector/memory/get
Response: {
  "surface": "ConnectorMemory",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Connector`

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

Method	Path tail	Sample output
`GET`	`publication/latest`	`200 JSON`
`GET`	`publication/version/{publicationVersion:long}`	`200 JSON`
`GET`	`publication/version/{publicationVersion:long}/{implementationId}`	`200 JSON`
`POST`	`publication/invalidate`	`200/201/202 JSON`

Request / response pattern

Request: /api/Connector/publication/latest
Response: {
  "surface": "ConnectorPublication",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/CredentialReveal`

Controlled credential reveal token exchange.

Method	Path tail	Sample output
`POST`	`{tokenId}/reveal`	`200/201/202 JSON`

Request / response pattern

Request: /api/CredentialReveal/{tokenId}/reveal
Response: {
  "surface": "CredentialReveal",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects/{projectId}/governance`

Inherited governance envelope and descendant inheritance policy management.

Method	Path tail	Sample output
`GET`	`envelope`	`200 JSON`
`GET`	`inheritance-policy`	`200 JSON`
`PUT`	`inheritance-policy`	`200 JSON`

Request / response pattern

Request: /api/projects/{projectId}/governance/envelope
Response: {
  "surface": "DescendantGovernance",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/DevBootstrapDescriptor`

Development bootstrap descriptor for local and generated tooling.

Method	Path tail	Sample output
`GET`	`descriptor`	`200 JSON`

Request / response pattern

Request: /api/DevBootstrapDescriptor/descriptor
Response: {
  "surface": "DevBootstrapDescriptor",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/DynamicEntityTest`

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

Method	Path tail	Sample output
`POST`	`Create`	`200/201/202 JSON`
`POST`	`Delete`	`200/201/202 JSON`
`DELETE`	`Delete`	`204 or 200 JSON`
`DELETE`	`CleanAllProvider/{entityName}`	`204 or 200 JSON`
`DELETE`	`DropTableProvider/{tableName}`	`204 or 200 JSON`
`GET`	`TableCheckProvider/{pattern}`	`200 JSON`
`GET`	`TableCheck/{pattern}`	`200 JSON`
`GET`	`ColumnCheckProvider/{tableName}`	`200 JSON`
`GET`	`ColumnCheck/{tableName}`	`200 JSON`
`GET`	`HydrationCheck/{entityName}`	`200 JSON`
`POST`	`Preview`	`200/201/202 JSON`
`POST`	`Update`	`200/201/202 JSON`
`PUT`	`Update`	`200 JSON`
`DELETE`	`CleanAll/{entityName}`	`204 or 200 JSON`
`DELETE`	`DropTable/{tableName}`	`204 or 200 JSON`
`POST`	`AstQuery`	`200/201/202 JSON`
`POST`	`AstMutate`	`200/201/202 JSON`

Request / response pattern

Request: /api/DynamicEntityTest/Create
Response: {
  "surface": "DynamicEntityTest",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/ExecutionCapabilityMatrix`

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

Method	Path tail	Sample output
`GET`	`matrix`	`200 JSON`

Request / response pattern

Request: /api/ExecutionCapabilityMatrix/matrix
Response: {
  "surface": "ExecutionCapabilityMatrix",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/Federation`

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

Method	Path tail	Sample output
`GET`	`contracts`	`200 JSON`
`GET`	`contracts/{id}`	`200 JSON`
`POST`	`contracts`	`200/201/202 JSON`
`DELETE`	`contracts/{id}`	`204 or 200 JSON`
`GET`	`contracts/check`	`200 JSON`

Request / response pattern

Request: /api/Federation/contracts
Response: {
  "surface": "Federation",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/OrganizationRecord`

Organization control-plane record CRUD.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/OrganizationRecord//
Response: {
  "surface": "OrganizationRecord",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/PlatformSourceAssetDiagnostics`

Source asset cache status, rebuild, and migration diagnostics.

Method	Path tail	Sample output
`GET`	`cache-status`	`200 JSON`
`POST`	`rebuild-cache`	`200/201/202 JSON`
`POST`	`migrate`	`200/201/202 JSON`

Request / response pattern

Request: /api/PlatformSourceAssetDiagnostics/cache-status
Response: {
  "surface": "PlatformSourceAssetDiagnostics",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects`

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

Method	Path tail	Sample output
`GET`	`{projectId}/capability-grants`	`200 JSON`
`POST`	`{projectId}/capability-grants`	`200/201/202 JSON`
`DELETE`	`{projectId}/capability-grants/{grantId}`	`204 or 200 JSON`

Request / response pattern

Request: /api/projects/{projectId}/capability-grants
Response: {
  "surface": "ProjectCapabilityGrant",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects`

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

Method	Path tail	Sample output
`GET`	`resolve`	`200 JSON`
`POST`	`{parentProjectId}/children`	`200/201/202 JSON`
`GET`	`{projectId}/provider-bindings`	`200 JSON`
`GET`	`{projectId}/runtime`	`200 JSON`
`POST`	`{projectId}/suspend`	`200/201/202 JSON`
`POST`	`{projectId}/resume`	`200/201/202 JSON`
`POST`	`{projectId}/archive`	`200/201/202 JSON`
`GET`	`{projectId}/children`	`200 JSON`
`GET`	`{projectId}/descendants`	`200 JSON`
`GET`	`{projectId}/ancestors`	`200 JSON`

Request / response pattern

Request: /api/projects/resolve
Response: {
  "surface": "ProjectProvisioning",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/ProjectRecord`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`
`GET`	`ByOrganization/{organizationId}`	`200 JSON`
`POST`	`{id}/adopt-template`	`200/201/202 JSON`

Request / response pattern

Request: /api/ProjectRecord//
Response: {
  "surface": "ProjectRecord",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/projects`

Self-service project creation.

Method	Path tail	Sample output
`POST`	`create`	`200/201/202 JSON`

Request / response pattern

Request: /api/projects/create
Response: {
  "surface": "ProjectSelfService",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/root-project`

Current root project lookup.

Method	Path tail	Sample output
`GET`	`current`	`200 JSON`

Request / response pattern

Request: /api/root-project/current
Response: {
  "surface": "RootProject",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/RuntimeConnectorBinding`

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

Method	Path tail	Sample output
`GET`	`{scope}`	`200 JSON`
`GET`	`{scope}/{environmentId}/{connectorName}`	`200 JSON`
`PUT`	`{scope}/{environmentId}/{connectorName}`	`200 JSON`
`DELETE`	`{scope}/{environmentId}/{connectorName}`	`204 or 200 JSON`

Request / response pattern

Request: /api/RuntimeConnectorBinding/{scope}
Response: {
  "surface": "RuntimeConnectorBinding",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/scheduling/taskattempt`

Scheduling task attempt listing and inspection.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`

Request / response pattern

Request: /api/scheduling/taskattempt//
Response: {
  "surface": "TaskAttempt",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/scheduling/taskdefinition`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`
`POST`	`{id}/pause`	`200/201/202 JSON`
`POST`	`{id}/resume`	`200/201/202 JSON`
`POST`	`/`	`200/201/202 JSON`
`GET`	`{id}/triggers`	`200 JSON`
`POST`	`{id}/triggers`	`200/201/202 JSON`
`DELETE`	`{id}/triggers/{triggerId}`	`204 or 200 JSON`

Request / response pattern

Request: /api/scheduling/taskdefinition//
Response: {
  "surface": "TaskDefinition",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/scheduling/taskrun`

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

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`{id}/cancel`	`200/201/202 JSON`
`POST`	`{definitionId}/trigger`	`200/201/202 JSON`

Request / response pattern

Request: /api/scheduling/taskrun//
Response: {
  "surface": "TaskRun",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

`/api/TenantRecord`

Tenant control-plane record CRUD.

Method	Path tail	Sample output
`GET`	`/`	`200 JSON`
`GET`	`{id}`	`200 JSON`
`POST`	`/`	`200/201/202 JSON`
`PUT`	`{id}`	`200 JSON`
`DELETE`	`{id}`	`204 or 200 JSON`

Request / response pattern

Request: /api/TenantRecord//
Response: {
  "surface": "TenantRecord",
  "state": "ok",
  "correlationId": "01HXZ0J4YV8AJF2GFG2T1F7Y42"
}

REST API reference

Entity CRUD (canonical pattern)

GET/api/{entity}

POST/api/{entity}

GET/api/{entity}/{id}

PATCH/api/{entity}/{id}

PUT/api/{entity}/{id}

DELETE/api/{entity}/{id}

Runtime Fabric scaling

POST/api/RuntimeFabric/{projectId}/scaling/preview

GET/api/RuntimeFabric/{projectId}/env/{environmentId}/scaling/targets

POST/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/scale

PUT/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/scaling

PUT/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/resources

PUT/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/ingress

GET/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/autoscale/explain

Entity relations

GET/api/{entity}/{id}/{relation}

POST/api/{entity}/{id}/{relation}

DELETE/api/{entity}/{id}/{relation}/{relatedId}

Operations

POST/api/{entity}/{id}/{operation}

POST/api/operations/{operation}

Identity

GET/api/identity/me

GET/api/identity/sessions

DELETE/api/identity/sessions/{sessionId}

POST/api/identity/challenges

POST/api/identity/challenges/{challengeId}/complete

POST/api/identity/tokens/refresh

POST/api/identity/federation/start

POST/api/identity/federation/callback

Events

GET/api/events

GET/api/events/{id}

GET/api/events/tail

POST/api/events/{id}/replay

Audit

GET/api/audit

GET/api/audit/tail

Explainability

POST/api/Explainability/access

POST/api/Explainability/readPlan

GET/api/Explainability/projectRuntime

GET/api/Explainability/authoredPublication

GET/api/Explainability/apiSurface

Branching

GET/api/branches

POST/api/branches

GET/api/branches/{name}

GET/api/sandboxes

POST/api/sandboxes

DELETE/api/sandboxes/{id}

GET/api/proposals

POST/api/proposals

GET/api/proposals/{id}

POST/api/proposals/{id}/approve

POST/api/proposals/{id}/merge

POST/api/deployments/preview

POST/api/deployments

GET/api/deployments/{id}

POST/api/deployments/{id}/rollback

Webhooks

GET/api/webhooks/endpoints

POST/api/webhooks/endpoints

PATCH/api/webhooks/endpoints/{id}

DELETE/api/webhooks/endpoints/{id}

GET/api/webhooks/deliveries

POST/api/webhooks/deliveries/{id}/replay

POST/api/webhooks/{publicReceiverKey}

Realtime

GET/api/realtime

GET/api/realtime/sse

Usage & Billing

GET/api/usage/events

GET/api/usage/rollups

GET/api/usage/quotas

POST/api/usage/quotas

PATCH/api/usage/quotas/{id}

DELETE/api/usage/quotas/{id}

GET`/api/{entity}`

POST`/api/{entity}`

GET`/api/{entity}/{id}`

PATCH`/api/{entity}/{id}`

PUT`/api/{entity}/{id}`

DELETE`/api/{entity}/{id}`

POST`/api/RuntimeFabric/{projectId}/scaling/preview`

GET`/api/RuntimeFabric/{projectId}/env/{environmentId}/scaling/targets`

POST`/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/scale`

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/scaling`

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/resources`

PUT`/api/RuntimeFabric/{projectId}/topology/surfaces/{surfaceKind}/ingress`

GET`/api/RuntimeFabric/{projectId}/env/{environmentId}/surfaces/{surfaceKind}/autoscale/explain`

GET`/api/{entity}/{id}/{relation}`

POST`/api/{entity}/{id}/{relation}`

DELETE`/api/{entity}/{id}/{relation}/{relatedId}`

POST`/api/{entity}/{id}/{operation}`

POST`/api/operations/{operation}`

GET`/api/identity/me`

GET`/api/identity/sessions`

DELETE`/api/identity/sessions/{sessionId}`

POST`/api/identity/challenges`

POST`/api/identity/challenges/{challengeId}/complete`

POST`/api/identity/tokens/refresh`

POST`/api/identity/federation/start`

POST`/api/identity/federation/callback`

GET`/api/events`

GET`/api/events/{id}`

GET`/api/events/tail`

POST`/api/events/{id}/replay`

GET`/api/audit`

GET`/api/audit/tail`

POST`/api/Explainability/access`

POST`/api/Explainability/readPlan`

GET`/api/Explainability/projectRuntime`

GET`/api/Explainability/authoredPublication`

GET`/api/Explainability/apiSurface`

GET`/api/branches`

POST`/api/branches`

GET`/api/branches/{name}`

GET`/api/sandboxes`

POST`/api/sandboxes`

DELETE`/api/sandboxes/{id}`

GET`/api/proposals`

POST`/api/proposals`

GET`/api/proposals/{id}`

POST`/api/proposals/{id}/approve`

POST`/api/proposals/{id}/merge`

POST`/api/deployments/preview`

POST`/api/deployments`

GET`/api/deployments/{id}`

POST`/api/deployments/{id}/rollback`

GET`/api/webhooks/endpoints`

POST`/api/webhooks/endpoints`

PATCH`/api/webhooks/endpoints/{id}`

DELETE`/api/webhooks/endpoints/{id}`

GET`/api/webhooks/deliveries`

POST`/api/webhooks/deliveries/{id}/replay`

POST`/api/webhooks/{publicReceiverKey}`

GET`/api/realtime`

GET`/api/realtime/sse`

GET`/api/usage/events`

GET`/api/usage/rollups`

GET`/api/usage/quotas`

POST`/api/usage/quotas`

PATCH`/api/usage/quotas/{id}`

DELETE`/api/usage/quotas/{id}`

GET`/api/Federation/contracts`

POST`/api/Federation/contracts`

POST`/api/Federation/contracts/{id}/revoke`

GET`/api/Surface/published`

POST`/api/Surface/publish`

POST`/api/Surface/published/{id}/deprecate`

GET`/api/Surface/installations`

POST`/api/Surface/installations`

POST`/api/Surface/installations/{id}/suspend`

POST`/api/Surface/installations/{id}/resume`

POST`/api/Surface/installations/{id}/uninstall`

GET`/api/agents`

GET`/api/agents/{name}`