Projects

Validate commands

Dry-run a command batch against the current document and get back per-command results and layout lint, without saving anything. Needs only a read scope.

Read the lint. Numeric x/y/fontSize choices routinely overlap on the real canvas, and this is cheaper than a render to find out.

post/projects/{id}/validate

Request

  • Base URL: https://api.vidmoat.com/v1
  • URL: https://api.vidmoat.com/v1/projects/{id}/validate
  • Auth: HTTP bearer

Path parameters

idstring required

The project id.

Request body

commandsobject[] required

One to 200 commands, applied in order. Each is an object with a string op and that op's parameters, exactly as listed by GET /v1/schema/commands.

Response

Validate commands

projectIdstring

The project.

validboolean

Every command would succeed.

blockedstring[]

Plan-gated features that would be dropped.

suggestedPreviewTimesnumber[]

Timestamps worth looking at with the preview endpoint before you render.

appliedboolean

Always false.

Changes

No recorded changes to this operation across all 1 revision of this API.