Retrieves a single extracted drawing region by its ID. The response includes the region’s bounding box (normalized coordinates), the text Plangrep extracted from within that area, its parent sheet and file references, and any artifact URLs generated during processing.
Endpoint GET https://plangrep.com/api/open/v1/projects/{projectId}/regions/{regionId}
Path Parameters The unique identifier of the project that owns the region.
The unique identifier of the region to retrieve.
Query Parameters When true, artifact URL fields are stripped from the response.
Comma-separated list of sheet IDs. Can be used to validate that this region belongs to an expected set of sheets.
Optional filter — returns the region only if it belongs to this sheet.
Optional filter by parent file ID.
Optional case-insensitive substring match on the parent file name.
Optional filter by parent file classification. One of: plans, specifications, documents, addenda, mixed, other.
Optional filter — returns the region only if it is on this 1-based page number.
Optional filter by detected region type.
Optional filter by drawing discipline or type.
Optional filter by layout classification of the region.
Response Returns an object containing the matching region entity.
The requested drawing region entity. Show ProjectRegionEntity fields
Unique identifier for this region.
ID of the sheet this region was detected on.
1-based page number within the source file.
Sheet number of the parent sheet.
Human-readable label assigned to this region.
Text extracted from this region. Always present; returns an empty string "" if no text was detected.
Normalized bounding box for the region (values in [0, 1] relative to page dimensions). Left edge, normalized to page width.
Top edge, normalized to page height.
Right edge, normalized to page width.
Bottom edge, normalized to page height.
Normalized bounding box for the region’s title/label area. Same structure as displayBox. May be null.
Array of artifact objects with URLs to derived outputs. Omitted when compact=true.
Example Request curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/regions/region_001" \ -H "Authorization: Bearer YOUR_API_TOKEN"
Example Response { "region" : { "regionId" : "region_001" , "fileId" : "file_001" , "sheetId" : "sheet_007" , "fileName" : "Architectural_Plans_SetA.pdf" , "pageNumber" : 12 , "sheetNumber" : "A5.01" , "label" : "DETAIL 3/A5.01" , "text" : "CONT. BEAD OF SEALANT AT ALL EDGES. SEE SPEC 07900." , "displayBox" : { "left" : 0.52 , "top" : 0.31 , "right" : 0.74 , "bottom" : 0.58 }, "titleDisplayBox" : { "left" : 0.52 , "top" : 0.58 , "right" : 0.74 , "bottom" : 0.62 }, "artifacts" : [ { "type" : "region_crop" , "url" : "https://..." } ] } }
