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

# Define a BYO catalog model

> Creates an API-owned BYO definition without activating its name.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json post /api/v1/llm/models/catalog
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    The MKA1 API is a RESTful API that provides access to the MKA1 platform.
    Learn how to get started with the API and the TypeScript SDK
    [here](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietary
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: >-
      Manage permissions for LLM resources. Create resources, grant/revoke
      permissions, and delete resources. Only resource owners can grant, revoke,
      or delete permissions.
    x-displayName: Resource Authorization
  - name: Audit
    description: >-
      Audit API for org owners and admins. Trace one request end to end by its
      X-Request-ID: API gateway timing, the responses it created, and their
      model invocations and tool calls.
    x-displayName: Audit
  - name: Embeddings
    description: >-
      Text embedding API endpoints for generating vector representations of
      text. Create semantic embeddings for search, clustering, and similarity
      matching using various embedding models.
    x-displayName: Embeddings
  - name: Feedback
    description: >-
      User feedback API for rating and commenting on chat completions. Collect
      thumbs up/down ratings and detailed feedback to improve model responses
      and track user satisfaction.
    x-displayName: Feedback
  - name: Images
    description: >-
      Image generation API endpoints for creating images from text descriptions.
      Generate images with control over size, quality, and style.
    x-displayName: Images
  - name: MCP Vault
    description: >-
      MCP vault API for storing user-owned MCP server configurations and
      encrypted credentials. Agents reference vault IDs so secrets are resolved
      only at tool execution time.
    x-displayName: MCP Vault
  - name: Speech
    description: >-
      Speech API endpoints for audio processing. Convert text to
      natural-sounding speech (TTS) or transcribe speech to text (STT) in
      different languages.
    x-displayName: Speech
  - name: Usage
    description: >-
      Usage tracking and analytics API for monitoring token consumption, request
      counts, and cost analysis. View detailed statistics per user, model, and
      time period.
    x-displayName: Usage
  - name: Extract
    description: >-
      Structured data extraction API for extracting information from files.
      Define JSON schemas to extract structured data from images, PDFs, and
      documents. Supports reusable schema templates.
    x-displayName: Extract
  - name: Text Classification
    description: >-
      Text classification API for categorizing text into predefined labels. Use
      AI models to classify text content for sentiment analysis, topic
      categorization, and content moderation.
    x-displayName: Text Classification
  - name: Responses
    description: >-
      Agent-powered responses API for creating AI agents with autonomous tool
      usage. Build conversational assistants that can use web search, file
      operations, image generation, code execution, and MCP integrations.
      Supports background processing, streaming, and real-time status tracking.
    x-displayName: Responses
  - name: Files
    description: >-
      File management API for uploading, storing, and managing files with
      automatic expiration and S3 integration. Upload files that can be used
      with Assistants, Vector Stores, and other features. Files are stored in S3
      with metadata tracked in PostgreSQL. Supports automatic cleanup of expired
      files.
    x-displayName: Files
  - name: Vector Stores
    description: >-
      Vector store API for storing and searching documents using embeddings.
      Create vector stores, upload files with automatic chunking and embedding
      generation, and perform semantic search. Files are processed
      asynchronously using Temporal workflows for durability. Supports automatic
      cleanup of expired stores and LanceDB for efficient vector storage.
    x-displayName: Vector Stores
  - name: Conversations
    description: >-
      Conversation management API for storing and retrieving conversation state
      across Response API calls. Create conversations, add items (user messages,
      assistant messages, system messages), and maintain conversation history.
      Supports metadata tracking and multi-turn dialogue state management.
    x-displayName: Conversations
  - name: Guardrails
    description: >-
      AI safety guardrails API for configuring content moderation and security
      policies. Set up ban word lists, prompt injection detection, and system
      prompt leakage prevention. Guardrails apply to all requests from an
      account and can be tested before deployment.
    x-displayName: Guardrails
  - name: Models
    description: >-
      Model listing API for discovering available models. Returns model IDs,
      ownership, and metadata for all registered models in the gateway.
    x-displayName: Models
  - name: Skills
    description: >-
      Skills API for managing versioned bundles of instructions and files
      following the Agent Skills standard. Create, version, and download
      reusable skill packages that include SKILL.md manifests for agent
      environments.
    x-displayName: Skills
  - name: Chat Completions
    description: >-
      **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.**
      Chat completion endpoints with support for streaming, tool calls, and
      multiple providers.
    x-deprecated: true
    x-displayName: Chat Completions
  - name: Batches
    x-displayName: Batches
  - name: Evals
    x-displayName: Evals
  - name: Fine-Tuning
    x-displayName: Fine-Tuning
  - name: Memory Stores
    x-displayName: Memory Stores
  - name: Prompts
    x-displayName: Prompts
  - name: API Key
    x-displayName: API Key
  - name: OAuth
    x-displayName: OAuth
  - name: Session
    x-displayName: Session
  - name: Organization
    x-displayName: Organization
  - name: Cluster Admin
    x-displayName: Cluster Admin
  - name: Sessions
    description: Create, inspect, access, and terminate sandbox sessions.
    x-displayName: Sessions
  - name: Browser
    description: >-
      Connect to browser sessions through the gateway port proxy. Browser
      sessions expose a Chrome DevTools Protocol endpoint on port 9222.
    x-displayName: Browser
  - name: Execution
    description: Run shell commands and code inside an existing sandbox session.
    x-displayName: Execution
  - name: Workspace
    description: >-
      Inspect the workspace manifest, transfer files or archives, and download
      generated artifacts.
    x-displayName: Workspace
  - name: Sandbox Usage
    description: >-
      Aggregate sandbox usage statistics across sessions, execution, and
      workspace operations.
    x-displayName: Sandbox Usage
  - name: Sandbox Pricing
    description: >-
      Cluster-admin management of the sandbox compute rate card used for
      budgeted spend.
    x-displayName: Sandbox Pricing
  - name: Sandbox GitHub
    description: >-
      Connect a GitHub account, clone its repositories into sandbox sessions,
      and push branches and open pull requests from a session. The GitHub token
      stays in the sandbox service and never enters a session.
    x-displayName: Sandbox GitHub
  - name: Sandbox Environments
    description: >-
      Save reusable session configuration (repositories, environment variables,
      network access, and a setup script) and run the setup script in a session.
    x-displayName: Sandbox Environments
  - name: Sandbox Connectors
    description: >-
      Connect remote MCP servers (Linear, Notion, Sentry and others) to your
      account so Coding Harness sessions started from an environment that lists
      them can call their tools. The sandbox service keeps each connector's
      credential and never puts it in a session.
    x-displayName: Sandbox Connectors
  - name: Agents
    description: Create and manage reusable agent definitions.
    x-displayName: Agents
  - name: Agent Versions
    description: Inspect an agent's configuration history and roll back to a prior version.
    x-displayName: Agent Versions
  - name: Agent Runs
    description: Execute saved agents and inspect persisted run results.
    x-displayName: Agent Runs
  - name: Agent Connectors
    description: >-
      Connect saved agents to external messaging channels such as Telegram,
      including text, photo, and supported document exchange.
    x-displayName: Agent Connectors
  - name: Agent Schedules
    description: Create and manage scheduled or recurring saved agent runs.
    x-displayName: Agent Schedules
  - name: schema-4_other
    x-displayName: other
  - name: Billing
    x-displayName: Billing
  - name: Budgets
    x-displayName: Budgets
  - name: Settings
    x-displayName: Settings
  - name: Compute Jobs
    x-displayName: Compute Jobs
  - name: Compute Services
    x-displayName: Compute Services
  - name: Compute Catalog
    x-displayName: Compute Catalog
  - name: Compute Volumes
    x-displayName: Compute Volumes
  - name: Compute Pricing
    x-displayName: Compute Pricing
  - name: Compute Secrets
    x-displayName: Compute Secrets
  - name: Compute Usage
    x-displayName: Compute Usage
  - name: Compute Tenants
    x-displayName: Compute Tenants
  - description: Create, list, read, update, and delete repositories.
    name: Repositories
    x-displayName: Repositories
  - name: Tracking Experiments
    description: Create and query tenant experiments.
    x-displayName: Tracking Experiments
  - name: Tracking Runs
    description: Record and retrieve run parameters, metrics, and tags.
    x-displayName: Tracking Runs
  - name: analytics.projects
    x-displayName: Projects
    description: Create, list, rename, and archive analytics projects.
  - name: analytics.keys
    x-displayName: Capture keys
    description: Create and revoke project keys for sending events.
  - name: analytics
    x-displayName: Events
    description: Send events and query event counts or unique visitors.
  - name: analytics.events
    x-displayName: Event search
    description: List individual events with their properties, newest first.
  - name: analytics.visitors
    x-displayName: Visitor search
    description: List visitors by their latest activity, with first and last seen times.
  - name: generators
    x-displayName: generators
  - name: generations
    x-displayName: generations
  - name: formats
    x-displayName: formats
  - description: >-
      Flags, environments, evaluation, and the audit log. Administrative
      operations require a cluster administrator; evaluation uses an
      environment-specific evaluation key.
    name: Feature Flags
    x-displayName: Feature Flags
  - name: Service Status
    description: >-
      Current status of each service and the incident history, for this
      deployment's region.
    x-displayName: Service Status
  - name: Support Cases
    description: >-
      Open and follow support cases. Organization owners and admins see all of
      the organization's cases; other members see the cases they opened.
    x-displayName: Support Cases
paths:
  /api/v1/llm/models/catalog:
    post:
      tags:
        - Models
      summary: Define a BYO catalog model
      description: Creates an API-owned BYO definition without activating its name.
      operationId: addModelCatalogEntry
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCatalogModelRequest'
            example:
              id: meetkai:custom-chat-v1
              provider: openai-compatible
              modelId: custom-chat-v1
              displayName: Custom Chat v1
              baseUrl: https://models.example.com/v1
              apiFormat: responses
              apiProviderType: openai
              created: 1704067200
              auth:
                type: api-key
                value: sk-provider-key
              capabilities:
                modalities:
                  input:
                    - text
                  output:
                    - text
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogEntry'
              example:
                model_id: meetkai:custom-chat-v1
                source: byo
                origin: api
                activation_state: available
                blocker_source: null
                activated_by: null
                activated_at: null
                provider: openai-compatible
                provider_model_id: custom-chat-v1
                definition:
                  id: meetkai:custom-chat-v1
                  provider: openai-compatible
                  modelId: custom-chat-v1
                  displayName: Custom Chat v1
                  baseUrl: https://models.example.com/v1
                  apiFormat: responses
                  apiProviderType: openai
                  created: 1704067200
                  auth:
                    type: api-key
                    value: '****'
                  capabilities:
                    modalities:
                      input:
                        - text
                      output:
                        - text
                  source: database
                  immutable: false
                health:
                  status: unknown
                  is_available: true
                  last_health_check: null
                  error: null
                created_at: 1704067200000
                updated_at: 1704067200000
                effective_price:
                  rates: null
                  source: unpriced
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: csharp
          label: CSharp (SDK)
          source: |-
            using MeetKai.MKA1;
            using MeetKai.MKA1.Types.Components;
            using System.Collections.Generic;

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

            AddCatalogModelRequest req = new AddCatalogModelRequest() {
                Id = "meetkai:custom-chat-v1",
                Provider = "openai-compatible",
                ModelId = "custom-chat-v1",
                DisplayName = "Custom Chat v1",
                BaseUrl = "https://models.example.com/v1",
                ApiFormat = AutoEndpoint.Responses,
                ApiProviderType = AddCatalogModelRequestApiProviderType.Openai,
                Created = 1704067200,
                Auth = AddCatalogModelRequestAuthUnion.CreateApiKey(
                    new AddCatalogModelRequestAuth1() {
                        Value = "sk-provider-key",
                    }
                ),
                Capabilities = new AddCatalogModelRequestCapabilities() {
                    Modalities = new AddCatalogModelRequestModalities() {
                        Input = new List<AddCatalogModelRequestInput>() {
                            AddCatalogModelRequestInput.Text,
                        },
                        Output = new List<AddCatalogModelRequestOutput>() {
                            AddCatalogModelRequestOutput.Text,
                        },
                    },
                    Reasoning = true,
                },
            };

            var res = await sdk.Llm.Models.AddCatalogEntryAsync(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.llm.models.add_catalog_entry(id="meetkai:custom-chat-v1", provider="openai-compatible", model_id="custom-chat-v1", api_format="responses", api_provider_type="openai", created=1704067200, auth={
                    "type": "api-key",
                    "value": "sk-provider-key",
                }, capabilities={
                    "modalities": {
                        "input": [
                            "text",
                        ],
                        "output": [
                            "text",
                        ],
                    },
                    "reasoning": True,
                }, display_name="Custom Chat v1", base_url="https://models.example.com/v1")

                # 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.llm.models.addCatalogEntry({
                id: "meetkai:custom-chat-v1",
                provider: "openai-compatible",
                modelId: "custom-chat-v1",
                displayName: "Custom Chat v1",
                baseUrl: "https://models.example.com/v1",
                apiFormat: "responses",
                apiProviderType: "openai",
                created: 1704067200,
                auth: {
                  type: "api-key",
                  value: "sk-provider-key",
                },
                capabilities: {
                  modalities: {
                    input: [
                      "text",
                    ],
                    output: [
                      "text",
                    ],
                  },
                  reasoning: true,
                },
              });

              console.log(result);
            }

            run();
        - 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\"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.Llm.Models.AddCatalogEntry(ctx, components.AddCatalogModelRequest{\n        ID: \"meetkai:custom-chat-v1\",\n        Provider: \"openai-compatible\",\n        ModelID: \"custom-chat-v1\",\n        DisplayName: mka1.Pointer(\"Custom Chat v1\"),\n        BaseURL: mka1.Pointer(\"https://models.example.com/v1\"),\n        APIFormat: components.AutoEndpointResponses,\n        APIProviderType: components.AddCatalogModelRequestAPIProviderTypeOpenai,\n        Created: 1704067200,\n        Auth: components.CreateAddCatalogModelRequestAuthUnionAPIKey(\n            components.AddCatalogModelRequestAuth1{\n                Value: mka1.Pointer(\"sk-provider-key\"),\n            },\n        ),\n        Capabilities: components.AddCatalogModelRequestCapabilities{\n            Modalities: components.AddCatalogModelRequestModalities{\n                Input: []components.AddCatalogModelRequestInput{\n                    components.AddCatalogModelRequestInputText,\n                },\n                Output: []components.AddCatalogModelRequestOutput{\n                    components.AddCatalogModelRequestOutputText,\n                },\n            },\n            Reasoning: true,\n        },\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.CatalogEntry != nil {\n        // handle response\n    }\n}"
