# FamilyCo

## Docs

- [Create auth token](https://familyco.mintlify.app/api-reference/auth-token.md): Verifies an API key and returns a short-lived bearer token.
- [Health check](https://familyco.mintlify.app/api-reference/health.md): Reports runtime mode, queue statistics, and migration status.
- [API introduction](https://familyco.mintlify.app/api-reference/introduction.md): Authentication, base URL, and scope of the current FamilyCo API reference.
- [List converter commands](https://familyco.mintlify.app/api-reference/knowledge/commands.md): Returns all configured Knowledge converter command definitions. Requires L0 authorization.
- [Get converter status](https://familyco.mintlify.app/api-reference/knowledge/converter-status.md): Checks whether the document converter binary can be resolved. Requires L0 authorization.
- [Delete knowledge document](https://familyco.mintlify.app/api-reference/knowledge/delete-document.md): Deletes the knowledge document and related chunks/embeddings. Requires L0 authorization.
- [Index knowledge document](https://familyco.mintlify.app/api-reference/knowledge/index-document.md): Runs converter, chunking, and embeddings for a document. Requires L0 authorization.
- [List knowledge chunks](https://familyco.mintlify.app/api-reference/knowledge/list-chunks.md): Returns chunk records for one knowledge document. Requires L0 authorization.
- [List knowledge documents](https://familyco.mintlify.app/api-reference/knowledge/list-documents.md): Lists uploaded knowledge documents with optional filtering. Requires L0 authorization.
- [Retrieve knowledge context](https://familyco.mintlify.app/api-reference/knowledge/retrieve.md): Searches indexed chunks by semantic similarity. Requires L0 authorization.
- [Upload knowledge document](https://familyco.mintlify.app/api-reference/knowledge/upload-document.md): Uploads one source file and creates a knowledge document record. Requires L0 authorization.
- [Agent operating model](https://familyco.mintlify.app/concepts/agent-operating-model.md): Hierarchy, run lifecycle, and behavior rules for FamilyCo agents.
- [Approval policy](https://familyco.mintlify.app/concepts/approval-policy.md): Which actions need approval, which trigger clarification, and how resolution flows back into a run.
- [Architecture](https://familyco.mintlify.app/concepts/architecture.md): How the FamilyCo monorepo, runtime, and apps fit together.
- [Domain model](https://familyco.mintlify.app/concepts/domain-model.md): Core entities, relationships, and invariants in FamilyCo.
- [Runtime and queue](https://familyco.mintlify.app/concepts/runtime-and-queue.md): How agent runs, tool calls, and tasks flow through the in-process queue.
- [Skills standard](https://familyco.mintlify.app/concepts/skills-standard.md): How skills are stored, discovered, enabled, and used in FamilyCo.
- [Developer setup](https://familyco.mintlify.app/development.md): Run the FamilyCo monorepo locally for development.
- [Coding rules](https://familyco.mintlify.app/guides/coding-rules.md): Conventions for AI agents and human contributors.
- [Configuration](https://familyco.mintlify.app/guides/configuration.md): Environment variables for runtime, storage, queue, and authentication.
- [Contributing](https://familyco.mintlify.app/guides/contributing.md): Branching, validation gates, and PR expectations.
- [Prompt playbook for AI coding](https://familyco.mintlify.app/guides/prompt-playbook.md): Reusable prompts that keep AI coding aligned with FamilyCo docs.
- [Welcome to FamilyCo](https://familyco.mintlify.app/index.md): Run your own AI family business — agents that plan, delegate, execute, and report.
- [Agents](https://familyco.mintlify.app/modules/agents.md): Manage your AI workforce — Executive, Manager, and Worker agents.
- [Audit log](https://familyco.mintlify.app/modules/audit-log.md): Append-only record of every meaningful action across modules.
- [Auth and access control](https://familyco.mintlify.app/modules/auth.md): API keys, JWT tokens, and level-based route gating.
- [Automation (cron)](https://familyco.mintlify.app/modules/automation.md): Recurring agent runs with schedule validation and run history.
- [Budget](https://familyco.mintlify.app/modules/budget.md): Track tokens, cost, and caps across agents, projects, and runs.
- [Chat](https://familyco.mintlify.app/modules/chat.md): The Founder's command center — directives, sessions, and structured replies.
- [Engine and queue](https://familyco.mintlify.app/modules/engine.md): Inspect queued jobs, list agent runs, and force-trigger heartbeats.
- [Inbox](https://familyco.mintlify.app/modules/inbox.md): Approvals, clarifications, and reports — the Founder's queue.
- [Knowledge](https://familyco.mintlify.app/modules/knowledge.md): Upload, index, and retrieve internal documents for agent context.
- [Plugins](https://familyco.mintlify.app/modules/plugins.md): Discover, enable, and govern plugins that contribute tools and skills.
- [Projects](https://familyco.mintlify.app/modules/projects.md): Group related work, assign owners, and protect defaults.
- [Provider connections](https://familyco.mintlify.app/modules/providers.md): Connect AI providers, pick a primary, and select default models.
- [Settings](https://familyco.mintlify.app/modules/settings.md): Company profile, appearance, defaults, and approval guardrails.
- [Skills](https://familyco.mintlify.app/modules/skills.md): Discover, enable, and inspect agent skills.
- [Tasks](https://familyco.mintlify.app/modules/tasks.md): Atomic units of work with dependencies, readiness rules, and approvals.
- [Tools](https://familyco.mintlify.app/modules/tools.md): Built-in and plugin-provided tools, with policy-driven enablement.
- [Quickstart](https://familyco.mintlify.app/quickstart.md): Install FamilyCo and run your first directive in minutes.

## OpenAPI Specs

- [openapi](https://familyco.mintlify.app/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/omaicode/familyco)
- [Releases](https://github.com/omaicode/familyco/releases)