# Catalyzed Documentation

> Complete API documentation for the Catalyzed data platform.

## How to Navigate

1. **Start here** - Review the sitemap below to understand what's available
2. **Fetch pages as markdown** - Append `.md` to any page URL
   - Example: `https://docs.catalyzed.ai/getting-started/introduction.md`
3. **Recommended starting point**: `/getting-started/introduction.md`

## Common Workflows

**New to Catalyzed? Start here:**
- `/getting-started/quickstart.md` → `/concepts/datasets.md` → `/concepts/tables.md` → `/guides/ingesting-data.md` → `/guides/querying-data.md`

**Working with files:**
- `/guides/file-processing.md` → `/concepts/files.md`

**Creating pipelines:**
- `/concepts/pipelines.md` → `/concepts/executions.md`

**Setting up vector search:**
- `/concepts/knowledge-bases.md` → `/guides/vector-search.md` → `/guides/knowledge-base-reconciliation.md`

**Building evaluation workflows:**
- `/concepts/example-sets.md` → `/concepts/examples.md` → `/concepts/evaluations.md` → `/guides/evaluation-workflow.md`

**Implementing feedback loops:**
- `/concepts/signals.md` → `/concepts/synthesis.md` → `/guides/feedback-loops.md`

**Optimizing query performance:**
- `/guides/query-optimization.md` → `/concepts/tables.md` → `/guides/querying-data.md`

## Available Pages

### Getting Started (start here)

- /getting-started/api-tokens.md - API Tokens - Create and manage API tokens for programmatic access to the Catalyzed API.
- /getting-started/authentication.md - Authentication - Learn how to authenticate with the Catalyzed API using API tokens or session tokens.
- /getting-started/introduction.md - Introduction - Welcome to the Catalyzed API documentation. Learn how to integrate with our data platform to organize, query, and automate your data workflows.
- /getting-started/quickstart.md - Quickstart - Get up and running with the Catalyzed API in 5 minutes.

### Core Concepts

- /concepts/architecture.md - Architecture Overview - High-level architecture of the Catalyzed platform and how components work together.
- /concepts/datasets.md - Datasets - Understanding datasets in Catalyzed - containers for organizing related tables within a team.
- /concepts/evaluations.md - Evaluations - Understanding evaluations in Catalyzed - measuring pipeline quality against ground truth examples.
- /concepts/example-sets.md - Example Sets - Understanding example sets in Catalyzed - collections of ground truth data for evaluating pipeline quality.
- /concepts/examples.md - Examples - Understanding examples in Catalyzed - individual ground truth input/output pairs for pipeline evaluation.
- /concepts/executions.md - Executions - Understanding pipeline executions in Catalyzed - monitoring, tracking progress, and handling results.
- /concepts/files.md - Files - Understanding files in Catalyzed - uploading, processing, and managing data files.
- /concepts/knowledge-bases.md - Knowledge Bases - Understanding Knowledge Bases in Catalyzed - semantic search indexes for files and dataset tables with graph-based retrieval.
- /concepts/pipelines.md - Pipelines - Understanding pipelines in Catalyzed - automated workflows for data processing and AI-powered tasks.
- /concepts/signals.md - Signals - Understanding signals in Catalyzed - capturing expert feedback to improve pipeline performance.
- /concepts/synthesis.md - Synthesis Runs - Understanding synthesis runs in Catalyzed - LLM-driven pipeline improvements based on expert feedback.
- /concepts/tables.md - Tables - Understanding tables in Catalyzed - schema-defined data storage with SQL querying, indexes, and schema evolution.
- /concepts/teams.md - Teams - Understanding teams in Catalyzed - the multi-tenancy boundary for organizing resources and collaboration.

### Guides

- /guides.md - Guides - Step-by-step guides for common tasks in Catalyzed.
- /guides/billing-credits.md - Billing & Credits - Understand the credit system, usage tracking, and billing in Catalyzed.
- /guides/citations.md - Citations - Understanding citations in Catalyzed - how to access, resolve, and display source document references from pipeline executions.
- /guides/evaluation-workflow.md - Evaluation Workflow - End-to-end guide for evaluating pipeline quality using example sets and evaluations.
- /guides/feedback-loops.md - Feedback Loops - End-to-end guide for capturing expert feedback and using it to improve pipeline performance.
- /guides/file-processing.md - File Processing - Upload and process PDFs, CSVs, and documents in Catalyzed.
- /guides/ingesting-data.md - Ingesting Data - Write rows to dataset tables using JSON or Arrow IPC with append, upsert, overwrite, and delete modes.
- /guides/knowledge-base-reconciliation.md - Knowledge Base Reconciliation - Keep Knowledge Bases current with automatic and manual reconciliation when source data changes.
- /guides/promoting-executions.md - Promoting Executions to Examples - Guide for building example sets from verified production pipeline executions.
- /guides/query-optimization.md - Query Optimization - Optimize query performance in Catalyzed with indexes, statistics, compaction, and query tuning strategies.
- /guides/querying-data.md - Querying Data - SQL syntax, joins, aggregations, and performance tips for querying data in Catalyzed.
- /guides/schema-management.md - Schema Management - Evolve table schemas safely with migrations and version tracking.
- /guides/vector-search.md - Vector Search - Semantic similarity search using knn_search and text_to_embedding for finding similar documents, products, or any embedded content.

### API Reference

- /api-reference.md - API Reference - Complete REST API documentation for the Catalyzed data platform.