Developers

Build on the WOXOX Business Operating System

Build enterprise applications, AI agents, integrations, automations and marketplace apps using one unified platform.

woxox-cli · sandbox

import { Woxox } from "@woxox/sdk"

Developer Overview

Extend the operating system

WOXOX is not just an API service — you build on a shared kernel, metadata, workflow, and AI Platform.

Platform philosophy

You extend a Business Operating System — shared kernel, metadata, workflow, and AI — not a single-purpose API product.

Extension model

Apps, plugins, agents, and integrations run on declared permissions with sandbox and review.

Developer lifecycle

Sandbox → build → test → review → publish → version — the same path for internal and Marketplace apps.

Versioning strategy

API versions, SDK semver, and Marketplace app versions stay compatible with the Platform Kernel contract.

Enterprise extensibility

Multi-tenant isolation, SSO, audit, and governance apply to every extension by default.

Platform Architecture

Where your code plugs in

Interactive stack — each layer links to Platform documentation. Extensions inherit identity, tenancy, and governance.

Open Platform Architecture

Quick Start

From workspace to publish

Create workspace → API key → install SDK → create app → deploy → publish.

Step 1 of 6

Create Workspace

Provision a developer sandbox tenant.

Authentication

Secure access for humans and machines

OAuth2, JWT, API keys, PATs, SSO, scopes, permissions, RBAC, and multi-tenant access.

OAuth2

Authorization code and client credentials for apps.

JWT

Signed access tokens with tenant and scope claims.

API Keys

Server-to-server keys with rotatable secrets.

Personal Access Tokens

Developer PATs for local tooling and CLI.

SSO

Enterprise IdP federation for human operators.

Scopes

Least-privilege scopes per resource and action.

Permissions

Kernel evaluation on every API call.

RBAC

Role templates inherited by extensions.

Multi-Tenant Access

Strict tenant isolation for every request.

SDKs

Official clients for the Business OS

Install, read docs, and follow GitHub placeholders — future SDKs marked clearly.

JavaScript

npm install @woxox/sdk

Documentation GitHub

TypeScript

npm install @woxox/sdk

Documentation GitHub

Node.js

npm install @woxox/sdk

Documentation GitHub

Python

pip install woxox

Documentation GitHub

Java

Future

Coming soon

Documentation GitHub

Go

Future

Coming soon

Documentation GitHub

PHP

Future

Coming soon

Documentation GitHub

.NET

Future

Coming soon

Documentation GitHub

REST API

One HTTP surface for the operating system

Resources, pagination, filtering, sorting, rate limits, errors, and versioning — placeholder examples until live docs connect.

Resource structure

Consistent /v1/{resource} paths across modules.

Pagination

Cursor and page-based pagination with link headers.

Filtering

Query filters on fields and relationships.

Sorting

Multi-field sort with stable defaults.

Rate limits

Per-key and per-tenant quotas with Retry-After.

Errors

Typed error codes and machine-readable details.

Versioning

URL versioning with deprecation windows.

Example endpoints

GET/v1/entities/customersList customers
POST/v1/entities/dealsCreate a deal
GET/v1/workflows/runsList workflow runs
POST/v1/ai/invokeGoverned AI invoke

Example request · bash

curl https://api.woxox.com/v1/entities/deals \
  -H "Authorization: Bearer $WOXOX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Enterprise", "value": 120000 }'

Example response · json

{
  "id": "deal_01HZX...",
  "name": "Acme Enterprise",
  "value": 120000,
  "tenant_id": "ten_...",
  "created_at": "2026-07-25T12:00:00Z"
}

GraphQL

Typed queries across the entity graph

Queries, mutations, subscriptions, schema, explorer, and authentication.

Queries

Fetch entities and relationships in one round trip.

Mutations

Create and update through the same permission model.

Subscriptions

Realtime updates over secured channels.

Schema

Typed schema aligned to the Universal Entity Model.

Explorer

Interactive GraphQL explorer in the developer portal.

Authentication

Same OAuth/JWT as REST.

