> ## Documentation Index > Fetch the complete documentation index at: https://docs.firedrill.run/llms.txt > Use this file to discover all available pages before exploring further. # Begin an explicit immutable build upload ## OpenAPI ````yaml /api-reference/openapi.json post /v1/projects/{projectId}/build-uploads openapi: 3.1.0 info: title: Firedrill Control API version: 1.0.0 description: >- The control plane for drills, drill runs, and the worlds they run in. Errors always carry the canonical envelope; unsafe operations require an Idempotency-Key; long work returns an operation resource. servers: - url: https://api.firedrill.run security: - controlCredential: [] tags: - name: authentication description: Sessions, CLI exchange, credentials, and verification keys. x-group: Authentication - name: organizations description: Organization members, billing, usage, retention, audit, and exports. x-group: Organizations - name: projects description: Project lifecycle, access, grants, and repository bindings. x-group: Projects - name: builds description: Immutable builds, uploads, source drafts, and world definitions. x-group: Builds and source - name: tools description: Project Tool discovery, approval, source, and revocation. x-group: Tool library - name: worlds description: >- Managed environments, world sessions, state, time, reset, faults, forks, and snapshots. x-group: Environments and sessions - name: runs description: >- Hosted runs, comparisons, attachments, reports, evidence bundles, sharing, and exports. x-group: Runs and evidence - name: browser description: Managed browser tests, runs, messages, streams, frames, and artifacts. x-group: Browser testing - name: callbacks description: Callback receiver approval, revocation, and signing material. x-group: Callbacks - name: github-ci description: >- GitHub installations, repository automation, CI suites, cases, evidence, and checks. x-group: GitHub and CI - name: authoring description: Authoring sessions, proposals, turns, and scenario proposals. x-group: Cloud authoring paths: /v1/projects/{projectId}/build-uploads: post: tags: - builds summary: Begin an explicit immutable build upload operationId: buildUploads.begin parameters: - name: projectId in: path required: true schema: type: string pattern: ^prj_[0-9a-z]{12,32}$ - name: Idempotency-Key in: header required: true schema: type: string minLength: 8 maxLength: 128 pattern: ^[A-Za-z0-9._:-]+$ requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BeginBuildUploadRequest' responses: '200': description: Existing build upload content: application/json: schema: $ref: '#/components/schemas/BuildUpload' '201': description: Build upload content: application/json: schema: $ref: '#/components/schemas/BuildUpload' default: description: Canonical error envelope content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: BeginBuildUploadRequest: type: object properties: buildHash: type: string pattern: ^sha256:[0-9a-f]{64}$ artifactDigest: type: string pattern: ^sha256:[0-9a-f]{64}$ bytes: type: integer minimum: 0 exclusiveMinimum: true maximum: 67108864 advanceEnvironmentId: type: string pattern: ^env_[0-9a-z]{12,32}$ expectedEnvironmentVersion: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - buildHash - artifactDigest - bytes additionalProperties: false BuildUpload: type: object properties: schemaVersion: type: number enum: - 1 attempt: type: object properties: schemaVersion: type: number enum: - 1 buildAttemptId: type: string pattern: ^attempt_[0-9a-z]{12,32}$ organizationId: type: string pattern: ^org_[0-9a-z]{12,32}$ projectId: type: string pattern: ^prj_[0-9a-z]{12,32}$ sourceKind: type: string enum: - github - upload - draft sourceDraftId: type: string pattern: ^draft_[0-9a-z]{12,32}$ sourceRevision: type: number enum: - 1 sourceDigest: type: string pattern: ^sha256:[0-9a-f]{64}$ repositoryBindingId: type: string pattern: ^repo_[0-9a-z]{12,32}$ revision: type: string pattern: ^[0-9a-f]{40}$ expectedBuildHash: type: string pattern: ^sha256:[0-9a-f]{64}$ expectedArtifactDigest: type: string pattern: ^sha256:[0-9a-f]{64}$ expectedBytes: type: integer minimum: 0 exclusiveMinimum: true maximum: 67108864 advanceEnvironmentId: type: string pattern: ^env_[0-9a-z]{12,32}$ expectedEnvironmentVersion: type: integer minimum: -9007199254740991 maximum: 9007199254740991 advanceFollowers: default: false type: boolean requestedBy: type: string minLength: 1 maxLength: 255 state: type: string enum: - awaiting_upload - queued - fetching - compiling - verifying - succeeded - failed - cancelled diagnostics: type: array items: type: object additionalProperties: $ref: '#/components/schemas/BuildUpload___schema0' sourceClosure: default: [] maxItems: 2000 type: array items: type: string minLength: 1 maxLength: 1024 buildHash: type: string pattern: ^sha256:[0-9a-f]{64}$ createdAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 updatedAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 finishedAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - schemaVersion - buildAttemptId - organizationId - projectId - sourceKind - advanceFollowers - requestedBy - state - diagnostics - sourceClosure - createdAtMs - updatedAtMs additionalProperties: false method: type: string enum: - PUT uploadUrl: type: string maxLength: 4096 format: uri headers: default: {} type: object additionalProperties: type: string expiresAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - schemaVersion - attempt - method - uploadUrl - headers - expiresAtMs additionalProperties: false ErrorEnvelope: type: object properties: code: type: string pattern: ^(control|world)\.[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ message: type: string minLength: 1 correlationId: type: string minLength: 1 retryable: type: boolean retryAfterMs: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 operationId: type: string source: type: string enum: - platform - simulated_provider issues: type: array items: type: object properties: path: type: string code: type: string message: type: string required: - path - code - message additionalProperties: false details: type: object propertyNames: type: string additionalProperties: {} evidence: type: object properties: sessionId: type: string runId: type: string journalSeq: type: integer minimum: 0 maximum: 9007199254740991 buildHash: type: string additionalProperties: false required: - code - message - correlationId - retryable - source additionalProperties: true BuildUpload___schema0: description: Any JSON-compatible value securitySchemes: controlCredential: type: http scheme: bearer description: Opaque control credential ````