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

# Update dedicated endpoint

> Scale replicas, or start/stop the endpoint. Requires an owner/admin key.



## OpenAPI

````yaml /openapi.json patch /v1/dedicated/{id}
openapi: 3.1.0
info:
  title: Omnia Management API
  description: >-
    The management API behind the improvement loop: capture and setup, request
    logs and datasets, grades (labels), judges (criteria), evals and deploy
    gates, fine-tuning and reinforcement learning, dedicated GPU endpoints, and
    model aliases and versions. Authenticated with a workspace API key
    (sk_sovereign_...). The inference API (chat, embeddings, rerank, responses)
    is OpenAI-compatible and documented separately.


    Responses are snake_case, list endpoints on the loop products use the
    {"object": "list", "data": [...]} envelope, and refusals use the same nested
    error shape the gateway emits: {"error": {"message", "type", "code"}}.
    Request bodies on the loop products (logs, labels, criteria, evals,
    datasets, aliases) are snake_case; the training and infrastructure products
    (fine-tuning, GRPO, environment tools, dedicated, model-version adoption)
    validate camelCase bodies, and each schema below says which it is. Endpoints
    that spend money require a key minted by a workspace owner or admin and
    return 403 otherwise.
  version: 1.0.0
servers:
  - url: https://gateway.omnia-voice.com
    description: Production
  - url: https://platform.omnia-voice.com/api
    description: Production (legacy alias — same API, older base URL)
security:
  - bearerAuth: []
paths:
  /v1/dedicated/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The endpoint id.
    patch:
      tags:
        - Dedicated endpoints
      summary: Update dedicated endpoint
      description: Scale replicas, or start/stop the endpoint. Requires an owner/admin key.
      operationId: updateDedicatedEndpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Send only the fields you want to change. This body is camelCase
                (minReplicas, gpuType), unlike the snake_case loop endpoints.
              properties:
                name:
                  type: string
                  description: Rename the endpoint.
                description:
                  type: string
                enabled:
                  type: boolean
                  description: >-
                    true to start, false to stop. Stopping halts GPU billing
                    after the final meter.
                minReplicas:
                  type: integer
                  minimum: 1
                maxReplicas:
                  type: integer
                  description: >-
                    Must be >= minReplicas and within the template's replica
                    limit.
                gpuType:
                  type: string
                  description: >-
                    Change the GPU type. Must be a valid configuration for the
                    model and region; re-prices the endpoint at the current rate
                    and requires prepaid balance for the first hour.
                gpuCount:
                  type: integer
                  description: >-
                    GPUs per replica. Must be an allowed count for the
                    configuration.
      responses:
        '200':
          description: >-
            Updated. Returns {"ok": true}; read the new state with GET
            /v1/dedicated/{id}.
          content:
            application/json:
              schema:
                type: object
                description: 'Acknowledgement: {"ok": true}.'
                properties:
                  ok:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '402':
          $ref: '#/components/responses/InsufficientBalance'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Malformed request or invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientBalance:
      description: Your wallet can't cover the required prepaid runway.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              message: >-
                Insufficient balance: deploying this endpoint requires at least
                1h of runway. Top up and try again.
              type: insufficient_quota
              code: insufficient_balance
    Forbidden:
      description: The key lacks the required owner/admin permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource does not exist in your workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
              description: >-
                invalid_request_error, insufficient_quota, rate_limit_error, or
                api_error.
            code:
              type: string
              description: >-
                Machine-stable cause, e.g. invalid_api_key, not_found,
                insufficient_permissions, precondition_failed.
          required:
            - message
            - type
            - code
      description: >-
        Every refusal — gateway and management API alike — uses this one
        envelope.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your workspace API key, e.g. `sk_sovereign_...`, sent as `Authorization:
        Bearer <key>`.

````