Customer integration (HTTP API)

This page is for your organization’s IT or integration team after Lyntaris is deployed on your infrastructure. You use it to connect CRM, portals, backends, or automation to Lyntaris agents—the same flows you see under Agents in the web app (/agents).

End users who only work in the browser do not need this chapter.

What you can integrate

Goal Typical approach
Send a user message and get the agent’s reply POST to the prediction API for your flow
Stream tokens for low latency Streaming endpoint (see Streaming Responses)
Embed a ready-made chat widget Embed Chat Widget
Trigger a realtime flow from CRM/ticketing (queue), or export compact graph JSON Realtime Agent Canvas — queue and compact endpoints
List or export execution traces (audit, SIEM) REST under /api/v1/executions — request the API reference for your deployment from your Lyntaris administrator or support (payloads and auth can vary by environment)

1. Base URL and flow ID

  • Host: The HTTPS URL of your Lyntaris instance (e.g. https://your-tenant.lyntaris.com).
  • Flow ID: Each flow has a unique id. In the builder, open the flow and click the < > API button (top right) to see the exact API URL and example payloads (Embed Chat Widget)—prediction for Agentflow V2, queue enqueue for realtime v1.

2. Run an agent (prediction)

Non-streaming request:

  • Method: POST
  • Path: /api/v1/prediction/{FLOW_ID}
  • Body (JSON): at minimum a question field with the user’s text. Optional fields include overrideConfig, uploads, or sessionId depending on your flow—use the API dialog on the canvas for the precise shape your deployment expects.

Authorization: If the flow is protected, send the API key or Bearer token configured in Lyntaris (the Embed dialog shows how to include it).

</a>

Override configuration

Client integrations can supply an overrideConfig object in the prediction (or streaming) JSON body to temporarily change parts of the flow configuration for that request—for example model parameters, prompts, or feature toggles exposed by your flow.

In the web app, open the flow and use Flow configuration → Overrides to choose which properties callers are allowed to override. Only properties you enable there should be passed from your backend; others are ignored or rejected depending on server settings.

The API dialog on the canvas (toolbar) shows example payloads and the exact keys your deployment expects.

3. Execution records (audit / compliance)

To list, fetch, or delete a stored execution record (Turn or Realtime forensic row), your integration uses the executions REST API. Exact authentication and filter query parameters depend on your deployment; your Lyntaris operator supplies the technical reference (paths, auth, examples) for your environment.

4. Where to get more detail

5. Realtime agent flows (queue)

If you are integrating with a flow built on /realtime-v1/agentcanvas, use the Realtime Queue and optional compact export APIs—not the generic prediction URL. See Realtime Agent Canvas for enqueue payloads (form must include ID; optional state carries structured session memory), status polling, and the POST /api/v1/openai-realtime/compact export.

6. Sitemap crawl cookies (operator automation)

This call goes to your FastAPI service (the same host and port your operator uses for embeddings / pipeline APIs), not to the Flowise dashboard URL. It replaces the on-disk shared web cookie file used by Discover, Crawl root, and Always Fresh when those jobs need an authenticated browser session.

Who uses it

  • Preferred: Unity operator tooling (built into the Lyntaris kiosk / control-room build) after logging in on the operator WebView.
  • Optional: Your automation team, if they export cookie JSON from another trusted process.

End users of the dashboard do not call this API from the browser.

Request

  • Method: POST
  • Path: /sitemap/web-cookies (on the FastAPI base URL, e.g. https://<fastapi-host>:<port>/sitemap/web-cookies)
  • Body: JSON array of cookie objects (shape is normalized server-side; Playwright-style or Unity-exported JSON are both accepted).
  • Header (when your deployment sets it): X-Ingest-Secret: <value> — must match the ingestion secret configured for FastAPI (same secret family as other protected ingest routes). If the secret is not configured on the server, the header may be omitted.

Example (illustrative — replace host, port, and secret):

curl -sS -X POST "https://fastapi.example.com:8443/sitemap/web-cookies" \
  -H "Content-Type: application/json" \
  -H "X-Ingest-Secret: YOUR_INGEST_SECRET" \
  -d @cookies.json

where cookies.json is a JSON array.

Product context: Sitemap & Web Pipeline — Authenticated websites and LyntClaw — browser vs knowledge-base crawling.

results matching ""

    No results matching ""