Sample query · graphql

query Deals($limit: Int!) {
  deals(limit: $limit) {
    id
    name
    value
    customer { id name }
  }
}

Webhooks & Events

Realtime integration on the event bus

Subscriptions, retries, signatures, replay, filtering, DLQ, and event types.

Event Bus

Platform event bus fans out module and system events.

Subscriptions

Subscribe endpoints per event type and filter.

Retries

Exponential backoff with idempotency keys.

Signatures

HMAC signatures for payload verification.

Replay

Replay failed deliveries from the portal.

Filtering

Filter by entity type, module, and tenant.

Dead Letter Queue

Capture poison messages for inspection.

Event Types

entity.*, workflow.*, ai.*, marketplace.*

Verify signature (placeholder) · typescript

import { createHmac, timingSafeEqual } from 'crypto'

function verify(rawBody: string, signature: string, secret: string) {
  const digest = createHmac('sha256', secret).update(rawBody).digest('hex')
  return timingSafeEqual(Buffer.from(digest), Buffer.from(signature))
}

CLI

WOXOX CLI

Initialize, generate, deploy, test, publish, and upgrade from the terminal.

woxox init

Initialize a project

woxox generate app

Generate an extension scaffold

woxox deploy

Deploy an extension to sandbox

woxox test

Run local tests and permission checks

woxox publish

Publish to Marketplace / private catalog

woxox upgrade

Upgrade SDK and kernel contracts

Install CLI (placeholder) · bash

npm install -g @woxox/cli
woxox login
woxox init my-extension
woxox deploy --env sandbox

Marketplace SDK

Ship apps to every WOXOX workspace

Create app, manifest, permissions, assets, publishing, review, updates, and versioning.

Create App

Scaffold a Marketplace application.

Manifest

Declare scopes, hooks, and assets.

Permissions

Least-privilege review at install time.

Assets

Icons, screenshots, and localization packs.

Publishing

Submit for review and distribution.

Review Process

Security and UX review gates.

Updates

Staged rollouts to workspaces.

Versioning

Semver with compatible kernel APIs.

View Marketplace

AI SDK

The only supported path to models

Prompt, Agent, Knowledge, Memory, streaming, tool calling, and governance — never call LLMs from apps or plugins.

