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

# Pin a version

> Mark a version pinned: it is never purged by retention and its library model cannot be deleted. Send {"pinned": false} to unpin.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/models/{name}/versions/{version}/pin
openapi: 3.1.0
info:
  title: Veri API
  description: >-
    REST API for the Veri RL post-training platform. All requests require a
    Bearer API key (`vk_` prefix).
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://api.veri.studio
    description: Production
security: []
tags:
  - name: Training jobs
    description: Create, monitor, and manage training jobs.
  - name: Datasets
    description: Upload and connect training datasets.
  - name: Deployments
    description: Serve trained models and run inference.
  - name: Volumes
    description: Persistent file storage mounted into jobs.
  - name: Models
    description: Custom model registry deployments serve from.
  - name: Regions
    description: Discover available launch regions.
  - name: GPU
    description: Live GPU availability by provider and region.
  - name: Compatibility
    description: Advisory model and runtime compatibility guidance.
  - name: Code artifacts
    description: Upload custom training script bundles.
  - name: Billing
    description: Credit balance and transaction history.
  - name: API keys
    description: Create and revoke API keys.
  - name: Account
    description: The authenticated caller's identity.
  - name: SSH keys
    description: Manage SSH key pairs for compute access.
  - name: Settings
    description: Account-level integrations (Weights & Biases).
  - name: Metrics
    description: Prometheus metrics export for your own observability stack.
paths:
  /v1/models/{name}/versions/{version}/pin:
    post:
      tags:
        - Models
      summary: Pin a version
      description: >-
        Mark a version pinned: it is never purged by retention and its library
        model cannot be deleted. Send {"pinned": false} to unpin.
      operationId: pin
      parameters:
        - name: name
          in: path
          description: Lineage name
          required: true
          schema:
            type: string
        - name: version
          in: path
          description: 'Version: "v3" or "3"'
          required: true
          schema:
            type: string
      requestBody:
        description: Optional; defaults to pinned=true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinRequest'
        required: true
      responses:
        '200':
          description: The version with its new pinned state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelVersionResponse'
        '400':
          description: Invalid version reference
        '404':
          description: Lineage or version not found in the caller's workspace
      security:
        - bearerAuth: []
components:
  schemas:
    PinRequest:
      type: object
      properties:
        pinned:
          type: boolean
          description: true (default) pins; false unpins.
    ModelVersionResponse:
      type: object
      description: One version of a lineage (`{name}@v{version}`).
      required:
        - object
        - id
        - model_id
        - model
        - version
        - name
        - artifact_type
        - tags
        - pinned
        - status
        - aliases
        - created_at
      properties:
        object:
          type: string
          description: Always "model_version".
        id:
          type: string
          description: Version id (mv...).
        model_id:
          type: string
          description: Lineage id.
        model:
          type: string
          description: Lineage name.
        version:
          type: integer
          format: int32
          description: Dense, monotonic version number within the lineage.
        name:
          type: string
          description: 'Human handle: "{model}@v{version}".'
        custom_model_id:
          type:
            - string
            - 'null'
          description: |-
            The library model (custom_models row) whose weights this version is;
            deploy or attach by this id.
        artifact_type:
          type: string
          description: '''full'' | ''adapter''.'
        dataset_snapshot_id:
          type:
            - string
            - 'null'
          description: >-
            Dataset snapshot (Task 2) or plain dataset id the version was
            trained on.
        training_job_id:
          type:
            - string
            - 'null'
        parent_version_id:
          type:
            - string
            - 'null'
          description: The version `production` pointed at when this one was registered.
        tags:
          type: array
          items:
            type: string
        pinned:
          type: boolean
          description: Pinned versions are protected from retention.
        pinned_at:
          type:
            - string
            - 'null'
          format: date-time
        status:
          type: string
          description: >-
            'ready' | 'purged' (Task 6, VS-84). A purged version still lists —

            number, tags, audit and scorecards stay — but its weights are
            deleted

            and it can no longer be deployed, attached or promoted.
        purged_at:
          type:
            - string
            - 'null'
          format: date-time
        aliases:
          type: array
          items:
            type: string
          description: Aliases currently pointing at this version.
        created_by:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: API key with the `vk_` prefix. Create one from the dashboard.

````