> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a build

> Request cancellation of a build and return 202 Accepted.

Cancellation runs asynchronously: the endpoint verifies the build exists and then hands it off to a
background workflow that marks the build as cancelling, asks the cloud build provider to stop it, and
polls until the build reaches a terminal state before recording the final status. Only builds that are
still queued or running are actually cancelled; if the build has already finished, or cancellation is
already in progress, the request is still accepted but has no effect. The returned record reflects the
build's state at the time of the call, so it will not yet show the pending cancellation. The request
is rejected if no such build exists for the caller's account.



## OpenAPI

````yaml https://api.sgp.scale.com/openapi-versions/v5/openapi.json post /v5/builds/{build_id}/cancel
openapi: 3.1.0
info:
  title: EGP API V5
  description: >-
    This is the parent API for all EGP APIs. If you are looking for the EGP API,
    please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
  - url: https://api.egp.scale.com
security: []
paths:
  /v5/builds/{build_id}/cancel:
    post:
      tags:
        - Agentex Cloud Build
      summary: Cancel a build
      description: >-
        Request cancellation of a build and return 202 Accepted.


        Cancellation runs asynchronously: the endpoint verifies the build exists
        and then hands it off to a

        background workflow that marks the build as cancelling, asks the cloud
        build provider to stop it, and

        polls until the build reaches a terminal state before recording the
        final status. Only builds that are

        still queued or running are actually cancelled; if the build has already
        finished, or cancellation is

        already in progress, the request is still accepted but has no effect.
        The returned record reflects the

        build's state at the time of the call, so it will not yet show the
        pending cancellation. The request

        is rejected if no such build exists for the caller's account.
      operationId: POST-V5-/builds/build_id/cancel
      parameters:
        - name: build_id
          in: path
          required: true
          schema:
            type: string
            title: Build Id
        - name: x-selected-account-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account ID Header
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentexCloudBuild'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    AgentexCloudBuild:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the entity.
        object:
          type: string
          const: agentex_cloud_build
          title: Object
          default: agentex_cloud_build
        cloud_provider_build_id:
          type: string
          title: Cloud Provider Build Id
          description: >-
            The unique identifier of the build from the cloud provider, or an
            internal UUID when an existing image is copied without a provider
            build.
        agent_name:
          type: string
          title: Agent Name
          description: The name of the agent that this build belongs to
        agent_id:
          title: Agent Id
          description: The UUID of the agent that this build belongs to
          type: string
        image_name:
          type: string
          title: Image Name
          description: The name of the container image to build.
        image_tag:
          type: string
          title: Image Tag
          description: The tag for the container image.
        image_url:
          title: Image Url
          description: >-
            The URL of the container image. This is not guaranteed to be present
            until the build is complete.
          type: string
        build_status:
          $ref: '#/components/schemas/AgentexCloudBuildStatus'
          description: The current build lifecycle status
        build_start_time:
          title: Build Start Time
          description: When the cloud provider started the build
          type: string
          format: date-time
        build_end_time:
          title: Build End Time
          description: When the cloud provider finished the build
          type: string
          format: date-time
        source_repo:
          title: Source Repo
          description: >-
            Normalized git remote the build context came from (host/path, no
            credentials).
          anyOf:
            - type: string
            - type: 'null'
        source_commit:
          title: Source Commit
          description: Git commit the build context was at, when a git work tree.
          anyOf:
            - type: string
            - type: 'null'
        source_ref:
          title: Source Ref
          description: Git branch or tag for source_commit, when resolvable.
          anyOf:
            - type: string
            - type: 'null'
        source_subpath:
          title: Source Subpath
          description: >-
            Build-context path relative to the repo root (which agent, in a
            monorepo).
          anyOf:
            - type: string
            - type: 'null'
        working_tree_hash:
          title: Working Tree Hash
          description: >-
            Deterministic SHA-256 content hash of the build inputs (not the
            tarball).
          anyOf:
            - type: string
            - type: 'null'
        source_dirty:
          title: Source Dirty
          description: >-
            Whether the work tree had uncommitted changes at build time (null
            outside git).
          anyOf:
            - type: boolean
            - type: 'null'
        account_id:
          type: string
          title: Account Id
          description: The ID of the account that owns the given entity.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when the entity was created in ISO format.
        created_by:
          $ref: '#/components/schemas/Identity'
          description: The identity that created the entity.
      type: object
      required:
        - cloud_provider_build_id
        - agent_name
        - image_name
        - image_tag
        - build_status
        - source_repo
        - source_commit
        - source_ref
        - source_subpath
        - working_tree_hash
        - source_dirty
        - id
        - account_id
        - created_at
        - created_by
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentexCloudBuildStatus:
      type: string
      enum:
        - queued
        - running
        - success
        - failed
        - cancelling
        - cancelled
        - deleting
        - delete_failed
        - timed_out
        - error
        - unknown
      title: AgentexCloudBuildStatus
    Identity:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: identity
          title: Object
          default: identity
        type:
          $ref: '#/components/schemas/IdentityType'
      type: object
      required:
        - id
        - type
      title: Identity
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    IdentityType:
      type: string
      enum:
        - user
        - service_account
      title: IdentityType
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````