components:
  schemas:
    AddCatalogModelRequest:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ModelId'
        provider:
          type: string
          minLength: 1
          maxLength: 100
        modelId:
          type: string
          minLength: 1
          maxLength: 255
        displayName:
          type: string
        baseUrl:
          type: string
          format: uri
        apiFormat:
          $ref: '#/components/schemas/AutoEndpoint'
        apiProviderType:
          enum:
            - groq
            - meetkai
            - meetkaiGateway
            - openai
            - openrouter
            - cohere
          type: string
        created:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        auth:
          anyOf:
            - type: object
              properties:
                type:
                  const: api-key
                value:
                  type: string
                envVar:
                  type: string
                headerName:
                  type: string
              required:
                - type
              additionalProperties: false
            - type: object
              properties:
                type:
                  const: custom-headers
                headers:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
                envVars:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
              required:
                - type
                - headers
              additionalProperties: false
            - type: object
              properties:
                type:
                  const: none
              required:
                - type
              additionalProperties: false
            - type: object
              properties:
                type:
                  const: composite
                strategies:
                  type: array
                  minItems: 1
                  items:
                    anyOf:
                      - type: object
                        properties:
                          type:
                            const: api-key
                          value:
                            type: string
                          envVar:
                            type: string
                          headerName:
                            type: string
                        required:
                          - type
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            const: custom-headers
                          headers:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: string
                          envVars:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: string
                        required:
                          - type
                          - headers
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            const: none
                        required:
                          - type
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            const: composite
                          strategies:
                            type: array
                            minItems: 1
                            items:
                              anyOf:
                                - type: object
                                  properties:
                                    type:
                                      const: api-key
                                    value:
                                      type: string
                                    envVar:
                                      type: string
                                    headerName:
                                      type: string
                                  required:
                                    - type
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    type:
                                      const: custom-headers
                                    headers:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type: string
                                    envVars:
                                      type: object
                                      propertyNames:
                                        type: string
                                      additionalProperties:
                                        type: string
                                  required:
                                    - type
                                    - headers
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    type:
                                      const: none
                                  required:
                                    - type
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    type:
                                      const: composite
                                    strategies: {}
                                  required:
                                    - type
                                  additionalProperties: false
                        required:
                          - type
                          - strategies
                        additionalProperties: false
              required:
                - type
                - strategies
              additionalProperties: false
        capabilities:
          type: object
          properties:
            modalities:
              type: object
              properties:
                input:
                  type: array
                  minItems: 1
                  items:
                    enum:
                      - text
                      - image
                      - audio
                      - video
                    type: string
                output:
                  type: array
                  minItems: 1
                  items:
                    enum:
                      - text
                      - image
                      - audio
                      - video
                    type: string
              required:
                - input
                - output
              additionalProperties: false
            reasoning:
              type: boolean
            supportsReasoningEffort:
              type: boolean
            supportedBase64Formats:
              type: array
              items:
                type: string
            supportsCompletionVideoUrlMessage:
              type: boolean
            supportsStructuredOutputs:
              type: boolean
            supportsTemperature:
              type: boolean
            supportsTopP:
              type: boolean
            supportsImageDetailOriginal:
              type: boolean
            maxImageResolution:
              type: object
              properties:
                maxWidth:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                maxHeight:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
              required:
                - maxWidth
                - maxHeight
              additionalProperties: false
            minImageResolution:
              type: object
              properties:
                maxWidth:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                maxHeight:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
              required:
                - maxWidth
                - maxHeight
              additionalProperties: false
          required:
            - modalities
            - reasoning
          additionalProperties: false
        contextWindow:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          exclusiveMinimum: 0
        rpm:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          exclusiveMinimum: 0
        rateLimits:
          type: array
          items:
            type: object
            properties:
              scope:
                enum:
                  - global
                  - org
                  - user
                  - apiKey
                  - externalUser
                type: string
              rpm:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                exclusiveMinimum: 0
              tpm:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                exclusiveMinimum: 0
              duration:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                exclusiveMinimum: 0
              queue:
                type: object
                properties:
                  maxDepth:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 1000
                    exclusiveMinimum: 0
                  maxWaitMs:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 120000
                    exclusiveMinimum: 0
                required:
                  - maxDepth
                  - maxWaitMs
                additionalProperties: false
            required:
              - scope
            additionalProperties: false
        concurrency:
          type: object
          properties:
            max:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              exclusiveMinimum: 0
            maxWaitMs:
              type: integer
              minimum: -9007199254740991
              maximum: 120000
              exclusiveMinimum: 0
          required:
            - max
          additionalProperties: false
        requestTimeoutMs:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          exclusiveMinimum: 0
        maxRetries:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        defaultParams:
          type: object
          properties:
            temperature:
              type: number
              minimum: 0
              maximum: 2
            topP:
              type: number
              minimum: 0
              maximum: 1
            presencePenalty:
              type: number
              minimum: -2
              maximum: 2
            frequencyPenalty:
              type: number
              minimum: -2
              maximum: 2
          additionalProperties: false
        rerouteRules:
          type: array
          items:
            type: object
            properties:
              trigger:
                anyOf:
                  - type: object
                    properties:
                      type:
                        const: input-modality
                      modality:
                        enum:
                          - text
                          - image
                          - audio
                          - video
                        type: string
                    required:
                      - type
                      - modality
                    additionalProperties: false
                  - type: object
                    properties:
                      type:
                        const: error-fallback
                    required:
                      - type
                    additionalProperties: false
              targetModelId:
                type: string
              preserveParams:
                type: boolean
              log:
                type: boolean
            required:
              - trigger
              - targetModelId
            additionalProperties: false
        hidden:
          type: boolean
        embeddingLimits:
          type: object
          properties:
            maxBatchSize:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              exclusiveMinimum: 0
            maxBatchTokens:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              exclusiveMinimum: 0
            dimensions:
              anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                - type: object
                  properties:
                    min:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                      exclusiveMinimum: 0
                    max:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                      exclusiveMinimum: 0
                    default:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                      exclusiveMinimum: 0
                  required:
                    - min
                    - max
                    - default
                  additionalProperties: false
          additionalProperties: false
        healthCheck:
          anyOf:
            - type: object
              properties:
                mode:
                  const: 'off'
              required:
                - mode
              additionalProperties: false
            - type: object
              properties:
                mode:
                  const: preflight
                path:
                  type: string
                  minLength: 1
                method:
                  enum:
                    - GET
                    - HEAD
                  type: string
                timeoutMs:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                cacheTtlSeconds:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
              required:
                - mode
                - path
              additionalProperties: false
            - type: object
              properties:
                mode:
                  const: periodic
                intervalSeconds:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                path:
                  type: string
                  minLength: 1
                method:
                  enum:
                    - GET
                    - HEAD
                  type: string
                timeoutMs:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
                cacheTtlSeconds:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                  exclusiveMinimum: 0
              required:
                - mode
                - intervalSeconds
                - path
              additionalProperties: false
        modelCard:
          type: object
          properties:
            developer:
              type: string
              minLength: 1
              maxLength: 100
            baseModel:
              type: string
              minLength: 1
              maxLength: 255
            weights:
              enum:
                - open
                - closed
              type: string
            license:
              type: string
              minLength: 1
              maxLength: 100
              pattern: ^[a-z0-9][a-z0-9.+-]*$
            languages:
              type: array
              minItems: 1
              maxItems: 64
              items:
                type: string
            limitations:
              type: string
              minLength: 1
              maxLength: 2000
            parameterCount:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              exclusiveMinimum: 0
            activeParameterCount:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              exclusiveMinimum: 0
            releaseDate:
              type: string
              format: date
            servingLocations:
              type: array
              minItems: 1
              maxItems: 16
              items:
                type: string
                pattern: ^[A-Za-z0-9][A-Za-z0-9:._-]{0,63}$
          additionalProperties: false
        lifecycle:
          $ref: '#/components/schemas/CatalogLifecycle'
      required:
        - id
        - provider
        - modelId
        - apiFormat
        - apiProviderType
        - created
        - auth
        - capabilities
      additionalProperties: false
    CatalogEntry:
      type: object
      properties:
        model_id:
          type: string
        source:
          $ref: '#/components/schemas/RegistrySource'
        origin:
          anyOf:
            - $ref: '#/components/schemas/RegistryModelOrigin'
            - type: 'null'
        activation_state:
          $ref: '#/components/schemas/CatalogActivationState'
        blocker_source:
          anyOf:
            - $ref: '#/components/schemas/RegistrySource'
            - type: 'null'
        activated_by:
          anyOf:
            - type: string
            - type: 'null'
        activated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        provider:
          type: string
        provider_model_id:
          type: string
        definition:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        health:
          $ref: '#/components/schemas/CatalogHealth'
        created_at:
          anyOf:
            - type: number
            - type: 'null'
        updated_at:
          anyOf:
            - type: number
            - type: 'null'
        effective_price:
          $ref: '#/components/schemas/CatalogPricePreview'
      required:
        - model_id
        - source
        - origin
        - activation_state
        - blocker_source
        - activated_by
        - activated_at
        - provider
        - provider_model_id
        - definition
        - health
        - created_at
        - updated_at
        - effective_price
    ModelId:
      type: string
      minLength: 1
      maxLength: 255
    AutoEndpoint:
      enum:
        - responses
        - completions
        - embeddings
        - images
        - transcriptions
        - tts
        - rerank
      type: string
    CatalogLifecycle:
      type: object
      properties:
        status:
          enum:
            - active
            - deprecated
            - retired
          type: string
        deprecatedAt:
          type: string
          format: date
        retiresAt:
          type: string
          format: date
        successor:
          type: string
          minLength: 1
          maxLength: 255
      required:
        - status
      additionalProperties: false
    RegistrySource:
      enum:
        - byo
        - serving
        - cluster
      type: string
    RegistryModelOrigin:
      enum:
        - api
        - yaml
      type: string
    CatalogActivationState:
      enum:
        - active
        - available
        - available_name_blocked
      type: string
    CatalogHealth:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/CatalogHealthStatus'
        is_available:
          type: boolean
          deprecated: true
          description: >-
            Deprecated: read `status`. False only when `status` is
            `unavailable`, so it is also true when health is unknown.
        last_health_check:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            Epoch ms when the verdict's probe started; null when there is no
            verdict.
        error:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Why the verdict is unavailable; null when it is available or there
            is no verdict.
      required:
        - status
        - is_available
        - last_health_check
        - error
    CatalogPricePreview:
      type: object
      properties:
        rates:
          anyOf:
            - type: object
              properties:
                input_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                output_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                cached_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                reasoning_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                batch_input_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                  description: >-
                    Per 1M input tokens for requests run through POST /batches;
                    falls back to input_tokens.
                batch_output_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                  description: >-
                    Per 1M output tokens for batch requests; falls back to
                    output_tokens.
                batch_cached_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                  description: >-
                    Per 1M cached input tokens for batch requests; falls back to
                    batch_input_tokens when that is set, else cached_tokens.
                batch_reasoning_tokens:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                  description: >-
                    Per 1M reasoning tokens for batch requests; falls back to
                    batch_output_tokens when that is set, else reasoning_tokens.
                characters:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                seconds:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                image:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                image_tiers:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: number
                    minimum: 0
                    maximum: 1000000000
                searches:
                  type: number
                  minimum: 0
                  maximum: 1000000000
              additionalProperties: false
            - type: 'null'
        source:
          enum:
            - org_override
            - cluster_default
            - unpriced
          type: string
      required:
        - rates
        - source
    CatalogHealthStatus:
      enum:
        - available
        - unavailable
        - unknown
      type: string
      description: >-
        Provider health from the latest probe verdict: `available` or
        `unavailable`. `unknown` when there is no verdict: the definition has no
        health check, or its check has not run yet or its last verdict expired.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Send Authorization: Bearer <credential>, using an MKA1 API key for
        automation or an OAuth API access token for a signed-in application. Use
        a dynamic security callback to refresh OAuth access tokens. Browser
        session-only operations still require their declared cookie.

````

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