Skip to content
Try Free →

Channels and the AskVault API, what exists today

Last updated: · 2 min read

What exists today

Channels are managed in the dashboard, not through the API.

Open the Channels to connect a channel, change its settings, switch it off or remove it. You can also ask the Setup Copilot to connect one for you. The same page holds the Channel health panel, which covers the last 24 hours, and a Verify button for 4 channels: Slack, Telegram, Discord and WhatsApp.

The public REST API under https://api.askvault.co/v1 has no channel endpoints. With an API key you cannot read channel settings, update a channel, switch one on or off, send a test message, or read health.

The dashboard talks to the server through its own internal addresses. Those need a signed-in dashboard session, not an ak_ key. They are not a supported integration surface and can change without notice.

List connected channels

GET /v1/agent/capabilities is the only API call that tells you about channels.

It takes your API key like every other v1 call; see authentication.

Terminal window
curl https://api.askvault.co/v1/agent/capabilities \
-H "Authorization: Bearer ak_xxx"

Response:

{
"workspace": "Acme Store",
"skills": ["order_status"],
"channels": ["whatsapp", "slack"],
"escalation": true,
"grounded": true,
"streaming": true
}

channels lists the type names of channels that are connected and switched on. The example workspace above has 2 channels switched on. It carries no settings and no health. A channel you have switched off is left out.

Your website widget, shared chat page and API keys are set up separately from other channels, so they usually do not appear in this list even when they are live.

Responses can gain new fields over time. Ignore fields you don't recognise.

Common pitfalls

Looking for a channel settings endpoint. There isn't one. Keep channel setup on the Channels page.

Using an API key on dashboard addresses. The dashboard's own calls need a signed-in session. An ak_ key only works on /v1 routes.

Reading channels as a health signal. It only says a channel is switched on. Open the Channel health panel to see whether replies are going out.

FAQ

Can I create or configure a channel via API?

Not today. Connect and configure channels on the Channels page.

Can I read channel health via API?

No. Channel health is shown on the Channels page only.

Is there any programmatic way to see connected channels?

Yes, one. GET /v1/agent/capabilities lists the workspace's enabled channels. It carries no settings or health.

Was this page helpful?