Skip to main content
OrgX is API-first infrastructure for AI-native teams. The API gives clients, agents, and internal systems governed access to workspace context, initiatives, decisions, artifacts, memory, and agent execution state.
The OrgX REST API is in Public Preview. Endpoints, authentication, errors, pagination, idempotency, and webhook conventions are documented publicly so integrations can be built and reviewed before General Availability.

​
API Surfaces

SurfaceEndpointBest forStatus
MCP APIhttps://mcp.useorgx.com/mcpAI clients, agent tools, widgets, approval flowsPublic Preview
REST APIhttps://useorgx.com/api/clientSystem integrations, local clients, dashboards, runtime bridgesPublic Preview
WebhooksCustomer-provided HTTPS endpointEvent delivery to external systemsPublic Preview

​
At a Glance

TopicContract
AuthenticationREST uses user-scoped API keys in Authorization: Bearer oxk_.... MCP uses OAuth 2.1 with PKCE.
Data scopeEvery request is scoped to the authenticated user and workspace.
Request formatJSON request bodies with Content-Type: application/json.
Response formatJSON. Most preview REST endpoints return either { "ok": true, "data": ... } or a resource-specific JSON object.
VersioningPublic Preview uses the current stable preview contract. OrgX-Version is reserved for integrations that pin a contract date as versioned compatibility hardens.
IdempotencyUse client-generated idempotency keys where an endpoint documents support. Cross-endpoint retry semantics are being standardized during Public Preview.
PaginationList endpoints use limit, offset, total, and pagination.has_more where available.
Rate limitsPreview limits are conservative: reads are higher than writes, and agent dispatch has tighter limits.
SandboxUse a sandbox workspace and test API key for reviewer, CI, and demo integrations.

​
First REST Call

Use the bootstrap endpoint to prove authentication, workspace resolution, and integration readiness: 
curl https://useorgx.com/api/client/bootstrap \
  -H "Authorization: Bearer $ORGX_API_KEY" \
  -H "Accept: application/json"
Successful responses include the workspace, project context, available capabilities, and any setup gaps the client should handle before dispatching work. 
{
  "ok": true,
  "data": {
    "workspace": {
      "id": "d85d7e6f-58f2-4637-b3a0-3cf2c3b8a638",
      "name": "Acme"
    },
    "sourceClient": "custom",
    "capabilities": [],
    "setup": {
      "ready": true
    }
  }
}

​
First MCP Calls

For AI clients, start with MCP. These calls orient the model before it reads or writes work: 
workspace action=get -> orgx_recommend -> orgx_search(type=decision,status=pending)
  1. workspace action=get confirms the active workspace and auth context.
  2. orgx_recommend returns initiatives, agents, and recent activity.
  3. orgx_search with type=decision,status=pending shows work awaiting review.

​
Public Preview Resource Map

ResourceRESTMCPNotes
Workspaces/api/client/bootstrapworkspaceResolve current workspace and client setup state.
Initiatives/api/client/live/initiativesorgx_search, orgx_recommendRead portfolio state and progress.
DecisionsMCP-firstorgx_decide, orgx_decide, orgx_decideREST decision resources are graduating during Public Preview.
Agents/api/client/live/agents, /api/client/spawnorgx_spawn, orgx_spawnRead status and preflight agent dispatch.
Artifacts/api/client/artifactsartifact resources and approval toolsRegister artifacts and fetch entity-linked outputs.
Memory/api/client/tools/executeorgx_search, orgx_searchSearch org context through governed tools.
WebhooksWebhooksN/AEvent delivery for external systems.

​
Authentication Choices

REST API keys

Generate a user-scoped oxk_... API key in OrgX settings and send it as a bearer token to /api/client/*.

MCP OAuth

Connect ChatGPT, Claude, Cursor, VS Code, or another MCP client through OAuth 2.1 with PKCE.

​
Status and Compatibility

Public Preview means:
  • The docs are public and reviewable.
  • Preview endpoints are intended for real integrations.
  • Breaking changes are still possible before GA, but they will be documented.
  • Production workspace data always requires authentication.
  • Customer data is never available through anonymous API calls.
For a Stripe-style review, this is the canonical documentation URL: 
https://docs.useorgx.com/docs/api/overview