Skip to main content
GET
/
v1
/
models
/
{modelId}
/
validate
Validate model
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/validate \
  --header 'Authorization: Bearer <token>'
[
  {
    "message": "No view \"blob_sales\". Set base_view to a valid, existing view.",
    "is_warning": false,
    "yaml_path": "blob_sales.topic",
    "auto_fix": {
      "description_short": "Delete topic \"blob_sales\"",
      "description_unique": "Delete topic \"blob_sales\""
    }
  }
]

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.

Query Parameters

​
branchId
string<uuid>

The ID of the branch to validate. The branch must exist for the model. If not provided, the model is validated directly. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

Note: Schema models do not support branches.

Response

A list of validation issues.

​
message
string

The validation issue message.

​
is_warning
boolean

If true, the issue is a warning. If false, the issue is an error.

​
yaml_path
string

The path to the YAML file containing the issue.

​
auto_fix
object

Information about automatic fixes available for the issue.