Integration Guide

Qsentia API Integration Docs

This guide is designed for professional onboarding after receiving API access context. It explains how to integrate current live endpoints, structure a production-safe workflow, and avoid misuse of preview and telemetry data paths.

Quickstart flow
  1. 1.Confirm your base URL and environment setup.
  2. 2.Validate dashboard connectivity with a health-style fetch to /api/dashboard.
  3. 3.Load models from /api/models and bind user selection to model slug.
  4. 4.Fetch model details via /api/models/{slug} before rendering detail screens.
  5. 5.Call /api/models/{slug}/demo only for controlled previews due rate limits.
Authentication notes

These site endpoints are currently served on the same origin for platform use. If your deployment enables private API credentials, inject your key server-side and forward requests through your backend proxy.

Do not expose private tokens in browser code. Keep API keys in environment variables and rotate them according to your internal security policy.

Example secure pattern

1. Client - your backend - Qsentia API

2. Store secrets only on your backend runtime

3. Validate route-level permissions before forwarding requests

Current endpoints

GET /api/dashboard

Live telemetry, performance metrics, and dashboard state.

dynamic telemetry response; designed for periodic refresh polling.

GET /api/models

Marketplace model list sourced from live dashboard mapping.

public with revalidation headers (s-maxage and stale-while-revalidate).

GET /api/models/{slug}

Single-model details for model profile and statistics pages.

public with revalidation headers (s-maxage and stale-while-revalidate).

POST /api/models/{slug}/demo

Live signal preview from latest decision telemetry for a selected model.

non-cache preview path with request limiting (5 calls per hour per IP).

Sample requests

curl -X GET https://your-domain.com/api/models
curl -X GET https://your-domain.com/api/models/qsentia_brppo_macro_rotation_alpaca
curl -X POST https://your-domain.com/api/models/qsentia_brppo_macro_rotation_alpaca/demo
Production checklist
  • Apply retry logic and timeout controls for upstream API calls.
  • Cache model list/detail responses where freshness allows.
  • Respect preview route limits and avoid high-frequency polling on demo endpoint.
  • Log request IDs and timestamps for operational incident traceability.
  • Show fallback states in UI when telemetry is delayed or unavailable.