Typescript (SDK)

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

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

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,
            ],
        },
    })

    # Handle response
    print(res)

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
    ]
  }
}
'

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]}
  })
};

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
        ]
    ]
  ]),
  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}")

	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}")
  .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}"

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

Criar um conector

Conecta o agente a um bot do Telegram ou a um número de telefone do WhatsApp Business, valida as credenciais do provedor e registra o webhook do agente. O suporte ao conector do WhatsApp está em beta. Texto, fotos e documentos compatíveis com o gateway podem invocar o agente; mídia de entrada também exige write:files. Arquivos de saída gerenciados exigem read:files, e imagens geradas exigem ambos os escopos de arquivo para que seus URLs transitórios do provedor possam ser materializados antes da entrega. O escopo opcional write:feedback habilita a sincronização nativa de reações de polegar com o feedback da resposta do gateway. Esses escopos condicionais não fazem parte de x-required-scopes de propósito, porque conectores apenas de texto não precisam deles. É necessária uma chave de API com todos os escopos listados; sua tupla de identidade e os escopos atuais são armazenados como um teto sem ampliação, e então 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 exigida controla quais usuários ou chats do provedor podem invocar o agente.

POST

api

agents

{id}

connectors

Typescript (SDK)

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

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

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,
            ],
        },
    })

    # Handle response
    print(res)

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
    ]
  }
}
'

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]}
  })
};

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
        ]
    ]
  ]),
  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}")

	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}")
  .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}"

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>"
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

X-On-Behalf-Of

string

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

Parâmetros de caminho

string

obrigatório

The agent ID.

Corpo

application/json

Option 1
Option 2

Configuração do conector do Telegram. Criar ou ativar um conector sempre descarta as atualizações pendentes do Telegram, de modo que eventos de uma vinculação anterior do bot não possam ser entregues a este agente.

provider

enum<string>

obrigatório

Conector da API do Bot do Telegram. Suporta texto, fotos de até o limite de download de 20 MiB da API do Bot, documentos compatíveis com o gateway e feedback de resposta por meio de reações nativas de polegar.

Opções disponíveis:

telegram

credentials

object

obrigatório

Show child attributes

access

object

obrigatório

A lista explícita de permissões de chats do Telegram permitida para invocar o agente.

Show child attributes

name

string

Required string length: 1 - 120

Resposta

Conector criado e ativado.

object

enum<string>

obrigatório

Opções disponíveis:

agent.connector

string

obrigatório

agent_id

string

obrigatório

provider

enum<string>

obrigatório

Opções disponíveis:

telegram,

whatsapp

name

string | null

obrigatório

status

string

obrigatório

Status do ciclo de vida do conector, como provisionando, ativando, ativo, excluindo ou erro.

provider_account_id

string

obrigatório

ID da conta do provedor: ID de usuário do bot do Telegram ou ID do número de telefone do WhatsApp.

provider_account_name

string | null

obrigatório

Nome de exibição da conta do provedor quando houver um disponível.

config

any

obrigatório

Valor JSON arbitrário.

credentials_configured

boolean

obrigatório

Se credenciais criptografadas do provedor são armazenadas para este conector.

last_error

any | null

obrigatório

Valor JSON arbitrário.

created_at

string<date-time>

obrigatório

updated_at

string<date-time>

obrigatório

deleted_at

string<date-time> | null

obrigatório

⌘I

Responses and conversations

Models and routing

Images and audio

Files and retrieval

Agents

Tools and sandbox

Evals and feedback

Compute

Repositories

Dataset generations

Organizations and access

Usage and budgets

Application utilities

Analytics

Legacy APIs

Additional APIs

Criar um conector

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta