Python (SDK)

from meetkai_mka1 import SDK


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

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

    # Handle response
    print(res)

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,
        ],
      },
      dropPendingUpdates: true,
    },
  });

  console.log(result);
}

run();

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: MeetKai.MKA1.Types.Components.CreateAgentConnectorRequest.CreateTelegram(
        new CreateTelegramAgentConnectorRequest() {
            Provider = CreateTelegramAgentConnectorRequestProvider.Telegram,
            Name = "support-bot",
            Credentials = new CreateTelegramAgentConnectorRequestCredentials() {
                BotToken = "123456789:replace-with-telegram-bot-token",
            },
            Access = new CreateTelegramAgentConnectorRequestAccess() {
                Mode = CreateTelegramAgentConnectorRequestMode.Allowlist,
                ChatIds = new List<long>() {
                    123456789,
                },
            },
        }
    )
);

// handle response

curl --request POST \
  --url https://apigw.mka1.com/api/v1/agents/{id}/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "telegram",
  "name": "support-bot",
  "credentials": {
    "bot_token": "123456789:replace-with-telegram-bot-token"
  },
  "access": {
    "mode": "allowlist",
    "chat_ids": [
      123456789
    ]
  },
  "drop_pending_updates": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    provider: 'telegram',
    name: 'support-bot',
    credentials: {bot_token: '123456789:replace-with-telegram-bot-token'},
    access: {mode: 'allowlist', chat_ids: [123456789]},
    drop_pending_updates: true
  })
};

fetch('https://apigw.mka1.com/api/v1/agents/{id}/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/agents/{id}/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'provider' => 'telegram',
    'name' => 'support-bot',
    'credentials' => [
        'bot_token' => '123456789:replace-with-telegram-bot-token'
    ],
    'access' => [
        'mode' => 'allowlist',
        'chat_ids' => [
                123456789
        ]
    ],
    'drop_pending_updates' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apigw.mka1.com/api/v1/agents/{id}/connectors"

	payload := strings.NewReader("{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/agents/{id}/connectors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/agents/{id}/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}"

response = http.request(request)
puts response.read_body

{
  "object": "agent.connector",
  "id": "<string>",
  "agent_id": "<string>",
  "provider": "telegram",
  "name": "<string>",
  "status": "<string>",
  "provider_account_id": "<string>",
  "provider_account_name": "<string>",
  "config": "<unknown>",
  "credentials_configured": true,
  "last_error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

Agent Connectors

Crear un conector

Conecta el agente a un bot de Telegram o a un número de teléfono de WhatsApp Business, valida las credenciales del proveedor y registra el webhook del agente. La compatibilidad con el conector de WhatsApp está en fase beta. Los textos, fotos y documentos admitidos por la pasarela pueden invocar al agente; los medios entrantes además requieren write:files. Los archivos salientes administrados requieren read:files, y las imágenes generadas requieren ambos ámbitos de archivos para que sus URL transitorias del proveedor puedan materializarse antes de la entrega. El ámbito opcional write:feedback habilita la sincronización nativa de reacciones de pulgar hacia el feedback de respuesta de la pasarela. Estos ámbitos condicionales no forman deliberadamente parte de x-required-scopes porque los conectores solo de texto no los necesitan. Se requiere una clave de API con todos los ámbitos enumerados; su tupla de identidad y los ámbitos actuales se almacenan como un techo no ampliable, y luego se revalidan con mk-authentication antes de cada ejecución del conector; se rechazan los contextos de sesión y los contextos delegados del usuario final. La política de acceso requerida controla qué usuarios o chats del proveedor pueden invocar al agente.

POST

api

agents

{id}

connectors

Python (SDK)

from meetkai_mka1 import SDK


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

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

    # Handle response
    print(res)

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,
        ],
      },
      dropPendingUpdates: true,
    },
  });

  console.log(result);
}

run();

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: MeetKai.MKA1.Types.Components.CreateAgentConnectorRequest.CreateTelegram(
        new CreateTelegramAgentConnectorRequest() {
            Provider = CreateTelegramAgentConnectorRequestProvider.Telegram,
            Name = "support-bot",
            Credentials = new CreateTelegramAgentConnectorRequestCredentials() {
                BotToken = "123456789:replace-with-telegram-bot-token",
            },
            Access = new CreateTelegramAgentConnectorRequestAccess() {
                Mode = CreateTelegramAgentConnectorRequestMode.Allowlist,
                ChatIds = new List<long>() {
                    123456789,
                },
            },
        }
    )
);

