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

# Get model

> Get a base model or adapter, or a named model with its versions.



## OpenAPI

````yaml /openapi.json get /v1/models/{model_id}
openapi: 3.1.0
info:
  title: DecisionOne workbench
  description: >-
    Native decisions, immutable datasets, adaptation and shared-base deployment.
    Authenticate with `Authorization: Bearer d1_sk_...` when accounts are on. A
    short guide for coding agents is at /llms.txt. Hosted account APIs accept a
    Bearer API key or a browser session. Browser mutations require the
    configured Origin and X-CSRF-Token from /auth/session. Account recovery and
    history remain available to blocked accounts. Waitlisted accounts can read
    their account summary and model catalogue and request early access; private
    member APIs require admission. Money fields ending in _usd are exact decimal
    strings; never interpret them as integer cents. Authenticated customer reads
    and existing-operation replays share read_rpm. Exhausted budgets return 429
    with Retry-After; unavailable admission storage returns 503.
  version: 0.1.0
servers:
  - url: https://console.sqwish.ai
security: []
tags:
  - name: Decisions
    description: Probabilities for questions with fixed outcomes.
  - name: Feedback
    description: Report outcomes and turn them into training data.
  - name: Models
    description: Base models, adapters and named models with versions.
  - name: Datasets
    description: Validated training examples. A dataset never changes.
  - name: Fine-tuning
    description: Training jobs, their events and held-out results.
  - name: Prompt tuning
    description: Better wording for a decision, tested on your rows. Words, not weights.
  - name: Labeling
    description: Teacher labels for real queries, reviewed by you.
  - name: Accounts
    description: Email OTP sign-in, revocable sessions, security and API keys.
  - name: Billing
    description: Exact USD balances, purchases, automatic top-ups and referrals.
  - name: Integrations
    description: Endpoints other tools call, such as Claude Code.
  - name: System
    description: Health and discovery.
