Submit a project build

OpenAPI contract

Method

POST

Path

/api/v1/projects/{id}/builds

Security

jwtBearer (bearer) OR automationKey (bearer)

Response status

202 400 401 402 403 404 409 413 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "202": {
      "description": "Build accepted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/CompileTaskResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "402": {
      "description": "Insufficient NCU balance",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested project or build was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "409": {
      "description": "Request conflicts with current project state",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "413": {
      "description": "Upload or expanded archive exceeds a configured limit",
      "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"
        }
      }
    }
  }
}

POST /api/v1/projects/{id}/builds is a non-idempotent multipart operation available to a JWT or an nfy_ key with both project:write and build:write. The caller must have effective build:write capability on the project, and an archived workspace rejects submission. If processorId is supplied, an automation key also needs processor:read. The operation reuses the newest retained source JAR from an earlier build in that project; it does not accept a file. If that source is missing or unavailable, the submission fails.

For platforms, the request wins, then defaultPlatforms, then the service fallback. For features, the request wins, then a caller-owned processorId preset, then defaultFeatures, then the service fallback. Explicit features therefore override a processor preset. skipIrOpt defaults to false; hostingPath is optional. Usage is billed to the project's organization billing owner. Do not automatically retry this POST.

http

POST /api/v1/projects/{id}/builds
Authorization: Bearer <access token>
Content-Type: multipart/form-data

platforms=linux-x86_64
processorId=<owned processor UUID>