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

# Criar um conector

> Conecta o agente a um bot do Telegram, valida o token do bot e registra o webhook do agente. É necessária uma chave de API com todos os escopos listados; sua tupla de identidade e os escopos atuais são armazenados como um limite máximo sem ampliação e, em seguida, revalidados com mk-authentication antes de cada execução do conector; contextos de sessão e de usuário final delegado são rejeitados. A política de acesso necessária controla quais chats do Telegram podem invocar o agente.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR post /api/v1/agents/{id}/connectors
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda
    como começar a usar a API e o SDK TypeScript
    [aqui](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietário
servers:
  - url: https://apigw.mka1.com
    description: MKA1 API Gateway
  - url: /
    description: Relative server URL (configurable via SDK constructor)
security: []
tags:
  - name: Resource Authorization
    description: >-
      Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque
      permissões e exclua recursos. Apenas os proprietários dos recursos podem
      conceder, revogar ou excluir permissões.
    x-displayName: Autorização de Recurso
  - name: Embeddings
    description: >-
      Endpoints da API de incorporação de texto para gerar representações
      vetoriais de texto. Crie incorporações semânticas para busca, clustering e
      correspondência de similaridade usando vários modelos de incorporação.
    x-displayName: Incorporações
  - name: Feedback
    description: >-
      API de feedback do usuário para avaliar e comentar sobre as conclusões de
      chat. Coleta de classificações de positivo/negativo e feedback detalhado
      para melhorar as respostas do modelo e acompanhar a satisfação do usuário.
    x-displayName: Feedback
  - name: Images
    description: >-
      Pontos de extremidade da API de geração de imagens para criar imagens a
      partir de descrições de texto. Gere imagens com controle sobre tamanho,
      qualidade e estilo.
    x-displayName: Imagens
  - name: MCP Vault
    description: >-
      API do cofre MCP para armazenar configurações de servidor MCP de
      propriedade do usuário e credenciais criptografadas. Os agentes
      referenciam IDs de cofre para que os segredos sejam resolvidos apenas no
      momento da execução da ferramenta.
    x-displayName: Cofre MCP
  - name: Speech
    description: >-
      Pontos de extremidade da API de fala para processamento de áudio. Converta
      texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em
      diferentes idiomas.
    x-displayName: Discurso
  - name: Usage
    description: >-
      API de rastreamento de uso e análise para monitoramento do consumo de
      tokens, contagem de solicitações e análise de custos. Veja estatísticas
      detalhadas por usuário, modelo e período de tempo.
    x-displayName: Uso
  - name: Extract
    description: >-
      API de extração de dados estruturados para extrair informações de
      arquivos. Defina esquemas JSON para extrair dados estruturados de imagens,
      PDFs e documentos. Suporta modelos de esquema reutilizáveis.
    x-displayName: Extração
  - name: Text Classification
    description: >-
      API de classificação de texto para categorizar textos em rótulos
      predefinidos. Use modelos de IA para classificar o conteúdo textual para
      análise de sentimento, categorização de tópicos e moderação de conteúdo.
    x-displayName: Classificação de Texto
  - name: Responses
    description: >-
      API de respostas com agentes para criar agentes de IA com uso autônomo de
      ferramentas. Crie assistentes conversacionais que podem usar pesquisa na
      web, operações de arquivos, geração de imagens, execução de código,
      simulação de uso de computador e integrações MCP. Suporta processamento em
      segundo plano, streaming e monitoramento de status em tempo real.
    x-displayName: Respostas
  - name: Files
    description: >-
      API de gerenciamento de arquivos para upload, armazenamento e
      gerenciamento de arquivos com expiração automática e integração com S3.
      Faça upload de arquivos que podem ser usados com Assistentes,
      Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são
      armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza
      automática de arquivos expirados.
    x-displayName: Arquivos
  - name: Vector Stores
    description: >-
      API de armazenamento de vetores para armazenar e pesquisar documentos
      usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos
      com divisão automática e geração de embeddings, e realize pesquisas
      semânticas. Os arquivos são processados de forma assíncrona usando fluxos
      de trabalho Temporais para durabilidade. Suporta limpeza automática de
      armazenamentos expirados e LanceDB para armazenamento eficiente de
      vetores.
    x-displayName: Armazenamentos de Vetores
  - name: Conversations
    description: >-
      API de gerenciamento de conversas para armazenar e recuperar o estado da
      conversa durante chamadas à API de Resposta. Crie conversas, adicione
      itens (mensagens do usuário, mensagens do assistente, mensagens do
      sistema) e mantenha o histórico da conversa. Suporta rastreamento de
      metadados e gerenciamento de estado de diálogo em múltiplas interações.
    x-displayName: Conversa
  - name: Guardrails
    description: >-
      API de diretrizes de segurança de IA para configurar moderação de conteúdo
      e políticas de segurança. Configure listas de palavras proibidas, detecção
      de injeção de prompts e prevenção de vazamento de prompts do sistema. As
      diretrizes aplicam-se a todas as solicitações de uma conta e podem ser
      testadas antes da implementação.
    x-displayName: Guarda-corpos
  - name: Models
    description: >-
      API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs
      de modelos, propriedade e metadados de todos os modelos registrados no
      gateway.
    x-displayName: Modelos
  - name: Skills
    description: >-
      API de habilidades para gerenciar pacotes versionados de instruções e
      arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e
      baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md
      para ambientes de agentes.
    x-displayName: Habilidades
  - name: Chat Completions
    description: >-
      **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez
      disso.** Endpoints de conclusão de chat com suporte para streaming,
      chamadas de ferramentas e múltiplos provedores.
    x-deprecated: true
    x-displayName: Conclusões de Bate-Papo
  - name: Batches
    x-displayName: Lotes
  - name: Evals
    x-displayName: Avaliações
  - name: Fine-Tuning
    x-displayName: Ajuste Fino
  - name: Memory Stores
    x-displayName: Armazenamentos de Memória
  - name: Prompts
    x-displayName: Sugestões
  - name: API Key
    x-displayName: Chave da API
  - name: Organization
    x-displayName: Organização
  - name: Cluster Admin
    x-displayName: Administrador do cluster
  - name: Sessions
    description: Crie, inspecione, acesse e encerre sessões de sandbox.
    x-displayName: Sessões
  - name: Browser
    description: >-
      Conecte-se às sessões do navegador através do proxy da porta do gateway.
      As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na
      porta 9222.
    x-displayName: Navegador
  - name: Execution
    description: >-
      Executar comandos shell e código dentro de uma sessão de sandbox
      existente.
    x-displayName: Execução
  - name: Workspace
    description: >-
      Inspecione o manifesto do espaço de trabalho, transfira arquivos ou
      arquivos compactados e baixe artefatos gerados.
    x-displayName: Espaço de trabalho
  - name: Sandbox Usage
    description: >-
      Agregue estatísticas de uso da sandbox entre sessões, execução e operações
      do espaço de trabalho.
    x-displayName: Uso do Sandbox
  - name: Sandbox Pricing
    description: >-
      Gerenciamento de cluster-admin da tabela de preços de computação da
      sandbox usada para gastos orçados.
    x-displayName: Preço da Sandbox
  - name: Agents
    description: Crie e gerencie definições de agentes reutilizáveis.
    x-displayName: Agentes
  - name: Agent Versions
    description: >-
      Inspecione o histórico de configuração de um agente e reverta para uma
      versão anterior.
    x-displayName: Versões do Agente
  - name: Agent Runs
    description: Execute agentes salvos e inspecione os resultados da execução persistidos.
    x-displayName: Executa Agente
  - name: Agent Connectors
    description: Conecte agentes salvos a canais de mensagens externos, como o Telegram.
    x-displayName: Conectores de Agente
  - name: Agent Schedules
    description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes.
    x-displayName: Agendas de Agentes
  - name: schema-4_other
    x-displayName: outro
  - name: Budgets
    x-displayName: Orçamentos
  - name: Settings
    x-displayName: Configurações
  - name: Deployments
    description: Servidores de inferência de longa duração.
    x-displayName: Implantações
  - name: Fine-Tune Jobs
    description: Enviar, monitorar e cancelar trabalhos de fine-tuning.
    x-displayName: Trabalhos de Ajuste Fino
  - name: Container Images
    description: Imagens de contêiner personalizadas para implantações e jobs.
    x-displayName: Imagens de contêineres
  - name: Serving Models
    description: Modelos registrados para implantação e ajuste fino.
    x-displayName: Servindo Modelos
  - name: Volumes
    description: Armazenamento persistente para pesos e checkpoints.
    x-displayName: Volumes
  - name: Secrets
    description: Credenciais injetadas em seus workloads.
    x-displayName: Segredos
  - name: Accelerators
    description: Tipos de aceleradores disponíveis (GPU, NPU, TPU).
    x-displayName: Aceleradores
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: Criar um conector
      description: >-
        Conecta o agente a um bot do Telegram, valida o token do bot e registra
        o webhook do agente. É necessária uma chave de API com todos os escopos
        listados; sua tupla de identidade e os escopos atuais são armazenados
        como um limite máximo sem ampliação e, em seguida, revalidados com
        mk-authentication antes de cada execução do conector; contextos de
        sessão e de usuário final delegado são rejeitados. A política de acesso
        necessária controla quais chats do Telegram podem invocar o agente.
      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: Conector criado e ativado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConnector'
        '400':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: Resposta de erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Resposta de erro
          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: >-
                Token do bot do Telegram emitido pelo BotFather. Ele é
                criptografado em repouso e nunca é retornado pela API.
        access:
          description: >-
            A lista explícita de permissões de chats do Telegram permitida para
            invocar o agente.
          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: >-
            Sempre verdadeiro: o Telegram descarta as atualizações enfileiradas
            antes que o webhook desta instância seja registrado.
    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: >-
            Status do ciclo de vida do conector, como provisionando, ativando,
            ativo, excluindo ou erro.
        provider_account_id:
          type: string
          description: O ID do usuário do bot do Telegram.
        provider_account_name:
          type:
            - string
            - 'null'
          description: O nome de usuário do bot do Telegram quando houver um disponível.
        config:
          $ref: '#/components/schemas/JsonValue'
        credentials_configured:
          type: boolean
          description: >-
            Se credenciais criptografadas do provedor são armazenadas para este
            conector.
        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>`.

````