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

# Create a model alias

> Claims `name` in the organization's registry and ranks the candidates once before returning. From then on a request for `name` is served by the candidate that scores best on the metric in the suite's active version, and is billed as that model. A name that is already active returns 409.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json post /api/v1/llm/models/aliases
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: Tool Policy
    description: >-
      Organization tool policy API. Org admins deny tool types, or require
      approval before their calls run, for every Responses request in the
      organization, including saved agent runs. The policy overrides what
      requests and agents configure.
    x-displayName: Tool Policy
  - 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/aliases:
    post:
      tags:
        - Models
      summary: Create a model alias
      description: >-
        Claims `name` in the organization's registry and ranks the candidates
        once before returning. From then on a request for `name` is served by
        the candidate that scores best on the metric in the suite's active
        version, and is billed as that model. A name that is already active
        returns 409.
      operationId: createModelAlias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModelAliasRequest'
            example:
              name: best-math-model
              suite_id: eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a
              metric: accuracy
              candidate_model_ids:
                - meetkai:functionary-pt
                - meetkai:functionary-es
              default_model_id: meetkai:functionary-pt
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelAlias'
              example:
                object: model.alias
                name: best-math-model
                suite_id: eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a
                suite_version: 3
                metric: accuracy
                higher_is_better: true
                task_id: null
                candidate_model_ids:
                  - meetkai:functionary-pt
                  - meetkai:functionary-es
                api_format: responses
                default_model_id: meetkai:functionary-pt
                pinned_model_id: null
                current_model_id: meetkai:functionary-es
                served_model_id: meetkai:functionary-es
                served_because: benchmark
                state: ok
                resolvable: true
                standings:
                  - model_id: meetkai:functionary-pt
                    score: 0.81
                    run_id: eval_run_5e1f7c3a-92b4-4d68-8f0a-b3c9d2e6a1f4
                    completed_at: '2026-11-09T02:14:00.000Z'
                    sample_count: 500
                    failed_count: 0
                    eligible: true
                    ineligible_reason: null
                  - model_id: meetkai:functionary-es
                    score: 0.86
                    run_id: eval_run_5e1f7c3a-92b4-4d68-8f0a-b3c9d2e6a1f4
                    completed_at: '2026-11-09T02:14:00.000Z'
                    sample_count: 500
                    failed_count: 0
                    eligible: true
                    ineligible_reason: null
                evaluated_at: '2026-11-09T02:14:05.000Z'
                created_by: user-org-admin-1
                created_at: '2026-11-01T18:00:00.000Z'
                updated_by: user-org-admin-1
                updated_at: '2026-11-01T18:00:00.000Z'
      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/optionalnullable\"\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.CreateAlias(ctx, components.CreateModelAliasRequest{\n        Name: \"best-math-model\",\n        SuiteID: \"eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a\",\n        Metric: \"accuracy\",\n        CandidateModelIds: []string{\n            \"meetkai:functionary-pt\",\n            \"meetkai:functionary-es\",\n        },\n        DefaultModelID: optionalnullable.From(mka1.Pointer(\"meetkai:functionary-pt\")),\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.ModelAlias != nil {\n        // handle response\n    }\n}"
        - 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>");

            CreateModelAliasRequest req = new CreateModelAliasRequest() {
                Name = "best-math-model",
                SuiteId = "eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a",
                Metric = "accuracy",
                CandidateModelIds = new List<string>() {
                    "meetkai:functionary-pt",
                    "meetkai:functionary-es",
                },
                DefaultModelId = "meetkai:functionary-pt",
            };

            var res = await sdk.Llm.Models.CreateAliasAsync(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.create_alias(name="best-math-model", suite_id="eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a", metric="accuracy", candidate_model_ids=[
                    "meetkai:functionary-pt",
                    "meetkai:functionary-es",
                ], default_model_id="meetkai:functionary-pt")

                # 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.createAlias({
                name: "best-math-model",
                suiteId: "eval_suite_0b9c2a1e-7d43-4f0e-9a51-2c6f8e1d4b7a",
                metric: "accuracy",
                candidateModelIds: [
                  "meetkai:functionary-pt",
                  "meetkai:functionary-es",
                ],
                defaultModelId: "meetkai:functionary-pt",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    CreateModelAliasRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: >-
            The model name callers use. It is claimed in the organization's
            registry, so it must not already be active.
        suite_id:
          type: string
          minLength: 1
          maxLength: 255
          description: An eval suite owned by this organization.
        metric:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            A metric id the suite's active version declares. Its
            `higher_is_better` decides which score wins.
        task_id:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 255
            - type: 'null'
          description: >-
            A task of the suite to rank on. Null ranks the metric averaged over
            every task, counting only runs that cover every task of the version.
        candidate_model_ids:
          type: array
          minItems: 2
          maxItems: 16
          items:
            $ref: '#/components/schemas/ModelId'
          description: >-
            Two to 16 active models of one API format. The alias only ever
            serves one of these. Order breaks ties: the earlier model wins an
            equal score.
        default_model_id:
          anyOf:
            - $ref: '#/components/schemas/ModelId'
            - type: 'null'
          description: >-
            A candidate to serve until a first winner exists. Null leaves the
            alias unresolvable until then.
      required:
        - name
        - suite_id
        - metric
        - candidate_model_ids
      additionalProperties: false
    ModelAlias:
      type: object
      properties:
        object:
          const: model.alias
        name:
          type: string
        suite_id:
          type: string
        suite_version:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            The suite version the last recompute ranked. Null before one could
            be read.
        metric:
          type: string
        higher_is_better:
          anyOf:
            - type: boolean
            - type: 'null'
        task_id:
          anyOf:
            - type: string
            - type: 'null'
        candidate_model_ids:
          type: array
          items:
            type: string
        api_format:
          $ref: '#/components/schemas/AutoEndpoint'
        default_model_id:
          anyOf:
            - type: string
            - type: 'null'
        pinned_model_id:
          anyOf:
            - type: string
            - type: 'null'
        current_model_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The benchmark winner. Null until one exists.
        served_model_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            What a request for the alias is served by: the pin, else the winner,
            else the default.
        served_because:
          anyOf:
            - $ref: '#/components/schemas/ModelAliasServedBecause'
            - type: 'null'
        state:
          enum:
            - ok
            - waiting_for_results
            - metric_missing
            - suite_missing
          type: string
          description: >-
            `ok`: serving a ranked winner. `waiting_for_results`: no complete
            result to rank yet, so the last winner or the default holds.
            `metric_missing`: the suite's active version no longer declares the
            metric or task. `suite_missing`: the suite was deleted. The last two
            hold the last winner until the alias is edited.
        resolvable:
          type: boolean
          description: >-
            Whether a request for the alias resolves right now: it serves a
            model that is still active in the registry.
        standings:
          type: array
          items:
            $ref: '#/components/schemas/ModelAliasStanding'
        evaluated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        created_by:
          type: string
        created_at:
          type: string
          format: date-time
        updated_by:
          type: string
        updated_at:
          type: string
          format: date-time
      required:
        - object
        - name
        - suite_id
        - suite_version
        - metric
        - higher_is_better
        - task_id
        - candidate_model_ids
        - api_format
        - default_model_id
        - pinned_model_id
        - current_model_id
        - served_model_id
        - served_because
        - state
        - resolvable
        - standings
        - evaluated_at
        - created_by
        - created_at
        - updated_by
        - updated_at
    ModelId:
      type: string
      minLength: 1
      maxLength: 255
    AutoEndpoint:
      enum:
        - responses
        - completions
        - embeddings
        - images
        - transcriptions
        - tts
        - rerank
      type: string
    ModelAliasServedBecause:
      enum:
        - pinned
        - benchmark
        - default
      type: string
    ModelAliasStanding:
      type: object
      properties:
        model_id:
          type: string
        score:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The candidate's latest value of the metric in the suite's active
            version.
        run_id:
          anyOf:
            - type: string
            - type: 'null'
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        sample_count:
          anyOf:
            - type: number
            - type: 'null'
        failed_count:
          anyOf:
            - type: number
            - type: 'null'
        eligible:
          type: boolean
        ineligible_reason:
          anyOf:
            - enum:
                - inactive
                - api_format_changed
                - no_result
                - failed_samples
              type: string
            - type: 'null'
          description: >-
            `inactive`: no longer active in the registry, or its definition no
            longer loads. `api_format_changed`: still active, but its definition
            now has another API format than the alias. `no_result`: no completed
            run of the active suite version carries the metric.
            `failed_samples`: the latest result has failed samples, so it is
            partial.
      required:
        - model_id
        - score
        - run_id
        - completed_at
        - sample_count
        - failed_count
        - eligible
        - ineligible_reason
  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.