Skip to main content
POST
/
v1
/
models
/
{modelId}
/
refresh
Refresh schema
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/refresh \
  --header 'Authorization: Bearer <token>'
{
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
modelId
string<uuid>
required

The ID of the model to be refreshed.

Query Parameters

​
branch_id
string<uuid>

Required if Branch-based schema refresh is enabled. The ID of the branch for models with this setting enabled.

Do not provide this parameter when the setting is not enabled.

Response

Model refresh started

​
modelId
string<uuid>

ID of the model.

​
status
string

Status of the schema refresh. This value will be running to indicate that the refresh has started.

Example:

"running"