Models

Refresh model schema

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/models/{modelId}/refresh
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

Model UUID

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

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
hard_refresh'true' | 'false'

When true (the default), performs a hard refresh that fully rebuilds the schema model, removing entities the warehouse no longer has. When false, performs a soft refresh that merges newly generated views with the existing model and never removes. With schemas or tables filters, a hard refresh is scoped: it rebuilds — removals included — only inside the selection and leaves the rest of the model untouched.

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. Unless hard_refresh=false, entities inside the selection that the warehouse no longer has are removed; pass hard_refresh=false to only add and update.

Example:public,analytics
tablesstring

Optional comma-separated list of tables to refresh selectively. Only the listed tables are reloaded; the rest of the schema model is preserved. Unless hard_refresh=false, entities inside the selection that the warehouse no longer has are removed; pass hard_refresh=false to only add and update.

Example:public.orders,public.customers

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

Changes

No recorded changes to this operation across all 97 revisions of this API.