v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Models

Refresh model schema

post/api/v1/models/{modelId}/refresh

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

Model UUID

Query parameters

branch_idstring uuid

Branch ID for branch-based schema refresh. Required when branch-based schema refresh is enabled for the connection. Must not be provided when branch-based schema refresh is not enabled.

Example:123e4567-e89b-12d3-a456-426614174001

Branch ID for branch-based schema refresh. Required when branch-based schema refresh is enabled for the connection. Must not be provided when branch-based schema refresh is not enabled.

hard_refresh'true' | 'false'

When true (the default), performs a hard refresh that fully discards and rebuilds the schema model. When false, performs a soft refresh that merges newly generated views with the existing model. Must be set to false when schemas or tables filters are provided.

Example:false

schemasstring

Optional comma-separated list of schemas to refresh selectively. Only the listed schemas are reloaded; the rest of the schema model is preserved. Requires hard_refresh=false.

Example:public,analytics

Optional comma-separated list of schemas to refresh selectively. Only the listed schemas are reloaded; the rest of the schema model is preserved. Requires hard_refresh=false.

tablesstring

Optional comma-separated list of tables to refresh selectively. Only the listed tables are reloaded; the rest of the schema model is preserved. Requires hard_refresh=false.

Example:public.orders,public.customers

Optional comma-separated list of tables to refresh selectively. Only the listed tables are reloaded; the rest of the schema model is preserved. Requires hard_refresh=false.

Response

Refresh job started

jobIdstring required

Job ID for the refresh operation

modelIdstring required

Model ID being refreshed

status'running' | 'completed' | 'failed' required

Current status of the refresh