List widget types for widget-data

curl --request GET \
  --url https://backend.trusys.ai/api/external/widgets \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://backend.trusys.ai/api/external/widgets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.trusys.ai/api/external/widgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.trusys.ai/api/external/widgets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://backend.trusys.ai/api/external/widgets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "id": "sessions-evaluated",
      "category": "monitoring",
      "title": "Sessions evaluated",
      "description": "Total sessions evaluated in the time range."
    },
    {
      "id": "guardrail-latency",
      "category": "guardrails",
      "title": "Guardrail latency"
    }
  ]
}

{
  "message": "Error while verifying api key"
}

List widget types for widget-data

First step before calling POST /applications/{applicationId}/widget-data.

Returns widget type slugs you can pass in the request body field types. Each item includes:

id — widget slug (use in the types array for widget-data)
category — dashboard section this widget belongs to (for example monitoring, guardrails, functional, security, rag). Corresponds to meta.source in the widget-data response.
title — human-readable label
description — optional helper text

GET

widgets

List widget types for widget-data

curl --request GET \
  --url https://backend.trusys.ai/api/external/widgets \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://backend.trusys.ai/api/external/widgets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.trusys.ai/api/external/widgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.trusys.ai/api/external/widgets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://backend.trusys.ai/api/external/widgets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "id": "sessions-evaluated",
      "category": "monitoring",
      "title": "Sessions evaluated",
      "description": "Total sessions evaluated in the time range."
    },
    {
      "id": "guardrail-latency",
      "category": "guardrails",
      "title": "Guardrail latency"
    }
  ]
}

{
  "message": "Error while verifying api key"
}

Authorizations

x-api-key

string

header

required

Your Trusys API key. Create and manage keys in the Trusys UI under Settings → API Keys.

Include the key on every request:

x-api-key: <your-api-key>

Response

Widget catalog for widget-data requests.

success

boolean

required

data

object[]

required

Show child attributes