Skip to main content

Documentation Index

Fetch the complete documentation index at: https://familyco.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Engine module exposes runtime control surfaces. Use it to inspect what the queue is doing, drill into agent runs, and recover from edge cases.

Views

  • Pending queue jobs
  • Agent run list with filters: state, trigger type, root agent
  • Agent run detail
  • Heartbeat status / trigger controls

Actions

  • Enqueue an agent run
  • Enqueue a tool execution
  • Force-trigger heartbeat poll

Constraints

  • The daily quota guard consumes usage before enqueue.
  • The approval guard may return approvalRequired instead of an immediate enqueue.
  • Queue lanes must support agent.run, tool.execute, and task.execute.

Run lifecycle

queued → planning → waiting_approval | executing → completed | failed | cancelled
AgentRun.triggerType records why the run started:
triggerTypeSource
founder_chatFounder sent a directive in chat.
task_executionA task became ready and was scheduled.
retryRetry of a failed run.
approval_resumeFounder resolved an approval/clarification.
scheduleCron or heartbeat scheduler.
See Runtime and queue for concurrency, guards, and read-only mode behavior.