> ## 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.

# Attach a notebook reference to an app version

> Attach a notebook in `home/{caller}/` to an app version by reference.

During upserts, if an app version already has a notebook reference, the old notebook reference is overwritten with a new one.
The old notebook still exists in S3, but it's no longer attached to that app version.
NexusOne stores a pointer to the new notebook's S3 key + sha256.



## OpenAPI

````yaml put /api/app/versions/{version_id}/notebook
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/app/versions/{version_id}/notebook:
    put:
      tags:
        - App manager
      summary: Attach a notebook reference to an app version
      description: >-
        Attach a notebook in `home/{caller}/` to an app version by reference.


        During upserts, if an app version already has a notebook reference, the
        old notebook reference is overwritten with a new one.

        The old notebook still exists in S3, but it's no longer attached to that
        app version.

        NexusOne stores a pointer to the new notebook's S3 key + sha256.
      operationId: attach_notebook_api_app_versions__version_id__notebook_put
      parameters:
        - name: version_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Version Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachNotebookRequest'
      responses:
        '200':
          description: Notebook reference attached successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppComponentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden, notebook outside caller's home prefix or wrong app type.
        '404':
          description: Version or notebook not found.
        '409':
          description: App type doesn't support notebook attachment.
        '422':
          description: Notebook isn't a valid `.ipynb` document.
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    AttachNotebookRequest:
      properties:
        s3_key:
          type: string
          title: S3 Key
          description: >-
            Notebook key under the caller's home/{username}/ prefix. Must end in
            .ipynb.
      type: object
      required:
        - s3_key
      title: AttachNotebookRequest
      description: Request body for attaching a notebook reference to an app version.
    AppComponentResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique ID of the app component.
        app_version_id:
          type: string
          format: uuid
          title: App Version Id
          description: ID of the parent app version.
        component_type:
          type: string
          title: Component Type
          description: Type of component.
        properties_json:
          anyOf:
            - type: string
            - type: 'null'
          title: Properties Json
          description: JSON string with component metadata.
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: Username of the creator.
        created_date:
          anyOf:
            - {}
            - type: 'null'
          title: Created Date
          description: Component creation timestamp.
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated By
          description: Username of the last updater.
        updated_date:
          anyOf:
            - {}
            - type: 'null'
          title: Updated Date
          description: Timestamp when the component was last updated.
      type: object
      required:
        - id
        - app_version_id
        - component_type
      title: AppComponentResponse
      description: Response model for app component details.
    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
  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

````