Docs

Reference

REST API v2

Every app action over HTTP, through the same safety gate as the app.

View MarkdownThis page is generated from the source code on every release.

Every app action over HTTP, through the same safety gate as the app.

Base URL

https://tlg.builera.app/api/public/v2

Authentication

Every request carries the key of an AI connection (created in Settings → AI connections): Authorization: Bearer $TELEGRAM_AUTO_API_KEY. A connection has its own role, scopes, account list and budgets — never the full rights of the person who made it.

Calling an operation

Each operation is POST /ops/<code> with a JSON body. Success answers { ok: true, data }; errors answer problem JSON (RFC 9457) with a code — see Error codes.

Idempotency

Operations with effects need an Idempotency-Key header: the same key within 24 hours returns the first answer instead of acting twice. Retries after a network error always reuse the key.

Actions the person must approve

Dangerous actions answer 409 confirmation_required with a summary and a confirm_token. The agent must show the summary to the person; only if they agree does it call again with the same input plus confirm_token.

Work that runs on Telegram

Operations that "queue work for a node" return an operation_id; follow it with GET /operations/<id> or the operation.* events.

Full OpenAPI document (machine-readable): https://tlg.builera.app/api/public/v2/openapi.json

All operations

293 operations, grouped by app area.

Accounts

Code Name Scope Risk Runs as
accounts.answer_tos Answer Telegram's terms of service accounts.manage Write Queues work for a node
accounts.change_proxy Change proxy infra.manage Write Answers right away
accounts.check_spambot Check @SpamBot accounts.read Write Queues work for a node
accounts.create Add a Telegram account accounts.manage Write Answers right away
accounts.get Account details accounts.read Read Answers right away
accounts.initial_sync Re-sync conversations accounts.settings Write Queues work for a node
accounts.kill_session End a Telegram session accounts.manage Dangerous Queues work for a node
accounts.list List Telegram accounts accounts.read Read Answers right away
accounts.list_sessions View login sessions accounts.read Write Queues work for a node
accounts.login_start Start login (QR or phone number) accounts.manage Write Queues work for a node
accounts.login_status Login progress accounts.manage Read Answers right away
accounts.login_submit Enter code / two-step password accounts.manage Write Answers right away
accounts.logout Log out of Telegram accounts.manage Dangerous Queues work for a node
accounts.move_node Move to another machine infra.manage Write Answers right away
accounts.quota Quota used today stats.read Read Answers right away
accounts.read_privacy View Telegram privacy settings accounts.read Read Queues work for a node
accounts.recover Recover after a restriction accounts.settings Write Answers right away
accounts.remove Remove account accounts.manage Dangerous Answers right away
accounts.rollback_settings Restore an earlier account setting accounts.settings Write Answers right away
accounts.set_contact_sync Turn contact sync on / off accounts.settings Write Answers right away
accounts.set_paused Pause / resume an account accounts.settings Write Answers right away
accounts.set_privacy Change Telegram privacy settings profile.write Write Queues work for a node
accounts.set_tags Add / remove account tags accounts.settings Write Answers right away
accounts.settings_history Account settings history accounts.read Read Answers right away
accounts.update_photo Change Telegram profile photo profile.write Write Queues work for a node
accounts.update_profile Edit Telegram name and bio profile.write Write Queues work for a node
accounts.update_settings Account settings accounts.settings Write Answers right away
accounts.update_username Change Telegram username profile.write Write Queues work for a node
sequences.cancel Cancel a sequence accounts.read Write Answers right away
sequences.get View a sequence accounts.read Read Answers right away
sequences.list List sequences accounts.read Read Answers right away
sequences.run Run a sequence accounts.read Write Answers right away
stories.list View stories (person / contacts / own / viewers) messages.read Read Queues work for a node
stories.manage Delete / pin own stories profile.write Write Queues work for a node
stories.post Post a story profile.write Write Queues work for a node

Alerts

Code Name Scope Risk Runs as
alerts.list List alerts audit.read Read Answers right away
alerts.mark_seen Mark alerts as seen audit.read Write Answers right away
alerts.resolve Close an alert audit.read Write Answers right away

Settings

