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

# Get a release

> A release's manifest — each function's version and who approved it, the
rules live at the time — and how a pipeline uses it.

**Required roles**: any role in the workspace



## OpenAPI

````yaml get /api/decisions/{workspace}/releases/{version}
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/decisions/{workspace}/releases/{version}:
    get:
      tags:
        - Decision functions
      summary: Get a release
      description: |-
        A release's manifest — each function's version and who approved it, the
        rules live at the time — and how a pipeline uses it.

        **Required roles**: any role in the workspace
      operationId: get_release_api_decisions__workspace__releases__version__get
      parameters:
        - name: workspace
          in: path
          required: true
          schema:
            type: string
            maxLength: 64
            pattern: ^[a-z0-9][a-z0-9-]{0,63}$
            description: Workspace slug.
            title: Workspace
          description: Workspace slug.
        - name: version
          in: path
          required: true
          schema:
            type: string
            pattern: ^\d{1,6}\.\d{1,6}\.\d{1,6}$
            description: Release version, e.g. 1.4.0.
            title: Version
          description: Release version, e.g. 1.4.0.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseDetail'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ReleaseDetail:
      properties:
        workspace:
          type: string
          title: Workspace
        version:
          type: string
          title: Version
        sequence:
          type: integer
          title: Sequence
        status:
          $ref: '#/components/schemas/ReleaseStatusEnum'
        trigger:
          type: string
          title: Trigger
          default: ''
        package_uri:
          anyOf:
            - type: string
            - type: 'null'
          title: Package Uri
        package_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Package Sha
        package_size:
          anyOf:
            - type: integer
            - type: 'null'
          title: Package Size
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        change:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Change
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Published At
        manifest:
          additionalProperties: true
          type: object
          title: Manifest
        usage:
          type: string
          title: Usage
          description: How a pipeline uses this release.
      type: object
      required:
        - workspace
        - version
        - sequence
        - status
        - created_by
        - created_at
        - manifest
        - usage
      title: ReleaseDetail
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReleaseStatusEnum:
      type: string
      enum:
        - building
        - published
        - failed
      title: ReleaseStatusEnum
      description: Where a workspace release is in being written to S3.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.