---
title: "Get Build"
method: GET
path: "/api/v1/pipeline_builds/{build_id}"
tags: ["builds"]
---

# Get Build

`GET /api/v1/pipeline_builds/{build_id}`

## Request

- The document declares no server URL.
- Auth: OAuth 2
  - Password
  - Token URL: `/api/v1/login`
- TypeScript: <https://skmtc.dev/zenml-io/apis/zenml/docs/api/v1/pipeline_builds/:build_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets a specific build using its unique id.

Args:
    build_id: ID of the build to get.
    hydrate: Flag deciding whether to hydrate the output model(s)
        by including metadata fields in the response.

Returns:
    A specific build object.

## Path parameters

- `build_id` string, uuid, required

## Query parameters

- `hydrate` boolean

## Response `200`

Successful Response

- PipelineBuildResponse: Response model for pipeline builds.
  - `body` PipelineBuildResponseBody: Response body for pipeline builds.
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `user` UserResponse: Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
      - `body` UserResponseBody: Response body for users.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `active` boolean
        - `activation_token` string, nullable
        - `full_name` string
        - `email_opted_in` boolean, nullable: `null` if not answered, `true` if agreed, `false` if skipped.
        - `is_service_account` boolean, required
        - `is_admin` boolean, required
      - `metadata` UserResponseMetadata: Response metadata for users.
        - `email` string, nullable
        - `external_user_id` string, uuid, nullable
        - `user_metadata` object
      - `resources` UserResponseResources: Class for all resource models associated with the user entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
  - `metadata` PipelineBuildResponseMetadata: Response metadata for pipeline builds.
    - `workspace` WorkspaceResponse, required: Response model for workspaces.
      - `body` WorkspaceResponseBody: Response body for workspaces.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` WorkspaceResponseMetadata: Response metadata for workspaces.
        - `description` string
      - `resources` WorkspaceResponseResources: Class for all resource models associated with the workspace entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `pipeline` PipelineResponse: Response model for pipelines.
      - `body` PipelineResponseBody: Response body for pipelines.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse: Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody: Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable: `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata: Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources: Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `latest_run_id` string, uuid, nullable
        - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached': Enum that represents the current status of a step or pipeline run.
      - `metadata` PipelineResponseMetadata: Response metadata for pipelines.
        - `workspace` WorkspaceResponse, required: Response model for workspaces.
          - `body` WorkspaceResponseBody: Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata: Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources: Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `description` string, nullable
      - `resources` PipelineResponseResources: Class for all resource models associated with the pipeline entity.
        - `tags` TagResponse[], required
          - `body` TagResponseBody: Response body for tags.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue': All possible color variants for frontend.
            - `tagged_count` integer, required: The count of resources tagged with this tag.
          - `metadata` BaseResponseMetadata: Base metadata model. Used as a base class for all metadata models associated with responses.
          - `resources` TagResponseResources: Class for all resource models associated with the tag entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required: The unique title of the tag.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `stack` StackResponse: Response model for stacks.
      - `body` StackResponseBody: Response body for stacks.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `user` UserResponse: Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
          - `body` UserResponseBody: Response body for users.
            - `created` string, date-time, required
            - `updated` string, date-time, required
            - `active` boolean
            - `activation_token` string, nullable
            - `full_name` string
            - `email_opted_in` boolean, nullable: `null` if not answered, `true` if agreed, `false` if skipped.
            - `is_service_account` boolean, required
            - `is_admin` boolean, required
          - `metadata` UserResponseMetadata: Response metadata for users.
            - `email` string, nullable
            - `external_user_id` string, uuid, nullable
            - `user_metadata` object
          - `resources` UserResponseResources: Class for all resource models associated with the user entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
      - `metadata` StackResponseMetadata: Response metadata for stacks.
        - `workspace` WorkspaceResponse, required: Response model for workspaces.
          - `body` WorkspaceResponseBody: Response body for workspaces.
            - `created` string, date-time, required
            - `updated` string, date-time, required
          - `metadata` WorkspaceResponseMetadata: Response metadata for workspaces.
            - `description` string
          - `resources` WorkspaceResponseResources: Class for all resource models associated with the workspace entity.
          - `id` string, uuid, required
          - `permission_denied` boolean
          - `name` string, required
        - `components` object, required
        - `description` string, nullable
        - `stack_spec_path` string, nullable
        - `labels` object, nullable
      - `resources` StackResponseResources: Class for all resource models associated with the stack entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `images` object
    - `zenml_version` string, nullable
    - `python_version` string, nullable
    - `checksum` string, nullable
    - `stack_checksum` string, nullable
    - `is_local` boolean, required
    - `contains_code` boolean, required
  - `resources` PipelineBuildResponseResources: Class for all resource models associated with the pipeline build entity.
  - `id` string, uuid, required
  - `permission_denied` boolean

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/zenml-io/apis/zenml.md) - [All operations](https://skmtc.dev/zenml-io/apis/zenml/llms.txt) - [OpenAPI document](https://skmtc.dev/zenml-io/apis/zenml/revisions/abe684261209?raw)