Skip to main content
View Markdown

AI & Integration Guide

Everything you need to build on top of ZeyOS — the REST API, the JavaScript client, the CLI, and CLI-first workflows for coding agents and automation, with tutorials and ready-to-run sample apps.

Sections
6

Choose your task​

Each path lists what you need, the pages to read in order, and how to tell that it worked.

Build a ZeyOS app​

Write native iXML and Zymba that runs inside ZeyOS, and package it as an application.

Before you start

  • The ZeyOS SDK (zeysdk) and a linked sandbox instance
  • Permission to send source to that instance

Read in this order

  1. Set up the SDK
  2. App structure
  3. Execution contexts
  4. Minimal app
  5. Verification checkpoints

First success

You run zeysdk compile on the minimal app against your sandbox and it reports no errors. The published sample compiles on a sandbox but has not been run on an instance, so this run is your first evidence for your own instance.

Troubleshooting
Native troubleshooting

Connect an external application​

Read and write ZeyOS data from a service, browser app or script running outside ZeyOS.

Before you start

  • Access to a ZeyOS instance
  • OAuth client credentials
  • Node.js 18 or later for the JavaScript client

Read in this order

  1. Integration architecture
  2. Authentication
  3. JavaScript client: getting started
  4. Making requests
  5. Server-side integrations

First success

client.schema.validate('listTickets', { fields: ['ID', 'name'] }) passes offline, then the same query returns your tickets.

Troubleshooting
Practical guide

Use a coding agent with ZeyOS​

Give a coding agent the authoritative references, project instructions and validation tools.

Before you start

  • A coding agent such as Kilo Code, Pi or OpenCode
  • The ZeyOS CLI and client, version 1.0.0 or later

Read in this order

  1. Agent setup
  2. Project instructions
  3. Agent quickstart
  4. Native code validation

First success

The agent follows the project instructions and shows a request preview without writing anything.

Use ZeyOS business data​

Answer questions from your records, and run record operations you explicitly request, with or without an agent.

Before you start

  • The zeyos CLI, signed in with zeyos login

Read in this order

  1. Agent quickstart
  2. Agent recipes
  3. Coding agents

First success

zeyos count accounts --filter '{"type":1,"visibility":0}' prints your number of customers.

Agent SetupUse a coding agent with ZeyOS: configure Kilo Code, Pi or OpenCode with shared instructions and validation checks.Setup guide Project instructionsCopy the reference, formatting and validation rules into your project.Open Markdown Machine-readable referencesDiscover authoritative Zymba declarations, API contracts and database schemas.AI resources

Browse the Guide​

Pick a section to dive in.

API ReferenceQuery language, authentication, resource endpoints and field schemas for the REST API.JavaScript ClientInstallation, authentication, CRUD operations and real-world implementation patterns.CLIThe command-line interface for scripting, automation and coding-agent workflows.Agent WorkflowsCLI-first workflows for coding agents, automation scripts and operational tooling.Application DevelopersGuides for browser UIs, server-side integrations and connected applications.Sample ApplicationsThree ready-to-run sample apps demonstrating different integration patterns.