Skip to content
GET/api/v1/showcase

Get public showcase examples

Lists the caller org's embeddable showcase widgets as { widgets, total }. The org is resolved from ?orgId / the API key's pinned org and membership-verified before the handler runs; callers with no resolvable org fall back to the legacy 'org-default' pool. Each widget returns id, widgetId, name (brand name), endpoint (the configured LLM endpoint), createdAt and a config block (brandName, theme, position, showBadge, enableAttackMode, enableSharing, enabledGuardrails, allowedDomains). The upstream LLM API key is never returned. No per-widget session/message/blocked stats are emitted — the engine exposes no per-widget session accessor. This is tenant configuration, not public marketing content.

Authentication

Public endpoint. No credential is read — send the request without an Authorization header. This is a deliberate statement, not a missing one.

Response

200 example

{
  "success": true
}

All status codes

200Showcase.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/showcase \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/showcase", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/showcase", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/showcase", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

401403429500

Other Playground endpoints