Code Name Scope Risk Runs as
alerts.save_rules Alert rules integrations.manage Write Answers right away
capabilities.list App capabilities accounts.read Read Answers right away
connections.create Create an AI connection integrations.manage Dangerous Answers right away
connections.delete Delete an AI connection integrations.manage Dangerous Answers right away
connections.list AI connections integrations.manage Read Answers right away
connections.resume Turn a connection back on integrations.manage Dangerous Answers right away
connections.rotate_key Rotate a connection's API key integrations.manage Dangerous Answers right away
connections.stop Stop a connection now integrations.manage Write Answers right away
connections.update Edit another AI connection integrations.manage Dangerous Answers right away
invites.create Invite a member members.manage Write Answers right away
invites.revoke Revoke an invite members.manage Write Answers right away
members.list Members and invites members.manage Read Answers right away
members.remove Remove a member members.manage Dangerous Answers right away
members.set_accounts Assign accounts to a support member members.manage Write Answers right away
members.set_role Change a member's role members.manage Dangerous Answers right away
operations.get Follow an operation accounts.read Read Answers right away
templates.delete Delete reply template chats.manage Dangerous Answers right away
templates.save Save reply template chats.manage Write Answers right away
webhooks.capabilities Webhooks: catalog & limits webhooks.read Read Answers right away
webhooks.create Create a webhook webhooks.manage Write Answers right away
webhooks.delete Delete a webhook webhooks.manage Dangerous Answers right away
webhooks.deliveries_get One delivery's details webhooks.read Read Answers right away
webhooks.deliveries_list Webhook deliveries webhooks.read Read Answers right away
webhooks.get Webhook details webhooks.read Read Answers right away
webhooks.list List webhooks webhooks.read Read Answers right away
webhooks.pause Pause a webhook webhooks.manage Write Answers right away
webhooks.preview_filter Try a webhook filter webhooks.read Read Answers right away
webhooks.receiver_guide Webhook receiver guide webhooks.read Read Answers right away
webhooks.redeliver Redeliver a webhook webhooks.manage Write Answers right away
webhooks.replay Replay webhooks over a time range webhooks.manage Write Answers right away
webhooks.replay_cancel Cancel a replay webhooks.manage Write Answers right away
webhooks.replay_get Replay progress webhooks.read Read Answers right away
webhooks.resume Resume a webhook webhooks.manage Write Answers right away
webhooks.test Send a test webhook webhooks.manage Write Answers right away
webhooks.update Edit a webhook webhooks.manage Write Answers right away
webhooks.validate_url Check a receiver URL webhooks.manage Read Answers right away
webhooks.verify Verify a receiver URL webhooks.manage Write Answers right away
workspace.update Edit workspace members.manage Write Answers right away

Alert bell

Code Name Scope Risk Runs as
alerts.summary Count alerts audit.read Read Answers right away

Logs

Code Name Scope Risk Runs as
audit.list Activity log audit.read Read Answers right away
jobs.redrive Rerun a failed job accounts.manage Dangerous Queues work for a node

Automation

Code Name Scope Risk Runs as
automation.history Config change history accounts.read Read Answers right away
automation.overview Automation overview accounts.read Read Answers right away
automation.rollback Restore an earlier config automation.write Write Answers right away
automation.simulate Preview the next 7 days accounts.read Read Answers right away
packs.apply Apply a pack by plan automation.write Write Answers right away
packs.delete Delete a config pack automation.write Dangerous Answers right away
packs.get View a config pack accounts.read Read Answers right away
packs.plan Plan applying a pack automation.write Write Answers right away
packs.save Create / edit a config pack automation.write Write Answers right away
routines.delete Delete a routine automation.write Dangerous Answers right away
routines.get View a routine accounts.read Read Answers right away
routines.run_now Run a routine now automation.write Write Answers right away
routines.save Create / edit a routine automation.write Write Answers right away
rules.delete Delete an automation rule automation.write Dangerous Answers right away
rules.get View an automation rule accounts.read Read Answers right away
rules.save Create / edit an automation rule automation.write Write Answers right away

Bots

Code Name Scope Risk Runs as
bots.adopt Adopt an existing bot of the account bots.manage Write Answers right away
bots.create Create a bot bots.manage Write Answers right away
bots.delete Delete bot bots.manage Dangerous Answers right away
bots.list List bots accounts.read Read Answers right away
bots.refresh_token Fetch the token again bots.manage Write Answers right away
bots.revoke_token Change bot token bots.manage Dangerous Answers right away
bots.set_photo Change bot photo bots.manage Write Answers right away
bots.update_profile Edit bot profile bots.manage Write Answers right away

Inbox

