Skip to main content
Returns a rich, pre-computed summary of a project’s ingested content — including name aliases, title candidates, the most structurally significant source files, detected engineering disciplines, and aggregate entity counts. Use this endpoint to quickly understand what a project contains before querying it in depth.

​
Authentication

Include your API key as Authorization: Bearer YOUR_API_KEY in the request headers.

​
Endpoint

GET https://plangrep.com/api/open/v1/projects/{projectId}/summary

​
Path Parameters

​
projectId
string
required
The unique identifier of the project whose summary you want to retrieve. Returned as project.id from Create Project or List Projects.

​
Example Request

curl --request GET \
  --url https://plangrep.com/api/open/v1/projects/proj_01hx9z4kqr8e7m3p5n6w2v0abc/summary \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

​
Response Fields

​
project
Project
required
The current state of the project. See Get Project for field definitions.
​
projectSummary
ProjectSummary
required
Computed summary data derived from all ingested sources in the project.

​
Example Response

{
  "project": {
    "id": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
    "name": "Downtown Office Tower",
    "projectKind": "open_api",
    "status": "ready",
    "runtime": { "status": "running", "upgradeStatus": "none" },
    "createdAt": "2024-11-01T14:22:10.000Z",
    "updatedAt": "2024-11-01T14:24:05.000Z"
  },
  "projectSummary": {
    "projectId": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
    "projectName": "Downtown Office Tower",
    "aliases": ["DOT-2024", "Tower Block C"],
    "titleCandidates": [
      "Downtown Office Tower — 100 Main Street, Springfield",
      "Office Tower at Main & 1st — Permit Set"
    ],
    "keyFiles": [
      {
        "id": "src_abc123",
        "fileName": "architectural_drawings.pdf",
        "classification": "plans"
      }
    ],
    "detectedDisciplines": ["architectural", "structural", "mechanical", "electrical"],
    "counts": {
      "files": 12,
      "sheets": 204,
      "regions": 3812,
      "specifications": 48,
      "docs": 310,
      "total": 4386
    }
  }
}
The summary is computed incrementally as jobs complete. For projects with ongoing jobs, counts and key files may not reflect the most recently uploaded documents until those jobs reach a terminal status.