paths:
  /v1/models/{model_id}:
    get:
      tags:
        - Models
      summary: Get model
      description: Get a base model or adapter, or a named model with its versions.
      operationId: getModel
      parameters:
        - name: model_id
          in: path
          required: true
          schema:
            type: string
            title: Model Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/Model'
                  - $ref: '#/components/schemas/NamedModel'
        4XX:
          description: >-
            Client error. On a 422, `error.details` lists each field that
            failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        5XX:
          description: Server error. A 503 names what is not running on this server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    Model:
      properties:
        serving_artifact_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Serving Artifact Sha256
        serving_master_artifact_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Serving Master Artifact Sha256
        serving_execution_artifact_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Serving Execution Artifact Sha256
        engine_dtype:
          type: string
          title: Engine Dtype
        engine_quantization:
          anyOf:
            - type: string
            - type: 'null'
          title: Engine Quantization
        id:
          type: string
          title: Id
        status:
          type: string
          title: Status
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        family:
          type: string
          title: Family
        size_order:
          type: integer
          title: Size Order
        kind:
          type: string
          title: Kind
        base_model:
          type: string
          title: Base Model
        base_revision:
          type: string
          title: Base Revision
        base_id:
          type: string
          title: Base Id
        initialization:
          additionalProperties: true
          type: object
          title: Initialization
        base_artifact_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Artifact Sha256
        compute_dtype:
          type: string
          title: Compute Dtype
        layout:
          type: string
          title: Layout
        lora:
          anyOf:
            - type: string
            - type: 'null'
          title: Lora
        weights_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Weights Sha256
        adapter_bundle_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Adapter Bundle Sha256
        metrics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metrics
        max_prompt_tokens:
          type: integer
          title: Max Prompt Tokens
        max_questions:
          type: integer
          title: Max Questions
        calibration:
          type: string
          title: Calibration
        availability_reason:
          type: string
          title: Availability Reason
        available:
          type: boolean
          title: Available
        access_requested:
          type: boolean
          title: Access Requested
        adapter_capacity:
          anyOf:
            - $ref: '#/components/schemas/AdapterCapacity'
            - type: 'null'
        created_at:
          type: number
          title: Created At
        job_id:
          type: string
          title: Job Id
        model_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Name
        version:
          type: integer
          title: Version
        parent:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent
        residency:
          $ref: '#/components/schemas/Residency'
        state:
          anyOf:
            - type: string
              enum:
                - loaded
                - loading
                - asleep
            - type: 'null'
          title: State
        decision_price_nano:
          anyOf:
            - type: string
            - type: 'null'
          title: Decision Price Nano
          description: >-
            Exact integer string of nano-USD per billed input token from the
            current billing policy. Zero means free; null means unpriced.
        evaluation_set:
          anyOf:
            - $ref: '#/components/schemas/EvaluationSet'
            - type: 'null'
        request_latency:
          $ref: '#/components/schemas/RequestLatency'
      type: object
      required:
        - id
        - status
      title: Model
      description: A base, an early-access catalogue entry, or a trained adapter.
    NamedModel:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: model
          title: Object
        kind:
          type: string
          const: named
          title: Kind
        production:
          anyOf:
            - $ref: '#/components/schemas/ModelVersion'
            - type: 'null'
        candidate:
          anyOf:
            - $ref: '#/components/schemas/ModelVersion'
            - type: 'null'
        previous:
          anyOf:
            - $ref: '#/components/schemas/ModelVersion'
            - type: 'null'
        keep_warm:
          type: boolean
          title: Keep Warm
        learning:
          $ref: '#/components/schemas/LearningState'
        versions:
          items:
            $ref: '#/components/schemas/ModelVersion'
          type: array
          title: Versions
        memory:
          additionalProperties:
            $ref: '#/components/schemas/MemoryPool'
          type: object
          title: Memory
      type: object
      required:
        - id
        - object
        - kind
        - production
        - candidate
        - previous
        - keep_warm
        - learning
        - versions
        - memory
      title: NamedModel
    ErrorResponse:
      description: >-
        The body of every error. app.failure() builds it; this model documents
        it.
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
        - error
      title: ErrorResponse
      type: object
    AdapterCapacity:
      properties:
        max_rank:
          type: integer
          title: Max Rank
        slots:
          anyOf:
            - type: integer
            - type: 'null'
          title: Slots
      type: object
      required:
        - max_rank
        - slots
      title: AdapterCapacity
    Residency:
      properties:
        state:
          type: string
          enum:
            - hot
            - cold
          title: State
        pinned:
          type: boolean
          title: Pinned
      type: object
      required:
        - state
        - pinned
      title: Residency
    EvaluationSet:
      properties:
        dataset:
          $ref: '#/components/schemas/EvaluationDataset'
        training_examples:
          anyOf:
            - type: integer
            - type: 'null'
          title: Training Examples
        validation_examples:
          anyOf:
            - type: integer
            - type: 'null'
          title: Validation Examples
        remembered_examples:
          anyOf:
            - type: integer
            - type: 'null'
          title: Remembered Examples
      type: object
      required:
        - dataset
        - training_examples
        - validation_examples
        - remembered_examples
      title: EvaluationSet
    RequestLatency:
      properties:
        median_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Median Ms
        samples:
          type: integer
          title: Samples
        median_is_lower_bound:
          type: boolean
          title: Median Is Lower Bound
        start:
          type: string
          title: Start
        end:
          type: string
          title: End
      type: object
      required:
        - median_ms
        - samples
        - median_is_lower_bound
        - start
        - end
      title: RequestLatency
    ModelVersion:
      properties:
        version:
          type: integer
          title: Version
        ref:
          type: string
          title: Ref
        adapter:
          type: string
          title: Adapter
        status:
          type: string
          title: Status
        state:
          anyOf:
            - type: string
              enum:
                - loaded
                - loading
                - asleep
            - type: 'null'
          title: State
        parent:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent
        created_at:
          anyOf:
            - type: number
            - type: 'null'
          title: Created At
        gate:
          anyOf:
            - $ref: '#/components/schemas/Gate'
            - type: 'null'
        heldout:
          additionalProperties:
            type: number
          type: object
          title: Heldout
      type: object
      required:
        - version
        - ref
        - adapter
        - status
        - state
        - parent
        - created_at
        - gate
        - heldout
      title: ModelVersion
    LearningState:
      properties:
        enabled:
          type: boolean
          title: Enabled
        after:
          type: integer
          title: After
        auto_promote:
          type: boolean
          title: Auto Promote
        labelled:
          type: integer
          title: Labelled
        waiting:
          anyOf:
            - type: string
            - type: 'null'
          title: Waiting
        next_round_after:
          anyOf:
            - type: number
            - type: 'null'
          title: Next Round After
        round:
          anyOf:
            - $ref: '#/components/schemas/LearningRound'
            - type: 'null'
      type: object
      required:
        - enabled
        - after
        - auto_promote
        - labelled
        - waiting
        - next_round_after
        - round
      title: LearningState
    MemoryPool:
      properties:
        rows:
          type: integer
          title: Rows
        capacity:
          type: integer
          title: Capacity
        seen:
          type: integer
          title: Seen
        task_label_strata:
          type: integer
          title: Task Label Strata
      type: object
      required:
        - rows
        - capacity
        - seen
        - task_label_strata
      title: MemoryPool
    ErrorBody:
      properties:
        code:
          description: A stable code to branch on, such as invalid_request.
          title: Code
          type: string
        message:
          description: What went wrong and what to change, in plain words.
          title: Message
          type: string
        retryable:
          description: >-
            True when another attempt may succeed; it does not prove that no
            work was done. Respect Retry-After when present. Only operations
            that support Idempotency-Key replay a prior result, including
            /v1/decide for 24 hours.
          title: Retryable
          type: boolean
        request_id:
          description: Also sent as X-Request-ID. Quote it in bug reports.
          title: Request Id
          type: string
        details:
          anyOf:
            - items:
                $ref: '#/components/schemas/ErrorDetail'
              type: array
            - type: 'null'
          default: null
          description: On validation errors, one entry for each field that failed.
          title: Details
      required:
        - code
        - message
        - retryable
        - request_id
      title: ErrorBody
      type: object
    EvaluationDataset:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        deleted_at:
          anyOf:
            - type: number
            - type: 'null'
          title: Deleted At
      type: object
      required:
        - id
        - name
        - deleted_at
      title: EvaluationDataset
    Gate:
      properties:
        passed:
          type: boolean
          title: Passed
        against:
          type: string
          enum:
            - parent
            - base
          title: Against
        reasons:
          items:
            type: string
          type: array
          title: Reasons
        groups:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Groups
        deltas:
          additionalProperties:
            type: number
          type: object
          title: Deltas
        ece:
          additionalProperties:
            anyOf:
              - type: number
              - type: 'null'
          type: object
          title: Ece
      type: object
      required:
        - passed
        - against
        - reasons
      title: Gate
    LearningRound:
      properties:
        job:
          anyOf:
            - type: string
            - type: 'null'
          title: Job
        version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version
        state:
          type: string
          title: State
        started_at:
          anyOf:
            - type: number
            - type: 'null'
          title: Started At
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
      type: object
      required:
        - job
        - version
        - state
        - started_at
        - message
      title: LearningRound
    ErrorDetail:
      properties:
        path:
          description: Where the problem is, such as ["body", "decisions", 0, "outcomes"].
          items:
            anyOf:
              - type: string
              - type: integer
          title: Path
          type: array
        message:
          title: Message
          type: string
        type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Type
      required:
        - path
        - message
      title: ErrorDetail
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: d1_sk_...
      description: Create an API key in the console. Required when accounts are enabled.

````