// handle response

curl --request POST \
  --url https://apigw.mka1.com/api/v1/agents/{id}/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "telegram",
  "name": "support-bot",
  "credentials": {
    "bot_token": "123456789:replace-with-telegram-bot-token"
  },
  "access": {
    "mode": "allowlist",
    "chat_ids": [
      123456789
    ]
  },
  "drop_pending_updates": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    provider: 'telegram',
    name: 'support-bot',
    credentials: {bot_token: '123456789:replace-with-telegram-bot-token'},
    access: {mode: 'allowlist', chat_ids: [123456789]},
    drop_pending_updates: true
  })
};

fetch('https://apigw.mka1.com/api/v1/agents/{id}/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/agents/{id}/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'provider' => 'telegram',
    'name' => 'support-bot',
    'credentials' => [
        'bot_token' => '123456789:replace-with-telegram-bot-token'
    ],
    'access' => [
        'mode' => 'allowlist',
        'chat_ids' => [
                123456789
        ]
    ],
    'drop_pending_updates' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apigw.mka1.com/api/v1/agents/{id}/connectors"

	payload := strings.NewReader("{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/agents/{id}/connectors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/agents/{id}/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"telegram\",\n  \"name\": \"support-bot\",\n  \"credentials\": {\n    \"bot_token\": \"123456789:replace-with-telegram-bot-token\"\n  },\n  \"access\": {\n    \"mode\": \"allowlist\",\n    \"chat_ids\": [\n      123456789\n    ]\n  },\n  \"drop_pending_updates\": true\n}"

response = http.request(request)
puts response.read_body

{
  "object": "agent.connector",
  "id": "<string>",
  "agent_id": "<string>",
  "provider": "telegram",
  "name": "<string>",
  "status": "<string>",
  "provider_account_id": "<string>",
  "provider_account_name": "<string>",
  "config": "<unknown>",
  "credentials_configured": true,
  "last_error": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  }
}

Autorizaciones

Authorization

string

header

requerido

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

Encabezados

X-On-Behalf-Of

string

Optional external end-user identifier forwarded by the API gateway.

Parámetros de ruta

string

requerido

The agent ID.

Cuerpo

application/json

Option 1
Option 2

provider

enum<string>

requerido

Conector de la API de bots de Telegram. Admite texto, fotos de hasta el límite de descarga de 20 MiB de la API de bots, documentos compatibles con la pasarela y comentarios de respuesta mediante reacciones nativas de pulgar arriba y pulgar abajo.

Opciones disponibles:

telegram

credentials

object

requerido

Show child attributes

access

object

requerido

La lista de permitidos explícita del chat de Telegram permitió invocar al agente.

Show child attributes

name

string

Required string length: 1 - 120

drop_pending_updates

enum<boolean>

predeterminado:true

Siempre es cierto: Telegram descarta las actualizaciones en cola antes de que se registre el webhook de esta inquilinidad.

Opciones disponibles:

true

Respuesta

Conector creado y activado.

object

enum<string>

requerido

Opciones disponibles:

agent.connector

string

requerido

agent_id

string

requerido

provider

enum<string>

requerido

Opciones disponibles:

telegram,

whatsapp

name

string | null

requerido

status

string

requerido

Estado del ciclo de vida del conector, como aprovisionamiento, activación, activo, eliminación o error.

provider_account_id

string

requerido

ID de la cuenta del proveedor: ID de usuario del bot de Telegram o ID del número de teléfono de WhatsApp.

provider_account_name

string | null

requerido

Nombre para mostrar de la cuenta del proveedor cuando esté disponible.

config

any

requerido

Valor JSON arbitrario.

credentials_configured

boolean

requerido

Si se almacenan credenciales cifradas del proveedor para este conector.

last_error

any | null

requerido

Valor JSON arbitrario.

created_at

string<date-time>

requerido

updated_at

string<date-time>

requerido

deleted_at

string<date-time> | null

requerido

⌘I

Responses API

Agents API

Platform APIs

Administration

Sandbox API

Compute API

Repositories API

Deprecated

Other

Crear un conector

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta