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

# Get model details

> Get detailed information about an org-level model.



## OpenAPI

````yaml get /v1/models/{model_id}
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:
  - BearerAuth: []
paths:
  /v1/models/{model_id}:
    get:
      tags:
        - Models
      summary: Get model details
      description: Get detailed information about an org-level model.
      operationId: get_model_v1_models__model_id__get
      parameters:
        - 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/OrgModelDetailResponse'
        '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: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    OrgModelDetailResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        model:
          $ref: '#/components/schemas/OrgModelDocument'
      type: object
      required:
        - model
      title: OrgModelDetailResponse
      description: Response model for org model details.
    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
    OrgModelDocument:
      properties:
        model_id:
          type: string
          title: Model Id
          description: Unique model identifier
        organization_id:
          type: string
          title: Organization Id
          description: Owner organization ID
        name:
          type: string
          title: Name
          description: Model name
        version:
          type: string
          title: Version
          description: Model version (semver)
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Model description
        source:
          type: string
          enum:
            - customer
            - mixpeek
            - system
          title: Source
          description: >-
            Who created this model: 'customer' (org-uploaded), 'mixpeek'
            (professional services), or 'system' (globally available)
          default: customer
        exportable:
          type: boolean
          title: Exportable
          description: >-
            Whether the model archive can be downloaded by the customer.
            Auto-set to False for source='mixpeek'.
          default: true
        license:
          anyOf:
            - type: string
            - type: 'null'
          title: License
          description: >-
            License of a model imported from the Hugging Face Hub, as its model
            card declares it ('unspecified' when the card names none).
        s3_archive_url:
          type: string
          title: S3 Archive Url
          description: S3 URL to model archive
        model_format:
          type: string
          enum:
            - safetensors
            - onnx
            - pytorch
            - huggingface
          title: Model Format
          description: Model format/framework
        model_hash:
          type: string
          title: Model Hash
          description: SHA256 hash of model archive
        validation_status:
          type: string
          enum:
            - passed
            - failed
            - pending
          title: Validation Status
          description: Validation status
        validation_errors:
          items:
            type: string
          type: array
          title: Validation Errors
          description: Validation error messages
        validation_traceback:
          anyOf:
            - type: string
            - type: 'null'
          title: Validation Traceback
          description: >-
            When the validation job failed: the end of the traceback from
            loading the model or running its sample inference.
        validation:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Validation
          description: >-
            What the validation job measured when it passed: validated_at, the
            engine_revision it ran on, the digest of the weights, peak_rss_bytes
            of the replica, and deploy_s, first_inference_s and cold_start_s.
        deployed:
          type: boolean
          title: Deployed
          description: Whether model has been deployed to any namespace
          default: false
        deployment_info:
          anyOf:
            - $ref: '#/components/schemas/OrgModelDeploymentInfo'
            - type: 'null'
          description: Deployment details
        framework:
          anyOf:
            - type: string
            - type: 'null'
          title: Framework
          description: ML framework (e.g., sentence-transformers)
        task_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Type
          description: Task type (e.g., embedding, classification)
        embedding_dim:
          anyOf:
            - type: integer
            - type: 'null'
          title: Embedding Dim
          description: >-
            Output dimension of an embedding model, measured by its validation
            job's sample inference. A collection on an extractor that serves it
            needs it before its vector index can be built.
        input_schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Input Schema
          description: Input schema JSON
        output_schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Output Schema
          description: Output schema JSON
        resource_requirements:
          $ref: '#/components/schemas/ModelResourceRequirements'
          description: Resource requirements for deployment
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last update timestamp
        tiering:
          anyOf:
            - $ref: '#/components/schemas/ModelTieringView'
            - type: 'null'
          description: The model's tier on the tiering ladder and its wake cost and time.
        registry:
          $ref: '#/components/schemas/ModelRegistryIdentity'
          description: >-
            The ids this entry derives: registry id, shared model key, service
            id.
          readOnly: true
      type: object
      required:
        - model_id
        - organization_id
        - name
        - version
        - s3_archive_url
        - model_format
        - model_hash
        - validation_status
        - registry
      title: OrgModelDocument
      description: >-
        Org-level model document stored in MongoDB.


        Org-scoped: Uses organization_id instead of namespace_id.

        Models belong to an organization and can be enabled in any namespace
        within that org.
    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.
    OrgModelDeploymentInfo:
      properties:
        ray_cluster_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Ray Cluster Url
          description: Ray cluster URL where model is deployed
        ray_deployment_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Ray Deployment Name
          description: Ray deployment name
        deployed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deployed At
          description: When the model was deployed
      type: object
      title: OrgModelDeploymentInfo
      description: Deployment information for an org-level model.
    ModelResourceRequirements:
      properties:
        num_cpus:
          type: number
          maximum: 64
          minimum: 0.1
          title: Num Cpus
          description: Number of CPUs
          default: 1
        num_gpus:
          type: integer
          maximum: 8
          minimum: 0
          title: Num Gpus
          description: Number of GPUs
          default: 0
        memory:
          type: integer
          title: Memory
          description: Memory in bytes (default 4GB)
          default: 4294967296
      type: object
      title: ModelResourceRequirements
      description: Resource requirements for model deployment.
    ModelTieringView:
      properties:
        tier:
          type: string
          enum:
            - warm
            - cold
            - frozen
          title: Tier
          description: 'The ladder rung the weights archive is on: warm, cold or frozen.'
          default: warm
        storage_tier:
          anyOf:
            - type: string
            - type: 'null'
          title: Storage Tier
          description: >-
            The storage tier the weights archive is held in: standard, nearline
            or coldline. It stays standard on a store without colder classes,
            where the tier is recorded and the archive is not moved.
        tier_changed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Tier Changed At
          description: When the archive last moved to this tier.
        retrieval_usd_per_gb:
          anyOf:
            - type: number
            - type: 'null'
          title: Retrieval Usd Per Gb
          description: >-
            The storage class's retrieval fee per GiB read, charged when the
            model wakes from this tier.
        archive_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Archive Bytes
          description: The weights archive's size, recorded at registration.
        wake_retrieval_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Wake Retrieval Usd
          description: >-
            The retrieval fee for one wake from this tier: the fee per GiB times
            the archive size. Null when the size is not recorded.
        declared_wake_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Declared Wake Seconds
          description: >-
            The declared wake time for this tier: how long a call may take to
            start answering.
        exempt:
          anyOf:
            - type: string
            - type: 'null'
          title: Exempt
          description: Why this model never demotes, when it is exempt.
      type: object
      title: ModelTieringView
      description: >-
        Where a model's weights sit on the tiering ladder and what waking it
        costs (plan 7.10).
    ModelRegistryIdentity:
      properties:
        registry_id:
          type: string
          title: Registry Id
          description: 'Org-scoped registry key: org:<organization_id>:<model_id>.'
        shared_model_key:
          type: string
          title: Shared Model Key
          description: 'The key Serve deployments share the weights under: the model_id.'
        inference_service_id:
          type: string
          title: Inference Service Id
          description: The inference service and deployment name derived from registry_id.
      type: object
      required:
        - registry_id
        - shared_model_key
        - inference_service_id
      title: ModelRegistryIdentity
      description: >-
        The ids a model's registry entry derives from its ``model_id`` (plan
        11.2).


        Computed on every read from the upload's id, so a model uploaded before
        these

        fields existed carries them too and nothing is stored twice.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.

````

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