API

Orchetree exposes GraphQL for product data and execution, REST for operational workflows, and WebSocket subscriptions for live run updates.

Endpoints

Send X-Orchetree-Role: developer or X-Orchetree-Role: business. Missing or unknown roles default to business.

GraphQL

The schema covers projects, trees, nodes, prompt blocks, connectors, runs, node traces, versions, and collaboration records. Mutations cover authoring, connector binding, version management, and execution.

mutation RunTree {
  runTree(treeId: 1, inputData: { claim_id: "CLM-001" }) {
    id
    status
  }
}

runTree returns a pending run immediately. Subscribe to runStatus and runTraces, or query the run later.

REST workflows

REST routes cover:

• tree and project bundle export and import
• deployable project package export
• AI connection management and testing
• SDK synchronization
• skill discovery, review, storage, attachment, and deletion
• Co-pilot assistance and approved action execution

Use /api/v1/health for readiness checks and /api/v1/projects/overview for compact dashboard metrics.

Security and compatibility

• Protected mutations require the developer role.
• Credentials are encrypted and omitted from ordinary API responses.
• Bundle exports redact credentials unless a separately protected secrets workflow is explicitly enabled.
• WebSocket clients must use the graphql-transport-ws protocol.

For complete operation names and request schemas, use the live GraphQL schema at /api/v1/graphql and the repository’s docs/api.md.

See MCP and bundles, Execution, and Runs and traces.