API Reference
ainative-business exposes a local REST API with 241 endpoints across 26 domains.
All endpoints accept and return JSON. Authentication is handled by provider API keys configured in Settings.
Base URL
http://localhost:3000 ainative-business runs locally. All API calls are made to your local instance.
Core
Tasks
14 endpointsCreate, execute, cancel, and monitor task lifecycle with fire-and-forget execution, SSE log streaming, and AI-assisted planning.
Projects
7 endpointsManage project workspaces with working directories, document bindings, and cascading resource cleanup.
Workflows
14 endpointsOrchestrate multi-step execution patterns with debug analysis, resume, and optimization suggestions.
Blueprints
6 endpointsStore, import, and instantiate reusable workflow templates with GitHub-sourced definitions and lineage tracking.
Schedules
8 endpointsClock-driven cron and heartbeat schedules with natural language parsing, manual execution, heartbeat history, and delivery channels.
Apps
3 endpointsComposed apps that bundle profiles, blueprints, tables, and schedules into kit-typed views (tracker, coach, inbox, research, ledger, workflow-hub) with cascading delete.
Intelligence
Chat
19 endpointsMulti-provider conversations with SSE streaming, skill activation, export, model selection, suggested prompts, entity/file search, and conversation branching with rewind/redo.
Profiles
19 endpointsAgent profiles with multi-runtime support, per-profile testing, learned context, repository import with diff updates, and AI-assisted creation.
Runtimes
3 endpointsQuery available agent runtimes, suggest the best runtime for a task, and manage local Ollama model configuration.
Memory
4 endpointsEpisodic agent memory with list, create, update, and delete operations — decay scoring and confidence tracking included.
Content
Documents
7 endpointsUpload, preprocess, version, and download files with automatic text extraction.
Tables
30 endpointsStructured data grids with columns, rows, charts, triggers, enrichment, import/export, history, and templates.
Uploads
4 endpointsFile upload management with storage cleanup and metadata retrieval.
Views
4 endpointsSaved view configurations with filters, sorting, and column visibility.
Platform
Settings
35 endpointsProvider configuration, runtime routing, budgets, permissions, browser tools, web search, chat pins, saved searches, pricing, OpenAI login, and environment settings.
Permissions
6 endpointsPermission patterns and presets for tool access control, with list, create, and delete operations for both custom rules and built-in presets.
Notifications
6 endpointsApproval requests, alerts, and SSE streaming for pending permission decisions.
Channels
9 endpointsMulti-channel delivery via Slack, Telegram, and webhooks with bidirectional messaging, inbound polling, and per-channel test harnesses.
Environment
19 endpointsScan, audit, sync, and manage CLI environments with artifacts, checkpoints, templates, profile suggestions, and skill listing.
Snapshots
7 endpointsDatabase backup, restore, and settings management with point-in-time snapshot controls.
Workspace
4 endpointsDiscover, import, fix data directories, and analyze project workspace context for agent onboarding.
Instance
5 endpointsInstance configuration, initialization, and guided upgrade detection with version polling.
Operations
Logs
1 endpointsReal-time agent log streaming via Server-Sent Events with keepalive and backoff.
Handoffs
4 endpointsAgent-to-agent handoff records with list, create, retrieve, and approve/reject operations for delegation and review workflows.
Data
2 endpointsDatabase maintenance — clear all data or seed with sample records.
Context
1 endpointsBatch approve or reject learned context proposals from agent interactions.
Common Patterns
- Validation — Request bodies validated with Zod. Errors return
400witherror.flatten()format. - IDs — All resources use UUID v4 identifiers, auto-generated on creation.
- Fire-and-forget — Execution endpoints return
202 Acceptedwhile work runs asynchronously. - SSE — Streaming endpoints use
text/event-streamwith keepalive heartbeats. - Timestamps — All dates are ISO 8601 strings in responses.