Code Name Scope Risk Runs as
bots.press_button Press a bot button messages.send Write Queues work for a node
bots.start Start a bot messages.send Write Queues work for a node
contacts.add Save to contacts contacts.write Write Queues work for a node
contacts.check_exists Check whether on Telegram contacts.write Write Queues work for a node
contacts.resolve Look up a known identity crm.read Read Answers right away
contacts.start_chat Find someone and open a chat contacts.write Write Queues work for a node
conversations.add_note Add an internal note chats.manage Write Answers right away
conversations.archive Archive / unarchive messages.manage Write Queues work for a node
conversations.claim Claim conversation messages.send Write Answers right away
conversations.clear_history Clear chat history messages.manage Dangerous Queues work for a node
conversations.delete_note Delete an internal note chats.manage Dangerous Answers right away
conversations.get Conversation context messages.read Read Answers right away
conversations.list List conversations messages.read Read Answers right away
conversations.load_history Load older messages from Telegram messages.read Write Queues work for a node
conversations.mark_read Mark as read messages.send Write Queues work for a node
conversations.mark_unread Mark as unread messages.send Write Queues work for a node
conversations.mute Mute / unmute notifications messages.manage Write Queues work for a node
conversations.refresh_members Reload group members messages.read Write Queues work for a node
conversations.release Release conversation messages.send Write Answers right away
conversations.save_draft Save draft to Telegram messages.send Write Queues work for a node
conversations.search_telegram Search in the chat messages.read Read Queues work for a node
conversations.typing Show “typing…” messages.send Write Answers right away
conversations.update Status, assignee, tags, pin chats.manage Write Answers right away
folders.delete Delete a chat folder messages.manage Dangerous Queues work for a node
folders.list View chat folders messages.read Read Answers right away
folders.reorder Reorder chat folders messages.manage Write Queues work for a node
folders.save Create / edit a chat folder messages.manage Write Queues work for a node
folders.sync Reload chat folders from Telegram messages.read Read Queues work for a node
groups.add_bot Add a bot to a group / channel groups.admin Write Queues work for a node
groups.add_members Add people to a group / channel groups.admin Write Answers right away
groups.answer_all_requests Approve / decline all requests groups.admin Write Queues work for a node
groups.answer_request Approve / decline a join request groups.admin Write Queues work for a node
groups.ban_member Ban a member groups.admin Dangerous Queues work for a node
groups.close_topic Close / reopen a topic groups.admin Write Queues work for a node
groups.create_channel Create a channel / supergroup contacts.write Write Queues work for a node
groups.create_chat Create a group chat contacts.write Write Queues work for a node
groups.create_link Create an invite link groups.admin Write Queues work for a node
groups.create_topic Create a topic groups.admin Write Queues work for a node
groups.delete_chat Delete group / channel for everyone groups.admin Dangerous Queues work for a node
groups.delete_member_messages Delete all messages of a member groups.admin Dangerous Queues work for a node
groups.delete_topic Delete a topic groups.admin Dangerous Queues work for a node
groups.edit_link Edit an invite link groups.admin Write Queues work for a node
groups.hide_general_topic Hide / show the General topic groups.admin Write Queues work for a node
groups.info View group admin info messages.read Read Queues work for a node
groups.members Member list messages.read Read Queues work for a node
groups.pin_topic Pin / unpin a topic groups.admin Write Queues work for a node
groups.remove_member Remove / ban a member groups.admin Write Queues work for a node
groups.rename_topic Rename a topic groups.admin Write Queues work for a node
groups.restrict_member Restrict a member groups.admin Write Queues work for a node
groups.revoke_link Revoke an invite link groups.admin Dangerous Queues work for a node
groups.set_about Change group / channel description groups.admin Write Queues work for a node
groups.set_admin Grant / revoke admin rights groups.admin Write Queues work for a node
groups.set_admin_rights Detailed admin rights groups.admin Write Queues work for a node
groups.set_auto_delete Auto-delete messages groups.admin Write Queues work for a node
groups.set_history_hidden Hide / show history for new members groups.admin Write Queues work for a node
groups.set_join_rules Join rules groups.admin Write Queues work for a node
groups.set_permissions Change default member permissions groups.admin Write Queues work for a node
groups.set_photo Change group / channel photo groups.admin Write Queues work for a node
groups.set_protected Block forwarding / saving content groups.admin Write Queues work for a node
groups.set_public_link Set / remove the public link groups.admin Write Queues work for a node
groups.set_signatures Sign channel posts groups.admin Write Queues work for a node
groups.set_slow_mode Slow mode groups.admin Write Queues work for a node
groups.set_title Rename group / channel groups.admin Write Queues work for a node
groups.toggle_topics Turn topics on / off groups.admin Write Queues work for a node
groups.topics View a group's topics messages.read Read Queues work for a node
groups.unban Unban a member groups.admin Write Queues work for a node
groups.unpin_all Unpin all groups.admin Write Queues work for a node
groups.upgrade Upgrade to supergroup groups.admin Dangerous Queues work for a node
messages.close_poll Stop a poll messages.send Dangerous Queues work for a node
messages.delete Delete messages messages.manage Dangerous Queues work for a node
messages.edit Edit a sent message messages.manage Write Queues work for a node
messages.forward Forward messages messages.send Write Queues work for a node
messages.get One message messages.read Read Answers right away
messages.list Messages of a conversation messages.read Read Answers right away
messages.list_scheduled View scheduled messages messages.read Read Queues work for a node
messages.manage_scheduled Send now / reschedule / edit / delete scheduled messages messages.send Write Queues work for a node
messages.open_media Open a message's file messages.read Write Queues work for a node
messages.pin Pin / unpin a message messages.manage Write Queues work for a node
messages.react Add / remove a reaction messages.send Write Queues work for a node
messages.reply Reply to a message messages.send Write Queues work for a node
messages.retry Resend a failed message messages.send Write Queues work for a node
messages.schedule Schedule a message (kept by Telegram) messages.send Write Queues work for a node
messages.send Send a text message messages.send Write Queues work for a node
messages.send_album Send a photo / video album messages.send Write Queues work for a node
messages.send_media Send a file / photo messages.send Write Queues work for a node
messages.send_poll Send a poll / quiz messages.send Write Queues work for a node
messages.vote_poll Vote messages.send Write Queues work for a node
people.block Block / unblock this person contacts.write Write Queues work for a node
people.delete_contact Remove from Telegram contacts contacts.write Dangerous Queues work for a node
people.refresh_profile Reload the customer's Telegram profile crm.read Read Queues work for a node
stickers.list View stickers / GIFs messages.read Read Queues work for a node
stickers.previews Load sticker previews messages.read Read Queues work for a node
stickers.send Send a sticker / GIF messages.send Write Queues work for a node
stories.of_chat View stories of a chat partner messages.read Read Queues work for a node
templates.list Quick reply templates messages.read Read Answers right away

