Documentation

Capability matrix

A public endpoint where the platform states what works for you. Instead of asking your account manager, you can check with a request.

Back to documentation

The request

GET https://app.aivatary.com/capabilities

{
  "channels": {
    "public_widget": {
      "implemented": true,
      "configured": true,
      "healthy": true,
      "enabled": true
    }
  }
}

Four independent axes

The axes are disjoint by design. A channel is available when all four hold, not when somebody ticked it in the settings.

Axis	Meaning
implemented	Whether the code for this channel actually exists. The value may read scaffold, meaning the contracts are there but the implementation is not
configured	Whether the required settings and credentials are present
healthy	Whether the last health probe succeeded
enabled	Whether the flag is on and no kill switch has taken it down

What it is for

So the promise cannot drift from reality

A channel whose code does not exist cannot be switched on by any flag. A setting has no way to run ahead of the implementation.

So diagnosis takes a second

When a channel misbehaves, one request tells you whether the problem is configuration, health or a kill switch.

So it can feed monitoring

The response is machine readable, so it suits automated checks, not only a human glance.

Check the state of your channels

The panel shows the same matrix in human readable form, on the dashboard after signing in.

Create account See channels