Skip to main content
POST
Check
Regenerates types, then type-checks each app and validates its workflows’ trigger, schedule, and webhook declarations. appId is optional and checks only that app; without it, every app in the workspace is checked. Fix everything it reports before committing.

Authorizations

Authorization
string
header
required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

sessionId
string
required

The build session ID from Open a session.

Body

application/json
appId
string

Optional. Checks only this app. Without it, every app in the workspace is checked.

Example:

"a1b2c3d4e5"

Response

Check result

ok
boolean

True when every checked app type-checks and has no declaration errors.

apps
object[]

One entry per checked app.

diagnostics
string | null

Type-check output across all checked apps. Null when there is none.

endpointErrors
object | null

Invalid trigger, schedule, or webhook declarations, keyed by workflow file path. The build would drop these and publish the app without them.

uncheckedApps
string[] | null

App directories whose type-check didn't finish. Run the check again.