Flock API

These endpoints are served by the Flock Bridge sidecar on localhost:5102. The Bridge listens only on loopback for the signed-in user, so the routes are unauthenticated locally. Flock itself is a Pro feature and requires a Pidgeon account.

POST /api/flock/connect

Connect to a database and analyze its schema.

Field	Type	Description
`provider`	string	`postgres`, `sqlserver`, `mysql`
`connectionString`	string	Database connection string

curl

curl -X POST http://localhost:5102/api/flock/connect \
  -H "Content-Type: application/json" \
  -d '{"provider": "postgres", "connectionString": "Host=localhost;Port=5432;Database=ehr;Username=dev;Password=${DB_PASSWORD}"}'

GET /api/flock/schema

Get the analyzed schema from the last connection.

curl

curl http://localhost:5102/api/flock/schema

POST /api/flock/learn

Learn statistical distributions from existing rows.

Field	Type	Default	Description
`sampleSize`	int	`500`	Rows to sample per table

curl

curl -X POST http://localhost:5102/api/flock/learn \
  -H "Content-Type: application/json" \
  -d '{"sampleSize": 500}'

GET /api/flock/profiles

List learned profiles.

curl

curl http://localhost:5102/api/flock/profiles

GET /api/flock/profiles/

Get a specific profile.

curl

curl http://localhost:5102/api/flock/profiles/ehr_production

POST /api/flock/generate

Start a generation job. Returns a job ID for polling.

Field	Type	Default	Description
`count`	int	`1000`	Number of patients
`format`	string	`"sql"`	`sql`, `csv`, `hl7`, `fhir`, `pas-bundle`
`geographicFocus`	string	null	Geographic focus (for example a state abbreviation)
`seed`	int	null	Reproducible seed
`profile`	string	null	Learned data profile name

curl

curl -X POST http://localhost:5102/api/flock/generate \
  -H "Content-Type: application/json" \
  -d '{"count": 1000, "format": "sql", "geographicFocus": "TX"}'

GET /api/flock/generate/

Poll job status.

curl

curl http://localhost:5102/api/flock/generate/job-123

GET /api/flock/generate//analytics

Get analytics for a completed job.

curl

curl http://localhost:5102/api/flock/generate/job-123/analytics

POST /api/flock/seed

Seed the connected database with the generated population.

Field	Type	Default	Description
`connectionString`	string	required	Target database connection
`provider`	string	`postgres`	Database provider

curl

curl -X POST http://localhost:5102/api/flock/seed \
  -H "Content-Type: application/json" \
  -d '{"connectionString": "Host=localhost;Database=ehr;...", "provider": "postgres"}'

POST /api/flock/seed/dry-run

Preview the seed plan without executing.

curl

curl -X POST http://localhost:5102/api/flock/seed/dry-run \
  -H "Content-Type: application/json" \
  -d '{"connectionString": "Host=localhost;Database=ehr;...", "provider": "postgres"}'

DELETE /api/flock/seed/cleanup

Remove all synthetic data from the database.

Query Param	Type	Description
`connectionString`	string	Database connection
`provider`	string	Database provider

curl

curl -X DELETE "http://localhost:5102/api/flock/seed/cleanup?connectionString=Host%3Dlocalhost%3BDatabase%3Dehr&provider=postgres"

GET /api/flock/compliance/

Get the no-PHI attestation for a generation job. It confirms the population is synthetic-only and reports whether any PHI was detected.

curl

curl http://localhost:5102/api/flock/compliance/job-123

Overview

Core APIs

Loft APIs

Flock APIs

Live Updates

POST /api/flock/connect

GET /api/flock/schema

POST /api/flock/learn

GET /api/flock/profiles

GET /api/flock/profiles/

POST /api/flock/generate

GET /api/flock/generate/

GET /api/flock/generate//analytics

POST /api/flock/seed

POST /api/flock/seed/dry-run

DELETE /api/flock/seed/cleanup

GET /api/flock/compliance/

​POST /api/flock/connect

​GET /api/flock/schema

​POST /api/flock/learn

​GET /api/flock/profiles

​GET /api/flock/profiles/

​POST /api/flock/generate

​GET /api/flock/generate/

​GET /api/flock/generate//analytics

​POST /api/flock/seed

​POST /api/flock/seed/dry-run

​DELETE /api/flock/seed/cleanup

​GET /api/flock/compliance/

POST /api/flock/connect

GET /api/flock/schema

POST /api/flock/learn

GET /api/flock/profiles

GET /api/flock/profiles/

POST /api/flock/generate

GET /api/flock/generate/

GET /api/flock/generate//analytics

POST /api/flock/seed

POST /api/flock/seed/dry-run

DELETE /api/flock/seed/cleanup

GET /api/flock/compliance/