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

# Deploy model to Ray object store

> Pre-load model weights into the Ray object store for fast access by plugins.

This operation:
1. Downloads the model archive from S3
2. Deserializes weights based on format (safetensors, pytorch, etc.)
3. Stores weights in Ray object store for zero-copy sharing

After deployment, plugins can load the model instantly using:
```python
from engine.models.loader import load_namespace_model
weights = load_namespace_model("model_id")
```

**Note:** This is optional - models are also loaded on-demand when plugins
first request them. Use this endpoint to pre-warm the cache.



## OpenAPI

````yaml post /v1/namespaces/{namespace_id}/models/{model_id}/deploy
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/namespaces/{namespace_id}/models/{model_id}/deploy:
    post:
      tags:
        - Custom Models
      summary: Deploy model to Ray object store
      description: >-
        Pre-load model weights into the Ray object store for fast access by
        plugins.


        This operation:

        1. Downloads the model archive from S3

        2. Deserializes weights based on format (safetensors, pytorch, etc.)

        3. Stores weights in Ray object store for zero-copy sharing


        After deployment, plugins can load the model instantly using:

        ```python

        from engine.models.loader import load_namespace_model

        weights = load_namespace_model("model_id")

        ```


        **Note:** This is optional - models are also loaded on-demand when
        plugins

        first request them. Use this endpoint to pre-warm the cache.
      operationId: deploy_model_v1_namespaces__namespace_id__models__model_id__deploy_post
      parameters:
        - name: namespace_id
          in: path
          required: true
          schema:
            type: string
            title: Namespace Id
        - name: model_id
          in: path
          required: true
          schema:
            type: string
            title: Model Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelDeployResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Model not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Deployment failed
components:
  schemas:
    ModelDeployResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether deployment succeeded
        model_id:
          type: string
          title: Model Id
          description: Model identifier
        namespace_id:
          type: string
          title: Namespace Id
          description: Namespace ID
        deployment_status:
          type: string
          title: Deployment Status
          description: Deployment status (deployed, failed)
        cached:
          type: boolean
          title: Cached
          description: Whether model is cached in object store
          default: false
        message:
          type: string
          title: Message
          description: Status message
      type: object
      required:
        - success
        - model_id
        - namespace_id
        - deployment_status
        - message
      title: ModelDeployResponse
      description: |-
        Response model for model deployment.

        Deploying a model pre-loads the weights into the Ray object store,
        making them available for zero-copy access by plugins.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````