Get build summary

OpenAPI contract

Method

GET

Path

/api/v1/builds/summary

Security

jwtBearer (bearer) OR automationKey (bearer)

Response status

200 400 401 403 404 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Build summary",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/CompileSummaryResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested build was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "HTTP rate limit or API-key NCU usage limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RateLimitError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

Get aggregate counts for the authenticated user's tasks with a JWT or an nfy_ key carrying build:read. The summary separates successful work, failed work (including cancellations), and active pending/running work, plus the total.

Use it for a compact dashboard indicator, not as a substitute for listing or polling individual tasks. Counts are owner-scoped and reflect the service's current records, including drafts where they have not been removed.