Vai al contenuto principale

Check a folder without saving a version

POST 

/artifacts/check

A dry run of what a push or a create would store: the folder goes through the same rules as a push (paths, sizes, credential-shaped text, agent and editor setting names, packages) and then through a full build and render of every page. Answers whether it builds, the findings with file, line and column, source-quality advice, AI look warnings and screenshots for up to eight pages. A page can declare a query or fragment to append to its entry path with a copera-check-route meta tag in its head. Without a valid declaration, a non-default page uses the first eligible link from the rendered default page. No Design, version, build record or asset is created. An optional idempotencyKey replays the stored answer for the same request for ten minutes, except a refunded refusal is processed again. A different input with the same key answers 409. Send JSON for text and already pinned assets, or multipart/form-data with the same JSON in a project field and at most 128 file parts for new assets. Set each filename to its project-relative path. New files follow the direct upload path, type and size rules and must fit the asset budget with the pinned files. Multipart permits 10.5 MiB of project metadata, 256 MiB of assets and 268 MiB total within 120 seconds or it answers 408. The JSON may weigh up to 10.5 MiB, like a push. Requests that exceed the transport size limits answer 413. A check takes the build service's one slot, so it counts like a push against the same budget before the body is parsed. When the budget is used up the answer is 429 with Retry-After and reason check_budget; when the build service is busy, being updated or too slow, or the budget cannot be read, the answer is 503 with its reason and retryAfterSeconds. A busy or unavailable builder, including an upstream 502 or 504 before a build ran, returns the budget unit. Invalid inputs and replays spend a unit. A builder refusal of the source answers 400 with reason builder_rejected_source and a bounded message. Needs a token with the Designs permission.

Request​

Responses​

Default Response