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

> Connects the agent to a Telegram bot, validates the bot token, and registers the agent's webhook. An API key with every listed scope is required; its identity tuple and current scopes are stored as a non-widening ceiling, then revalidated with mk-authentication before every connector run; session and delegated end-user contexts are rejected. The required access policy controls which Telegram chats may invoke the agent.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json post /api/v1/agents/{id}/connectors
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: 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, computer use simulation, 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: 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: 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.
    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: Budgets
    x-displayName: Budgets
  - name: Settings
    x-displayName: Settings
  - name: Deployments
    description: Long-lived inference servers.
    x-displayName: Deployments
  - name: Fine-Tune Jobs
    description: Submit, monitor, and cancel fine-tune jobs.
    x-displayName: Fine-Tune Jobs
  - name: Container Images
    description: Custom container images for deployments and jobs.
    x-displayName: Container Images
  - name: Serving Models
    description: Models registered for deployment and fine-tuning.
    x-displayName: Serving Models
  - name: Volumes
    description: Persistent storage for weights and checkpoints.
    x-displayName: Volumes
  - name: Secrets
    description: Credentials injected into your workloads.
    x-displayName: Secrets
  - name: Accelerators
    description: Available accelerator types (GPU, NPU, TPU).
    x-displayName: Accelerators
paths:
  /api/v1/agents/{id}/connectors:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The agent ID.
    post:
      tags:
        - Agent Connectors
      summary: Create a connector
      description: >-
        Connects the agent to a Telegram bot, validates the bot token, and
        registers the agent's webhook. An API key with every listed scope is
        required; its identity tuple and current scopes are stored as a
        non-widening ceiling, then revalidated with mk-authentication before
        every connector run; session and delegated end-user contexts are
        rejected. The required access policy controls which Telegram chats may
        invoke the agent.
      operationId: createAgentConnector
      parameters:
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentConnectorRequest'
            example:
              provider: telegram
              name: support-bot
              credentials:
                bot_token: 123456789:replace-with-telegram-bot-token
              access:
                mode: allowlist
                chat_ids:
                  - 123456789
              drop_pending_updates: true
      responses:
        '201':
          description: Connector created and activated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConnector'
        '400':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


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

                res = sdk.agent_connectors.create_agent_connector(id="<id>", provider="telegram", credentials={
                    "bot_token": "123456789:replace-with-telegram-bot-token",
                }, access={
                    "mode": "allowlist",
                    "chat_ids": [
                        123456789,
                    ],
                }, name="support-bot")

                # 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.agentConnectors.createAgentConnector({
                id: "<id>",
                createAgentConnectorRequest: {
                  provider: "telegram",
                  name: "support-bot",
                  credentials: {
                    botToken: "123456789:replace-with-telegram-bot-token",
                  },
                  access: {
                    mode: "allowlist",
                    chatIds: [
                      123456789,
                    ],
                  },
                },
              });

              console.log(result);
            }

            run();
        - 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>");

            var res = await sdk.AgentConnectors.CreateAgentConnectorAsync(
                id: "<id>",
                body: new MeetKai.MKA1.Types.Components.CreateAgentConnectorRequest() {
                    Provider = CreateAgentConnectorRequestProvider.Telegram,
                    Name = "support-bot",
                    Credentials = new Credentials() {
                        BotToken = "123456789:replace-with-telegram-bot-token",
                    },
                    Access = new CreateAgentConnectorRequestAccess() {
                        Mode = CreateAgentConnectorRequestMode.Allowlist,
                        ChatIds = new List<long>() {
                            123456789,
                        },
                    },
                }
            );

            // handle response
components:
  schemas:
    CreateAgentConnectorRequest:
      type: object
      additionalProperties: false
      required:
        - provider
        - credentials
        - access
      properties:
        provider:
          type: string
          enum:
            - telegram
        name:
          type: string
          minLength: 1
          maxLength: 120
        credentials:
          type: object
          additionalProperties: false
          required:
            - bot_token
          properties:
            bot_token:
              type: string
              minLength: 1
              writeOnly: true
              description: >-
                Telegram bot token issued by BotFather. It is encrypted at rest
                and is never returned by the API.
        access:
          description: The explicit Telegram chat allowlist permitted to invoke the agent.
          type: object
          additionalProperties: false
          required:
            - mode
            - chat_ids
          properties:
            mode:
              type: string
              enum:
                - allowlist
            chat_ids:
              type: array
              minItems: 1
              maxItems: 100
              items:
                type: integer
                format: int64
        drop_pending_updates:
          type: boolean
          enum:
            - true
          default: true
          description: >-
            Always true: Telegram discards updates queued before this tenancy's
            webhook is registered.
    AgentConnector:
      type: object
      additionalProperties: false
      required:
        - object
        - id
        - agent_id
        - provider
        - name
        - status
        - provider_account_id
        - provider_account_name
        - config
        - credentials_configured
        - last_error
        - created_at
        - updated_at
        - deleted_at
      properties:
        object:
          type: string
          enum:
            - agent.connector
        id:
          type: string
        agent_id:
          type: string
        provider:
          type: string
          enum:
            - telegram
        name:
          type:
            - string
            - 'null'
        status:
          type: string
          description: >-
            Connector lifecycle status, such as provisioning, activating,
            active, deleting, or error.
        provider_account_id:
          type: string
          description: The Telegram bot user ID.
        provider_account_name:
          type:
            - string
            - 'null'
          description: The Telegram bot username when one is available.
        config:
          $ref: '#/components/schemas/JsonValue'
        credentials_configured:
          type: boolean
          description: >-
            Whether encrypted provider credentials are stored for this
            connector.
        last_error:
          oneOf:
            - $ref: '#/components/schemas/JsonValue'
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
            details:
              oneOf:
                - $ref: '#/components/schemas/JsonValue'
                - type: 'null'
    JsonValue:
      oneOf:
        - type: string
        - type: number
        - type: integer
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
  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>`.

````