Skip to Content
We are live but in Staging 🎉
WorkflowsK3 Workflows

K3 Workflows

Last validated: 2026-05-14

This workflow guide is split into scenario-focused files with complete command/API examples.

Start Here

  1. Prerequisites and Shared Setup
    • Environment variables, helper commands, and baseline checks.
  2. Source to Ingest Pipeline Flow
    • Bucket + source + pipeline + rule + discovery/ingest job flow.
  3. Vector Search Lifecycle
    • Engine setup, collection creation, search, and external vector write path.
  4. Table Lifecycle and SQL Flow
    • Engine, table creation, data writes, SQL, maintenance, and compaction.
  5. OAuth Source Onboarding
    • OAuth URL, code exchange, source setup, and first sync.
  6. Object Access and Sharing
    • Upload/list/show/remove and temporary download URL usage.
  7. Operations Checklist
    • Health/readiness checks and common incident triage paths.

Workflow Philosophy

Each workflow shows:

  1. Goal and when to use it.
  2. Required inputs.
  3. CLI-first steps with API fallback where CLI coverage is partial.
  4. Expected outcomes and troubleshooting notes.

For API detail per endpoint, see 04-api-reference.md. For CLI command reference, see 05-cli-guide.md.