Campaigns

Code Name Scope Risk Runs as
campaigns.add_people Add people to a campaign campaigns.write Write Answers right away
campaigns.create Create a campaign campaigns.write Write Answers right away
campaigns.delete Delete a campaign campaigns.write Dangerous Answers right away
campaigns.discard_draft Discard the flow draft campaigns.write Write Answers right away
campaigns.duplicate Duplicate a campaign campaigns.write Write Answers right away
campaigns.get Campaign details crm.read Read Answers right away
campaigns.list List campaigns crm.read Read Answers right away
campaigns.pause Pause a campaign campaigns.run Write Answers right away
campaigns.people People in a campaign crm.read Read Answers right away
campaigns.preview Preview a campaign campaigns.write Read Answers right away
campaigns.publish Publish the flow campaigns.write Write Answers right away
campaigns.remove_recipient Remove one person from a campaign campaigns.write Write Answers right away
campaigns.resume Resume a campaign campaigns.run Write Answers right away
campaigns.save_graph Save campaign flow (draft) campaigns.write Write Answers right away
campaigns.senders Suitable sending accounts campaigns.write Read Answers right away
campaigns.start Start a campaign campaigns.run Write Answers right away
campaigns.stop Stop a campaign for good campaigns.run Dangerous Answers right away
campaigns.test Technical test send of a campaign campaigns.run Write Answers right away
campaigns.test_status Campaign test result campaigns.write Read Answers right away
campaigns.update Edit a campaign campaigns.write Write Answers right away
enrollments.create Enroll people into a campaign campaigns.write Write Answers right away

People

Code Name Scope Risk Runs as
crm.setup Stages, lists, tags crm.read Read Answers right away
imports.cancel Cancel an import crm.write Write Answers right away
imports.start Import people crm.write Write Queues work for a node
lists.delete Delete a list crm.write Dangerous Answers right away
lists.save Create / edit a list crm.write Write Answers right away
people.add Add one person crm.write Write Queues work for a node
people.add_note Note on a customer crm.write Write Answers right away
people.bulk Bulk actions on people crm.write Write Answers right away
people.delete_note Delete a customer note crm.write Dangerous Answers right away
people.erase Erase a person's data for good crm.erase Dangerous Answers right away
people.export Export people data crm.export Dangerous Answers right away
people.get Customer profile crm.read Read Answers right away
people.list List people crm.read Read Answers right away
people.set_stage Change a customer's stage crm.write Write Answers right away
people.set_tags Tag a customer crm.write Write Answers right away
people.set_temperature Set a customer's temperature crm.write Write Answers right away
people.suppress Do not contact this person crm.write Write Answers right away
people.transfer_owner Change the responsible account crm.write Write Answers right away
people.unsuppress Lift do-not-contact crm.write Dangerous Answers right away
stages.delete Delete a stage crm.write Dangerous Answers right away
stages.reorder Reorder stages crm.write Write Answers right away
stages.save Create / edit a stage crm.write Write Answers right away