Critical rule: use woxox.ai.* / /v1/ai/*. Direct provider SDKs are not allowed in extensions.

Prompt API

Invoke versioned prompts via the AI Platform.

Agent API

Run agents that only call platform tools.

Knowledge API

Index and retrieve governed knowledge.

Memory API

Conversation and entity memory with retention.

Streaming

Token streams for copilots and UIs.

Tool Calling

Declare tools resolved through the kernel.

AI Governance

Policies, budgets, and audit on every call.

AI invoke · typescript

import { Woxox } from '@woxox/sdk'

const woxox = new Woxox({ apiKey: process.env.WOXOX_API_KEY })

const result = await woxox.ai.invoke({
  capability: 'summarize',
  entity: { type: 'ticket', id: 't_42' },
})

AI Platform Docs

Plugin Framework

Hooks, UI, and services in a sandbox

Lifecycle, hooks, services, extension points, UI components, permissions, sandbox, and dependencies.

Lifecycle

Install, enable, upgrade, disable, uninstall.

Hooks

Before/after hooks on entities and workflows.

Services

Background jobs and scheduled services.

Extension Points

Forms, actions, pages, and nav slots.

UI Components

Design-system compatible extension UI.

Permissions

Declared scopes enforced by the kernel.

Sandbox

Isolated runtime for untrusted code.

Dependency Management

Declare module and API dependencies.

Sample Applications

Start from working patterns

CRM extension, dashboard, approval workflow, AI agent, Marketplace app, Slack, WhatsApp, and analytics widget.

CRM Extension

Custom fields and actions on Customer module.

Custom Dashboard

Metadata-driven analytics widget.

Approval Workflow

Multi-step approvals via Workflow Engine.

AI Agent

Support agent using AI SDK (no direct LLM).

Marketplace App

Full manifest + publish sample.

Slack Integration

Webhooks + OAuth partner sample.

WhatsApp Integration

Messaging connector pattern.

Analytics Widget

Embeddable chart on OS shell.

API Explorer Preview

Try the shape of the API

Endpoint selector, headers, body, mock response, and code generation — no backend execution.

Headers

Response

// Click Send for a mock response (no network call)

Code generation

curl https://api.woxox.com/v1/entities/customers \
  -X GET \
  -H "Authorization: Bearer $WOXOX_TOKEN"

Documentation Categories

Documentation hub

Modular categories ready to map to a future docs system.

Getting Started

Workspace, keys, first app.

Open

API Reference

REST resources and errors.

Open

SDKs

Language clients and install.

Open

Authentication

OAuth, JWT, keys, scopes.

Open

Marketplace

Publish and version apps.

Open

AI Platform

Invoke, agents, knowledge.

Open

Workflows

Automations and approvals.

Open

Metadata

Schema and layouts.

Open

Examples

Sample applications.

Open

Best Practices

Security and tenancy guidance.

Open

Release Notes

API and SDK changes.

Open

Community

Build with other platform developers

GitHub, Discord, Forum placeholders — plus roadmap, blog, and tutorials.

GitHub

SDKs and samples (placeholder).

Discord

Developer chat (placeholder).

Forum

Q&A and architecture threads (placeholder).

Roadmap

Public platform roadmap.

Developer Blog

Deep dives and tutorials.

Tutorials

Step-by-step build guides.

Changelog

Latest releases

Platform, SDK, API, and breaking changes — placeholder feed for a future release system.

Platform2026.07
AI Platform invoke v1
Governed /v1/ai/invoke with streaming preview.
SDK2026.06
SDK 1.4.0
TypeScript types for entities and workflows.
API2026.05
Webhooks signatures
HMAC-SHA256 signatures and replay UI.
Breaking2026.04
Breaking: pagination cursors
Prefer cursor pagination; page tokens deprecated in 2026.10.

FAQ

Developer portal questions

Is WOXOX just an API service?

No. Developers extend the Business Operating System — kernel, metadata, workflow, and AI Platform — so extensions inherit identity, tenancy, and governance.

Can my plugin call OpenAI directly?

No. Use the AI SDK / /v1/ai/* APIs. Applications and plugins must never communicate directly with LLMs.

Where do I find architecture depth?

See the Platform page for the 8-layer stack, kernel, entity model, and AI control plane.

Woxox Business OS

Ready to extend the Business Operating System?

Get started in the sandbox, explore API docs, or talk to the platform team about enterprise extensibility.

Get Started Contact Platform Team

Build on the WOXOX Business Operating System

Extend the operating system

Platform philosophy

Extension model

Developer lifecycle

Versioning strategy

Enterprise extensibility

Where your code plugs in

Infrastructure

Platform Kernel

Metadata Engine

Workflow Engine

AI Platform

Plugin Framework

Marketplace Apps

Applications

From workspace to publish

Create Workspace

Secure access for humans and machines

OAuth2

JWT

API Keys

Personal Access Tokens

SSO

Scopes

Permissions

RBAC

Multi-Tenant Access

Official clients for the Business OS

JavaScript

TypeScript

Node.js

Python

Java

Go

PHP

.NET

One HTTP surface for the operating system

Resource structure

Pagination

Filtering

Sorting

Rate limits

Errors

Versioning

Example endpoints

Typed queries across the entity graph

Queries

Mutations

Subscriptions

Schema

Explorer

Authentication

Realtime integration on the event bus

Event Bus

Subscriptions

Retries

Signatures

Replay

Filtering

Dead Letter Queue

Event Types

WOXOX CLI

Ship apps to every WOXOX workspace

Create App

Manifest

Permissions

Assets

Publishing

Review Process

Updates

Versioning

The only supported path to models

Prompt API

Agent API

Knowledge API

Memory API

Streaming

Tool Calling

AI Governance