Skip to main content
The API Key is your access card: each scope opens one door. In production, grant only what your integration needs.

​
In brief

  • telegram:* scopes cover instances, send, read, and edit.
  • instanceIds restricts which connections the key can use.
  • General guide: API Keys. Connection: Quick Start.

​
How to send the key

Alternative: x-api-key: sk_live_xxxxx.
An empty scope list on create = ADMIN access (everything). Always restrict in production.

​
Ready-made combinations

Basic bot

telegram:instances:create, telegram:instances:list, telegram:send

Send and query

telegram:send, telegram:read

With cancel

telegram:send, telegram:cancel

Full flow

telegram:send, telegram:read, telegram:cancel, telegram:update, telegram:delete

​
Available scopes

List connections, view details, and QR (USER mode).
Create bot with token or start USER account (QR or session login).
Remove connection.
Send text, media via HTTPS URL, and location (bot mode).
Sent history, chat list, and inbound.
Cancel queued or scheduled message.
Edit sent text.
Delete message in chat.

​
Restrict by connection (instanceIds)

Besides scope (the what), instanceIds defines where:

​
Common errors

Full catalog: Error responses.

​
Next steps