Discover

Code Name Scope Risk Runs as
discovery.save_settings Watched / excluded keywords discovery.write Write Answers right away
groups.add Save a group discovery.write Write Answers right away
groups.join Join a group groups.join Write Queues work for a node
groups.leave Leave a group groups.join Dangerous Queues work for a node
groups.list Saved groups crm.read Read Answers right away
groups.people People found in a group crm.read Read Answers right away
groups.refresh Refresh group info discovery.write Write Queues work for a node
groups.remove Unsave a group discovery.write Dangerous Answers right away
groups.search Search public groups discovery.write Write Queues work for a node
groups.set_watch Watch keywords in a group discovery.write Write Answers right away
scans.cancel Cancel a scan groups.scan Write Answers right away
scans.start Scan a group groups.scan Write Queues work for a node
signals.list Keyword signals crm.read Read Answers right away
signals.set_status Mark a signal discovery.write Write Answers right away

Groups & channels

Code Name Scope Risk Runs as
groups.chats The account's groups & channels messages.read Read Answers right away
groups.refresh_chats Re-read the groups & channels list messages.read Write Answers right away
groups.set_tracked Follow / unfollow a group or channel chats.manage Write Answers right away

Machines & proxies

Code Name Scope Risk Runs as
hetzner.offers Hetzner machine plans infra.manage Read Answers right away
infra.list Machines and proxies accounts.read Read Answers right away
nodes.create_hetzner Create a Hetzner machine (paid) infra.manage Dangerous Answers right away
nodes.create_windows Add a Windows machine infra.manage Write Answers right away
nodes.delete Delete a machine infra.manage Dangerous Answers right away
nodes.evacuate Move all accounts off a machine infra.manage Write Answers right away
nodes.pairing_code Pairing code for a new machine infra.manage Write Answers right away
nodes.reboot Reboot a machine infra.manage Write Answers right away
nodes.reconcile Reconcile machines with Hetzner infra.manage Write Answers right away
nodes.refresh Refresh machine status infra.manage Write Answers right away
nodes.restart_worker Restart the account worker infra.manage Write Answers right away
nodes.retry Reinstall a failed machine infra.manage Write Answers right away
nodes.set_drain Stop taking new accounts infra.manage Write Answers right away
proxies.add Add proxies infra.manage Write Answers right away
proxies.delete Delete a proxy infra.manage Dangerous Answers right away
proxies.recheck Recheck proxy infra.manage Write Queues work for a node
proxies.update Edit a proxy infra.manage Write Answers right away

Account nurture

Code Name Scope Risk Runs as
nurture.apply Apply a nurture playbook to accounts nurture.write Write Answers right away
nurture.list Nurture playbooks, nurtured accounts, warm channels accounts.read Read Answers right away
nurture.remove Remove nurturing from accounts nurture.write Write Answers right away
nurture.set_enabled Turn nurturing on / off for an account nurture.write Write Answers right away
nurture.set_task_enabled Turn one nurture task on / off nurture.write Write Answers right away
nurture.today Today's nurture tasks accounts.read Read Answers right away
playbooks.delete Delete a nurture playbook nurture.write Dangerous Answers right away
playbooks.save Save a nurture playbook nurture.write Write Answers right away
schedules.save Run-hour schedule for many accounts accounts.settings Write Answers right away
warm_channels.add Add a warm-up channel nurture.write Write Answers right away
warm_channels.remove Remove a warm-up channel nurture.write Write Answers right away

Stats

Code Name Scope Risk Runs as
stats.gtm Discover & campaign stats stats.read Read Answers right away
stats.health Account health stats stats.read Read Answers right away
stats.inbox Support stats stats.read Read Answers right away

Manage channel

Code Name Scope Risk Runs as
stories.channel_status Check a channel's boosts / story rights messages.read Read Queues work for a node

Story viewer (marks as seen automatically)

Code Name Scope Risk Runs as
stories.mark_seen Mark stories as seen messages.send Write Queues work for a node

Story viewer

Code Name Scope Risk Runs as
stories.media Open story photo / video messages.read Read Queues work for a node
stories.react React to a story messages.send Write Queues work for a node