# Synthbrew

## Docs

- [Claude Code setup](https://synthbrew.com/docs/ai-tools/claude-code.md): Configure Claude Code to use Synthbrew through the MCP server.
- [Codex setup](https://synthbrew.com/docs/ai-tools/codex.md): Configure Codex to use Synthbrew through the MCP server.
- [Cursor setup](https://synthbrew.com/docs/ai-tools/cursor.md): Configure Cursor to use Synthbrew through the MCP server.
- [Synthbrew agent setup](https://synthbrew.com/docs/ai-tools/synthbrew-agent.md): Use Synthbrew from MCP-capable agents with @synthbrew/agent.
- [Windsurf setup](https://synthbrew.com/docs/ai-tools/windsurf.md): Configure Windsurf to use Synthbrew through the MCP server.
- [Create Project](https://synthbrew.com/docs/api-reference/endpoint/public-v1/projects-create.md): Creates a new project in the API key team. Project-scoped keys cannot create projects.
- [Delete Project](https://synthbrew.com/docs/api-reference/endpoint/public-v1/projects-delete.md)
- [Get Project By ID](https://synthbrew.com/docs/api-reference/endpoint/public-v1/projects-get-by-id.md)
- [List Projects](https://synthbrew.com/docs/api-reference/endpoint/public-v1/projects-list.md)
- [Update Project](https://synthbrew.com/docs/api-reference/endpoint/public-v1/projects-update.md)
- [Validate Schema Config](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schema-config-validate.md): Validates a canonical Synthbrew schemaVersionConfig v1 without creating resources.
- [Get Schema Version](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schema-versions-get-by-id.md)
- [List Schema Versions](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schema-versions-list.md)
- [Create Schema](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schemas-create.md)
- [Delete Schema](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schemas-delete.md)
- [Get Schema By ID](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schemas-get-by-id.md)
- [List Schemas](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schemas-list.md)
- [Update Schema](https://synthbrew.com/docs/api-reference/endpoint/public-v1/schemas-update.md)
- [Create Source API Key](https://synthbrew.com/docs/api-reference/endpoint/public-v1/source-api-keys-create.md): Creates a runtime source API key and returns the secret once.
- [List Source API Keys](https://synthbrew.com/docs/api-reference/endpoint/public-v1/source-api-keys-list.md): Returns source API key metadata. Secret key values are never returned by list operations.
- [Get Source Runtime Docs](https://synthbrew.com/docs/api-reference/endpoint/public-v1/source-runtime-docs.md): Returns machine-readable runtime API details for a source.
- [Get Source Sample Data](https://synthbrew.com/docs/api-reference/endpoint/public-v1/source-sample-data.md): Returns a small page of rows from a generated source table using a team API key.
- [Create Source](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-create.md)
- [Delete Source](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-delete.md)
- [List Source Generation Events](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-generation-events.md): Returns generation events ordered by newest first.
- [Get Source Generation Job Status](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-generation-job-status.md): Returns queue job status for a previously triggered generation run. Use this when create/regenerate responses include generationJob.
- [Get Source By ID](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-get-by-id.md)
- [List Sources](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-list.md)
- [Regenerate Source](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-regenerate.md): Triggers source regeneration immediately (inline mode) or enqueues a background job (queue mode). Optional overrides let you change version/seed/generator settings for this run.
- [Update Source](https://synthbrew.com/docs/api-reference/endpoint/public-v1/sources-update.md)
- [Create Runtime Record](https://synthbrew.com/docs/api-reference/endpoint/runtime/create-record.md): Inserts a record into the target table and returns the inserted row.
- [Delete Runtime Record](https://synthbrew.com/docs/api-reference/endpoint/runtime/delete-record.md): Deletes a single row by primary-key value.
- [Get Runtime Record By ID](https://synthbrew.com/docs/api-reference/endpoint/runtime/get-record-by-id.md): Returns a single row by primary-key value from the requested table.
- [List Runtime Records](https://synthbrew.com/docs/api-reference/endpoint/runtime/list-records.md): Returns paginated records for a table inside a source. Supports field projection, sorting, filters, and relation population. For backward compatibility, unknown top-level query keys are treated as equality filters.
- [Update Runtime Record](https://synthbrew.com/docs/api-reference/endpoint/runtime/update-record.md): Partially updates a row by primary key and returns the updated row.
- [Runtime API](https://synthbrew.com/docs/api-reference/introduction.md): How to authenticate and query source data through Synthbrew runtime endpoints.
- [Public API v1](https://synthbrew.com/docs/api-reference/public-v1.md): Authenticate with team API keys and manage projects, schemas, and sources through /public/v1 endpoints.
- [Import PostgreSQL schema SQL](https://synthbrew.com/docs/guides/import-postgres-schema-sql.md): Export PostgreSQL schema SQL and import it into Synthbrew as a draft schema.
- [Supabase integration](https://synthbrew.com/docs/guides/supabase.md): Import Supabase schemas and generate synthetic data into a dedicated Supabase schema.
- [Introduction](https://synthbrew.com/docs/index.md): Schema to realistic data and runtime APIs for frontend and product teams.
- [Quickstart](https://synthbrew.com/docs/quickstart.md): Use a source API key to call Synthbrew runtime CRUD endpoints.

## OpenAPI Specs

- [openapi](https://synthbrew.com/docs/api-reference/openapi.json)

## Optional

- [Homepage](https://synthbrew.com)