API

Skip to documentation
Public API Surface / Active Definition
Public Programmatic Interface

CoreVexa API

The CoreVexa API model provides controlled programmatic access to intentionally published CoreVexa and VEXA capabilities while preserving governance, authorization, execution boundaries, evidence, and protected implementation details.

Controlled Exposure

Public API Surface in Active Definition

CoreVexa and VEXA use implemented programmatic interfaces inside the working product environment. The external public API contract is being intentionally separated from private product and service interfaces as specific endpoints and contracts are approved for external use.

Public API does not mean internal API.

Only interfaces intentionally published for external use should be treated as part of the public CoreVexa API. Internal routes, private services, protected schemas, and implementation-specific endpoints are not automatically supported public contracts.

Public API Model

Request → Governance → Authorized Action → Result

CoreVexa programmatic interaction is designed as a controlled flow, not a direct unrestricted execution channel.

Client
Submit a supported request

An approved client or system can submit a request through an intentionally published public interface.

Public API
Enter a defined contract

The request is accepted through a supported interface with a documented public request and response model.

Context
Associate the governed request

Relevant actor, workspace, proposed action, authority, and governance context can remain associated with the request.

CGS Boundary
Evaluate governance

Consequential requests can remain subject to the CoreVexa Governance Standard, authority, approval, risk, and evidence requirements.

Authorized Action
Execute only when permitted

A supported action can advance after the applicable authorization and governance conditions are satisfied.

Result
Return observable status or evidence

Supported responses can expose appropriate result, state, evidence, or outcome information according to the published contract.

Public Capability Classes

What an approved public API may expose.

Workspace

Governed Context

Approved interfaces may support creation, retrieval, or interaction with governed workspace context.

Decision

Proposed Actions

Supported clients may submit proposed actions or decision requests for governed handling.

Governance

Governance Status

Published interfaces may expose an appropriate public governance state associated with a request.

Authority

Approval State

Where appropriate, a response may indicate whether a request is pending, authorized, gated, denied, or blocked.

Execution

Action State

Approved interfaces may expose relevant execution state for actions that are permitted to proceed.

Evidence

Result Context

Supported responses may include intentionally exposed evidence, result, or outcome information.

Access Control

Authentication and authorization are different.

Authentication

Who or what is making the request

Public API access is intended to require approved identity and authentication appropriate to the supported integration model.

Authorization

Whether the requested action may proceed

Authorization determines whether the request has permission to perform the requested action in the current governed context.

Identity ≠ Unlimited Authority

Successfully authenticating a client establishes identity. It does not automatically grant that client permission to perform every consequential action exposed anywhere within CoreVexa.

Governed Requests

Context matters.

A programmatic request can involve more than a technical operation. CoreVexa is designed to preserve enough relevant context to determine how a proposed consequential action should be governed.

Actor

Who or what is submitting the request.

Workspace

The governed context in which the request belongs.

Proposed Action

The consequential activity being requested.

Authority

The permission required for the action to proceed.

Result

The supported response or evidence produced by the action.

CoreVexa Governance Standard

API calls can remain governed.

A request arriving through a programmatic interface does not automatically bypass the CoreVexa Governance Standard.

Authority

Permission

Determine whether the request has the required authority.

Risk

Consequence

Evaluate applicable risk before consequential execution.

Gates

Control

Required checkpoints can remain part of the execution path.

Evidence

Observe

Preserve appropriate evidence or outcome information.

Public Contract

Publish intentionally.

When endpoints, request models, responses, versioning, or other programmatic contracts are intentionally released, the Reference documentation should define the supported public contract.

Endpoint

Intentionally designated

Public endpoints should be explicitly identified rather than inferred from internal implementation.

Contract

Request & response models

Supported inputs, outputs, states, and expectations should be deliberately documented.

Compatibility

Version expectations

Compatibility, versioning, and deprecation expectations should be explicit.

API Lifecycle

Public contracts should be versioned deliberately.

01 / Designate
Identify public intent

Identify an interface as an intentional public API.

02 / Document
Define the contract

Define supported request and response contracts.

03 / Version
Set compatibility expectations

Establish compatibility expectations for supported clients.

04 / Deprecate
Communicate change

Identify deprecated public contracts before removal where applicable.

05 / Evolve Internally
Keep private change private

Internal implementation changes should not automatically become public API commitments.

Request States

A valid request is not always executable.

Accepted

Supported Handling

The request is valid and accepted for supported processing.

Pending / Gated

Governance Required

The request is valid but cannot proceed until required governance or authorization conditions are satisfied.

Denied / Blocked

Execution Not Permitted

The requested action is not permitted to execute in the current governed context.

Security & IP Boundary

Public documentation does not expose private interfaces.

This page describes the intended public API model and the principles governing programmatic interaction with CoreVexa.

Public

Supported contracts

Intentionally published endpoints, supported request models, responses, versions, states, and documented behavior.

Protected

Private implementation

Private endpoints, credentials, authentication secrets, internal service relationships, source code, protected schemas, proprietary governance logic, internal execution mechanisms, security-sensitive configuration, and confidential infrastructure remain undisclosed.

Do not infer endpoint availability from this page.

This documentation defines the intended CoreVexa public API model. It does not represent a commitment that every capability, endpoint, or integration described is currently available for unrestricted external production use. Current availability should be verified through Product Status and intentionally published API reference material.