Blueprints / Markups

Export an area of a sheet with its markups as a PDF

Clip & export: a one-page PDF (A4 or Letter) of the boxed area with its markups, a title block, a notes list and a small key plan, as a short-lived download link (url, valid for expires_in seconds). Use it to send one part of a drawing for review. The rest of the sheet stays inside the file, cropped out of view.

409 when the sheet's PDF is not available; 422 for a bad box or a sheet too large to clip (export the whole sheet instead).

post/v1/blueprints/{blueprint_id}/markups/clip

Request

  • Base URL: https://api.kamai.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.kamai.io/v1/blueprints/{blueprint_id}/markups/clip
  • Auth: HTTP bearer

Path parameters

blueprint_idstring required

Request body

boxnumber[] required

[x0, y0, x1, y1], the area to clip, fractions of the page.

page'A4' | 'Letter'

Paper size of the PDF.

notesboolean

Add a notes list: each markup in the area with its Δ number or kind, its text and its room.

key_planboolean

Add a small key plan showing where the area sits on the sheet.

langstring

Language of the PDF's labels: en, he, ar, fr, es or de (others read English); he and ar lay out right to left.

expires_ininteger

Seconds the download link stays valid, 60..3600.

Response

Successful Response

blueprint_idstring required

The sheet.

namestring required

The sheet's label, as printed in the title block of the clip.

urlstring required

A signed download link to the PDF; it stops working after expires_in seconds.

file_namestring required

The PDF's file name.

bytesinteger required

The PDF's size in bytes.

expires_ininteger required

Seconds the link stays valid.

page'A4' | 'Letter' required

The paper size.

markupsinteger required

Markups that fall inside the clipped area.

Changes

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