Quick Start
Get up and running with OpenIndex in minutes.
Authentication
Create a Personal Access Token and authenticate your requests.
CLI Reference
Full reference for the
oi agent CLI — commands, flags, and workflows.API Reference
Explore the HTTP API for work items, workflows, calendars, and more.
How OpenIndex works
OpenIndex organizes work in a four-level hierarchy and routes it through configurable workflows with stage gates, custom fields, and agent dispatch.Create a domain
A domain is your top-level operational boundary — it contains your team, workflows, and work items. Set up a shared domain or use your personal domain to get started.
Define a workflow
Workflows define the lifecycle of your work items: statuses, stages, stage gates, and custom fields. Configure one for your domain to control how work progresses.
Create and assign work
Create projects, tasks, and sub-tasks inside your domain. Assign them to team members or mark them for agent execution.
Explore by topic
Work Model
Understand the Domain → Project → Task → Sub-task hierarchy.
Workflows
Learn how statuses, stages, and stage gates control work progression.
Agent Execution
Configure AI agents to claim and execute eligible workflow stages.
Email Operations
Set up mailboxes, routing rules, and inbound email conversations.