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

# Substituir uma política de dimensionamento de serviço



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR patch /api/v1/compute/services/{id}/scaling
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda
    como começar a usar a API e o SDK TypeScript
    [aqui](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietário
servers:
  - url: https://apigw.mka1.com
    description: MKA1 API Gateway
  - url: /
    description: Relative server URL (configurable via SDK constructor)
security: []
tags:
  - name: Resource Authorization
    description: >-
      Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque
      permissões e exclua recursos. Apenas os proprietários dos recursos podem
      conceder, revogar ou excluir permissões.
    x-displayName: Autorização de Recurso
  - name: Audit
    description: >-
      API de auditoria para proprietários e administradores da organização.
      Rastreie uma solicitação de ponta a ponta pelo seu X-Request-ID: tempo de
      processamento do gateway de API, as respostas que ele criou e suas
      invocações de modelo e chamadas de ferramenta.
    x-displayName: Auditoria
  - name: Embeddings
    description: >-
      Endpoints da API de incorporação de texto para gerar representações
      vetoriais de texto. Crie incorporações semânticas para busca, clustering e
      correspondência de similaridade usando vários modelos de incorporação.
    x-displayName: Incorporações
  - name: Feedback
    description: >-
      API de feedback do usuário para avaliar e comentar sobre as conclusões de
      chat. Coleta de classificações de positivo/negativo e feedback detalhado
      para melhorar as respostas do modelo e acompanhar a satisfação do usuário.
    x-displayName: Feedback
  - name: Images
    description: >-
      Pontos de extremidade da API de geração de imagens para criar imagens a
      partir de descrições de texto. Gere imagens com controle sobre tamanho,
      qualidade e estilo.
    x-displayName: Imagens
  - name: MCP Vault
    description: >-
      API do cofre MCP para armazenar configurações de servidor MCP de
      propriedade do usuário e credenciais criptografadas. Os agentes
      referenciam IDs de cofre para que os segredos sejam resolvidos apenas no
      momento da execução da ferramenta.
    x-displayName: Cofre MCP
  - name: Speech
    description: >-
      Pontos de extremidade da API de fala para processamento de áudio. Converta
      texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em
      diferentes idiomas.
    x-displayName: Discurso
  - name: Usage
    description: >-
      API de rastreamento de uso e análise para monitoramento do consumo de
      tokens, contagem de solicitações e análise de custos. Veja estatísticas
      detalhadas por usuário, modelo e período de tempo.
    x-displayName: Uso
  - name: Extract
    description: >-
      API de extração de dados estruturados para extrair informações de
      arquivos. Defina esquemas JSON para extrair dados estruturados de imagens,
      PDFs e documentos. Suporta modelos de esquema reutilizáveis.
    x-displayName: Extração
  - name: Text Classification
    description: >-
      API de classificação de texto para categorizar textos em rótulos
      predefinidos. Use modelos de IA para classificar o conteúdo textual para
      análise de sentimento, categorização de tópicos e moderação de conteúdo.
    x-displayName: Classificação de Texto
  - name: Responses
    description: >-
      API de respostas com agentes para criar agentes de IA com uso autônomo de
      ferramentas. Crie assistentes conversacionais que possam usar busca na
      web, operações de arquivos, geração de imagens, execução de código e
      integrações MCP. Suporta processamento em segundo plano, streaming e
      acompanhamento de status em tempo real.
    x-displayName: Respostas
  - name: Files
    description: >-
      API de gerenciamento de arquivos para upload, armazenamento e
      gerenciamento de arquivos com expiração automática e integração com S3.
      Faça upload de arquivos que podem ser usados com Assistentes,
      Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são
      armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza
      automática de arquivos expirados.
    x-displayName: Arquivos
  - name: Vector Stores
    description: >-
      API de armazenamento de vetores para armazenar e pesquisar documentos
      usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos
      com divisão automática e geração de embeddings, e realize pesquisas
      semânticas. Os arquivos são processados de forma assíncrona usando fluxos
      de trabalho Temporais para durabilidade. Suporta limpeza automática de
      armazenamentos expirados e LanceDB para armazenamento eficiente de
      vetores.
    x-displayName: Armazenamentos de Vetores
  - name: Conversations
    description: >-
      API de gerenciamento de conversas para armazenar e recuperar o estado da
      conversa durante chamadas à API de Resposta. Crie conversas, adicione
      itens (mensagens do usuário, mensagens do assistente, mensagens do
      sistema) e mantenha o histórico da conversa. Suporta rastreamento de
      metadados e gerenciamento de estado de diálogo em múltiplas interações.
    x-displayName: Conversa
  - name: Guardrails
    description: >-
      API de diretrizes de segurança de IA para configurar moderação de conteúdo
      e políticas de segurança. Configure listas de palavras proibidas, detecção
      de injeção de prompts e prevenção de vazamento de prompts do sistema. As
      diretrizes aplicam-se a todas as solicitações de uma conta e podem ser
      testadas antes da implementação.
    x-displayName: Guarda-corpos
  - name: Models
    description: >-
      API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs
      de modelos, propriedade e metadados de todos os modelos registrados no
      gateway.
    x-displayName: Modelos
  - name: Skills
    description: >-
      API de habilidades para gerenciar pacotes versionados de instruções e
      arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e
      baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md
      para ambientes de agentes.
    x-displayName: Habilidades
  - name: Chat Completions
    description: >-
      **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez
      disso.** Endpoints de conclusão de chat com suporte para streaming,
      chamadas de ferramentas e múltiplos provedores.
    x-deprecated: true
    x-displayName: Conclusões de Bate-Papo
  - name: Batches
    x-displayName: Lotes
  - name: Evals
    x-displayName: Avaliações
  - name: Fine-Tuning
    x-displayName: Ajuste Fino
  - name: Memory Stores
    x-displayName: Armazenamentos de Memória
  - name: Prompts
    x-displayName: Sugestões
  - name: API Key
    x-displayName: Chave da API
  - name: Session
    x-displayName: Sessão
  - name: Organization
    x-displayName: Organização
  - name: Cluster Admin
    x-displayName: Administrador do cluster
  - name: Sessions
    description: Crie, inspecione, acesse e encerre sessões de sandbox.
    x-displayName: Sessões
  - name: Browser
    description: >-
      Conecte-se às sessões do navegador através do proxy da porta do gateway.
      As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na
      porta 9222.
    x-displayName: Navegador
  - name: Execution
    description: >-
      Executar comandos shell e código dentro de uma sessão de sandbox
      existente.
    x-displayName: Execução
  - name: Workspace
    description: >-
      Inspecione o manifesto do espaço de trabalho, transfira arquivos ou
      arquivos compactados e baixe artefatos gerados.
    x-displayName: Espaço de trabalho
  - name: Sandbox Usage
    description: >-
      Agregue estatísticas de uso da sandbox entre sessões, execução e operações
      do espaço de trabalho.
    x-displayName: Uso do Sandbox
  - name: Sandbox Pricing
    description: >-
      Gerenciamento de cluster-admin da tabela de preços de computação da
      sandbox usada para gastos orçados.
    x-displayName: Preço da Sandbox
  - name: Sandbox GitHub
    description: >-
      Conecte uma conta do GitHub, clone seus repositórios em sessões do sandbox
      e envie branches e abra pull requests a partir de uma sessão. O token do
      GitHub permanece no serviço de sandbox e nunca entra em uma sessão.
    x-displayName: Sandbox do GitHub
  - name: Sandbox Environments
    description: >-
      Salvar a configuração de sessão reutilizável (repositórios, variáveis de
      ambiente, acesso à rede e um script de configuração) e executar o script
      de configuração em uma sessão.
    x-displayName: Ambientes de Sandbox
  - name: Sandbox Connectors
    description: >-
      Conecte servidores MCP remotos (Linear, Notion, Sentry e outros) à sua
      conta para que sessões do Coding Harness iniciadas a partir de um ambiente
      que os liste possam chamar as ferramentas deles. O serviço de sandbox
      mantém as credenciais de cada conector e nunca as coloca em uma sessão.
    x-displayName: Conectores de Sandbox
  - name: Agents
    description: Crie e gerencie definições de agentes reutilizáveis.
    x-displayName: Agentes
  - name: Agent Versions
    description: >-
      Inspecione o histórico de configuração de um agente e reverta para uma
      versão anterior.
    x-displayName: Versões do Agente
  - name: Agent Runs
    description: Execute agentes salvos e inspecione os resultados da execução persistidos.
    x-displayName: Executa Agente
  - name: Agent Connectors
    description: >-
      Conecte agentes salvos a canais de mensagens externos, como o Telegram,
      incluindo troca de texto, foto e documentos compatíveis.
    x-displayName: Conectores de Agente
  - name: Agent Schedules
    description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes.
    x-displayName: Agendas de Agentes
  - name: schema-4_other
    x-displayName: outro
  - name: Billing
    x-displayName: Cobrança
  - name: Budgets
    x-displayName: Orçamentos
  - name: Settings
    x-displayName: Configurações
  - name: Compute Jobs
    x-displayName: Jobs de Computação
  - name: Compute Services
    x-displayName: Serviços de Computação
  - name: Compute Catalog
    x-displayName: Catálogo de Computação
  - name: Compute Volumes
    x-displayName: Calcular volumes
  - name: Compute Pricing
    x-displayName: Calcular Preços
  - name: Compute Secrets
    x-displayName: Calcular Segredos
  - name: Compute Usage
    x-displayName: Uso de Computação
  - name: Compute Tenants
    x-displayName: Calcular Inquilinos
  - description: Criar, listar, ler, atualizar e excluir repositórios.
    name: Repositories
    x-displayName: Repositórios
  - name: Tracking Experiments
    description: Criar e consultar experimentos de locatário.
    x-displayName: Rastreamento de Experimentos
  - name: Tracking Runs
    description: Registrar e recuperar parâmetros, métricas e tags da execução.
    x-displayName: Acompanhamento de execuções
  - name: analytics.projects
    x-displayName: Projetos
    description: Criar, listar, renomear e arquivar projetos de análise.
  - name: analytics.keys
    x-displayName: Capturar chaves
    description: Criar e revogar chaves do projeto para enviar eventos.
  - name: analytics
    x-displayName: Eventos
    description: Envie eventos e consulte contagens de eventos ou visitantes únicos.
  - name: analytics.events
    x-displayName: Busca de eventos
    description: >-
      Liste eventos individuais com suas propriedades, do mais recente para o
      mais antigo.
  - name: analytics.visitors
    x-displayName: Busca de visitantes
    description: >-
      Liste os visitantes por sua atividade mais recente, com os horários de
      primeira e última visualização.
  - name: generators
    x-displayName: geradores
  - name: generations
    x-displayName: gerações
  - name: formats
    x-displayName: formatos
  - description: >-
      Flags, ambientes, avaliação e o log de auditoria. As operações
      administrativas exigem um administrador de cluster; a avaliação usa uma
      chave de avaliação específica do ambiente.
    name: Feature Flags
    x-displayName: Flags de Recursos
paths:
  /api/v1/compute/services/{id}/scaling:
    patch:
      tags:
        - Compute Services
      summary: Substituir uma política de dimensionamento de serviço
      operationId: updateServiceScaling
      parameters:
        - $ref: '#/components/parameters/ComputeResourceID'
        - $ref: '#/components/parameters/ComputeIdempotencyKey'
        - $ref: '#/components/parameters/ComputeIfMatchScalingGeneration'
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeScalingInput'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeService'
          description: Política de escalonamento aceita para reconciliação assíncrona
          headers:
            ETag:
              description: >-
                Strong entity tag containing the desired scaling-policy
                generation.
              schema:
                type: string
        default:
          $ref: '#/components/responses/ComputeError'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: go
          label: Go (SDK)
          source: "package main\n\nimport(\n\t\"context\"\n\tmka1 \"github.com/MeetKai/mka1-sdks/go\"\n\t\"github.com/MeetKai/mka1-sdks/go/models/components\"\n\t\"github.com/MeetKai/mka1-sdks/go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := mka1.New(\n        mka1.WithSecurity(\"<YOUR_BEARER_TOKEN_HERE>\"),\n    )\n\n    res, err := s.ComputeServices.UpdateServiceScaling(ctx, operations.UpdateServiceScalingRequest{\n        ID: \"<id>\",\n        IdempotencyKey: \"<value>\",\n        Body: components.ComputeScalingInput{\n            MaxReplicas: 800181,\n            MinReplicas: 693036,\n        },\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.ComputeService != nil {\n        // handle response\n    }\n}"
        - lang: csharp
          label: CSharp (SDK)
          source: >-
            using MeetKai.MKA1;

            using MeetKai.MKA1.Types.Components;

            using MeetKai.MKA1.Types.Requests;


            var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");


            UpdateServiceScalingRequest req = new UpdateServiceScalingRequest()
            {
                Id = "<id>",
                IdempotencyKey = "<value>",
                Body = new ComputeScalingInput() {
                    MaxReplicas = 693036,
                    MinReplicas = 178601,
                },
            };


            var res = await sdk.ComputeServices.UpdateServiceScalingAsync(req);


            // handle response
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


            with SDK(
                bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
            ) as sdk:

                res = sdk.compute_services.update_service_scaling(id="<id>", idempotency_key="<value>", max_replicas=693036, min_replicas=178601)

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { SDK } from "@meetkai/mka1";

            const sdk = new SDK({
              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await sdk.computeServices.updateServiceScaling({
                id: "<id>",
                idempotencyKey: "<value>",
                computeScalingInput: {
                  maxReplicas: 693036,
                  minReplicas: 178601,
                },
              });

              console.log(result);
            }

            run();
components:
  parameters:
    ComputeResourceID:
      in: path
      name: id
      required: true
      schema:
        type: string
    ComputeIdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
        minLength: 1
    ComputeIfMatchScalingGeneration:
      description: >-
        Optional strong entity tag containing the current desired scaling-policy
        generation.
      in: header
      name: If-Match
      required: false
      schema:
        type: string
        minLength: 1
  schemas:
    ComputeScalingInput:
      additionalProperties: false
      properties:
        idle_timeout_seconds:
          description: >-
            Por quanto tempo a demanda deve permanecer baixa antes que uma
            réplica seja removida. Obrigatório, e pelo menos 1, quando
            min_replicas < max_replicas. Uma política fixa (min_replicas ==
            max_replicas) não tem esse valor: qualquer valor enviado com ela é
            ignorado, e uma política fixa retorna 0 até que os clientes aceitem
            a ausência do campo.
          minimum: 0
          type: integer
        max_replicas:
          type: integer
          minimum: 1
        min_replicas:
          minimum: 0
          type: integer
        target_concurrency_per_replica:
          maximum: 10000
          minimum: 1
          type: integer
      required:
        - min_replicas
        - max_replicas
      type: object
    ComputeService:
      allOf:
        - $ref: '#/components/schemas/ComputeResource'
        - properties:
            health:
              enum:
                - healthy
                - warming
                - degraded
              type: string
            ready:
              type: boolean
            scaling:
              $ref: '#/components/schemas/ComputeServiceScaling'
            volume:
              $ref: '#/components/schemas/ComputeVolume'
          required:
            - ready
          type: object
      unevaluatedProperties: false
    ComputeResource:
      properties:
        accrued_usd:
          format: double
          type: number
        allocated_at:
          type: string
          format: date-time
        compute:
          $ref: '#/components/schemas/ComputeRequest'
        created_at:
          type: string
          format: date-time
        current_price_usd_hr:
          format: double
          type: number
        endpoints:
          items:
            $ref: '#/components/schemas/ComputeEndpoint'
          type: array
        hardware:
          $ref: '#/components/schemas/ComputeHardware'
        id:
          type: string
        instance_price_usd_hr:
          format: double
          type: number
        limits:
          $ref: '#/components/schemas/ComputeLimits'
        name:
          type: string
        price_usd_hr:
          format: double
          type: number
        pricing_model:
          enum:
            - instance_minutes
            - instance_seconds
          type: string
        provider:
          $ref: '#/components/schemas/ComputeProviderName'
        reason:
          oneOf:
            - $ref: '#/components/schemas/ComputeReason'
            - type: 'null'
        ssh:
          $ref: '#/components/schemas/ComputeSSH'
        started_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        state:
          $ref: '#/components/schemas/ComputeResourceState'
        terminal_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        volumes:
          items:
            $ref: '#/components/schemas/ComputeStandaloneVolumeMount'
          type: array
      required:
        - id
        - state
        - reason
        - compute
        - accrued_usd
        - limits
        - endpoints
        - created_at
        - started_at
        - terminal_at
      type: object
    ComputeServiceScaling:
      additionalProperties: false
      properties:
        applied:
          oneOf:
            - $ref: '#/components/schemas/ComputeScalingInput'
            - type: 'null'
        applied_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        applied_generation:
          format: int64
          minimum: 0
          type: integer
        autoscaler:
          $ref: '#/components/schemas/ComputeAutoscalerState'
        desired:
          $ref: '#/components/schemas/ComputeScalingInput'
        desired_generation:
          format: int64
          minimum: 1
          type: integer
        desired_updated_at:
          type: string
          format: date-time
        replicas:
          $ref: '#/components/schemas/ComputeScalingReplicas'
      required:
        - desired
        - desired_generation
        - desired_updated_at
        - applied
        - applied_generation
        - applied_at
        - replicas
        - autoscaler
      type: object
    ComputeVolume:
      additionalProperties: false
      properties:
        accrued_cost_usd:
          format: double
          type: number
        data:
          items:
            $ref: '#/components/schemas/ComputeVolumeData'
          type: array
        mount_path:
          type: string
        price_usd_hr:
          format: double
          type: number
        size_gb:
          type: integer
        status:
          enum:
            - provisioning
            - loading
            - ready
            - deleting
            - deleted
            - failed
          type: string
      required:
        - status
        - size_gb
        - mount_path
        - data
        - price_usd_hr
        - accrued_cost_usd
      type: object
    ComputeErrorEnvelope:
      additionalProperties: false
      properties:
        error:
          $ref: '#/components/schemas/ComputeError'
      required:
        - error
      type: object
    ComputeRequest:
      additionalProperties: false
      properties:
        accelerator:
          type: string
        ephemeral_disk_gb:
          type: integer
          minimum: 1
        gpu_count:
          description: >-
            GPUs anexadas. Zero é válido apenas para entradas de catálogo de
            classe CPU e é obrigatório para uma.
          maximum: 8
          minimum: 0
          type: integer
        instance_count:
          description: >-
            Instâncias de execução cooperantes idênticas por alocação. Omitir
            significa uma.
          minimum: 1
          type: integer
        interconnect:
          type: string
        vcpu_count:
          description: >-
            vCPUs solicitadas. Um eixo geral controlado por capacidade,
            respeitado apenas por backends que o suportam; um backend que agrupa
            CPU com a GPU o rejeita. Necessário para um acelerador de classe
            CPU, em que a memória segue a proporção por vCPU da família.
          minimum: 1
          type: integer
      required:
        - accelerator
        - gpu_count
        - ephemeral_disk_gb
      type: object
    ComputeEndpoint:
      additionalProperties: false
      properties:
        host:
          type: string
        name:
          type: string
        port:
          type: integer
        protocol:
          type: string
        url:
          type: string
      required:
        - name
        - protocol
        - host
        - port
      type: object
    ComputeHardware:
      additionalProperties: false
      properties:
        accelerator:
          type: string
        gpu_count:
          type: integer
        gpu_memory_gb:
          type: integer
        interconnect:
          type: string
      required:
        - accelerator
        - gpu_count
        - gpu_memory_gb
      type: object
    ComputeLimits:
      additionalProperties: false
      properties:
        max_cost_usd:
          exclusiveMinimum: 0
          format: double
          type: number
        max_runtime_hours:
          exclusiveMinimum: 0
          format: double
          type: number
      type: object
    ComputeProviderName:
      description: >-
        Identificador opaco do provedor de computação. Os valores suportados são
        específicos da implantação.
      minLength: 1
      type: string
    ComputeReason:
      additionalProperties: false
      properties:
        code:
          type: string
        details:
          additionalProperties: true
          type: object
        message:
          type: string
      required:
        - code
        - message
      type: object
    ComputeSSH:
      additionalProperties: false
      properties:
        command:
          type: string
        host:
          type: string
        port:
          type: integer
        user:
          type: string
      required:
        - host
        - port
        - user
        - command
      type: object
    ComputeResourceState:
      enum:
        - requested
        - allocating
        - provisioning
        - running
        - ready
        - finalizing
        - terminating
        - succeeded
        - failed
        - terminated
      type: string
    ComputeStandaloneVolumeMount:
      additionalProperties: false
      properties:
        mount_path:
          pattern: ^/
          type: string
        volume_id:
          type: string
          minLength: 1
      required:
        - volume_id
        - mount_path
      type: object
    ComputeAutoscalerState:
      additionalProperties: false
      properties:
        blocked_reason:
          oneOf:
            - type: string
            - type: 'null'
        drain_timeout_seconds:
          type: integer
          minimum: 1
        evaluation_interval_seconds:
          type: integer
          minimum: 1
        last_scale_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        observed_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        observed_concurrency:
          oneOf:
            - format: int64
              minimum: 0
              type: integer
            - type: 'null'
        recommended_replicas:
          oneOf:
            - type: integer
              minimum: 1
            - type: 'null'
        status:
          enum:
            - disabled
            - active
            - cooling_down
            - blocked
            - unknown
          type: string
      required:
        - status
        - observed_concurrency
        - observed_at
        - recommended_replicas
        - evaluation_interval_seconds
        - drain_timeout_seconds
        - last_scale_at
        - blocked_reason
      type: object
    ComputeScalingReplicas:
      additionalProperties: false
      properties:
        allocated:
          minimum: 0
          type: integer
        applied:
          maximum: 128
          minimum: 0
          type: integer
        applied_generation:
          format: int64
          minimum: 0
          type: integer
        decision:
          enum:
            - create
            - manual
            - autoscaler
          type: string
        desired:
          maximum: 128
          minimum: 1
          type: integer
        desired_generation:
          format: int64
          minimum: 1
          type: integer
        draining:
          minimum: 0
          type: integer
        ready:
          minimum: 0
          type: integer
        updated_at:
          type: string
          format: date-time
      required:
        - desired
        - desired_generation
        - applied
        - applied_generation
        - allocated
        - ready
        - draining
        - decision
        - updated_at
      type: object
    ComputeVolumeData:
      additionalProperties: false
      properties:
        path:
          type: string
        resolved_revision:
          oneOf:
            - type: string
            - type: 'null'
        revision:
          oneOf:
            - type: string
            - type: 'null'
        type:
          enum:
            - huggingface
            - git
          type: string
        url:
          type: string
          format: uri
      required:
        - type
        - url
        - revision
        - resolved_revision
        - path
      type: object
    ComputeError:
      additionalProperties: false
      properties:
        code:
          type: string
        details:
          additionalProperties: true
          type: object
        message:
          type: string
        request_id:
          type: string
      required:
        - code
        - message
        - request_id
      type: object
  responses:
    ComputeError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ComputeErrorEnvelope'
      description: API error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Gateway auth: send `Authorization: Bearer <mka1-api-key>`. For
        multi-user server-side integrations, you can also send `X-On-Behalf-Of:
        <external-user-id>`.

````

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