Skip to main content
POST
Python (SDK)

Authorizations

Authorization
string
header
required

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

Headers

X-On-Behalf-Of
string

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

Path Parameters

id
string
required

The agent ID.

Body

application/json
provider
enum<string>
required
Available options:
telegram
credentials
object
required
access
object
required

The explicit Telegram chat allowlist permitted to invoke the agent.

name
string
Required string length: 1 - 120
drop_pending_updates
enum<boolean>
default:true

Always true: Telegram discards updates queued before this tenancy's webhook is registered.

Available options:
true

Response

Connector created and activated.

object
enum<string>
required
Available options:
agent.connector
id
string
required
agent_id
string
required
provider
enum<string>
required
Available options:
telegram
name
string | null
required
status
string
required

Connector lifecycle status, such as provisioning, activating, active, deleting, or error.

provider_account_id
string
required

The Telegram bot user ID.

provider_account_name
string | null
required

The Telegram bot username when one is available.

config
required
credentials_configured
boolean
required

Whether encrypted provider credentials are stored for this connector.

last_error
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
deleted_at
string<date-time> | null
required