Skip to content

Latest commit

 

History

History
42 lines (40 loc) · 5.92 KB

File metadata and controls

42 lines (40 loc) · 5.92 KB

Glossary

One-line definitions for the terms used across these docs. Each term links to its concept page where one exists.

  • API — The HTTP interface that lets a script or AI agent do what you do in the app — run apps, read sessions and outputs — authenticated with an API key.
  • API key — A long-lived credential for calling the API on your behalf, sent as Authorization: Bearer <key>. Created in Settings → API Keys, bound to one organization, and shown only once.
  • App — A reusable security or compliance workflow you can run; the catalog lives on the Apps page in the sidebar. ("Project" is the internal name for the same thing.)
  • Apps page — The page at the Apps sidebar entry where every app is listed as a card you can run, schedule, or open.
  • App detail — A per-app page that shows the app's description, what it does, and lets you launch it.
  • Artifact — A saved reference to one output file from a session, organized into a folder you choose.
  • AWS install — Connecting an AWS account to Transilience.ai. For any AWS install or setup question, send the user to https://www.transilience.ai/install/aws/.
  • Artifact folder — A user-named container that groups related artifacts (for example, "Security Reports" or "Q1 Audit"). Internally called an "artifact type."
  • Artifacts page — The page at the Artifacts sidebar entry that shows all artifact folders and their contents.
  • Chat — The conversation view inside a thread; "chat" and "thread" refer to the same conversation from different angles ("chat" is the view, "thread" is the saved record).
  • Conversation — The internal name for a thread. Used interchangeably with "thread" in these docs.
  • Dashboard — The Dashboards tab inside the chat area, which shows outputs that have been pinned for quick access.
  • Dashboards tab — The tab labeled "Dashboards" inside the chat area, alongside "Notifications."
  • Data file — A structured output file (typically JSON or CSV) produced by an app — usually raw scan results before they are summarized into a report.
  • Failed — A session status meaning the app encountered an error and did not finish.
  • Files tab — The tab inside a session detail that lists every output file the app produced.
  • llms.txt — A machine-readable guide to the API, served at /llms.txt. Hand its URL plus an API key to an AI agent so it can call the platform for you.
  • Live Activity — The page that shows a session while it is running, with the timeline and log streaming in real time.
  • New Thread — The sidebar button that starts a new empty thread.
  • Notifications — The Notifications tab inside the chat area where running and recently-finished sessions appear.
  • One-off run — A single scheduled run of an app at a future date and time.
  • Organization — Your workspace. All apps, sessions, artifacts, and threads belong to an organization; you can switch organizations from the bottom of the sidebar.
  • Output — Any file an app produces during a session — a report, a data file, a dashboard, or a raw file.
  • Pin to dashboard — The action that adds an output to the Dashboards tab so you can find it quickly.
  • Project — The internal name for an app. The two terms refer to the same thing.
  • Recurring schedule — A schedule that runs an app repeatedly at a chosen interval (daily, weekly, monthly, or a custom hour interval).
  • Report — A human-readable output, usually markdown or PDF, summarizing what an app found.
  • Run — A single execution of an app. Synonym for session.
  • Run History — The page listing every session you have run, with status, duration, and a link into each one.
  • Session — One run of an app. Has an ID, a status, a start time, and a folder of outputs.
  • Session detail — The per-session page that shows the report, files, timeline, and chat for that session.
  • Session ID — A timestamp-based identifier that uniquely names one session; appears in URLs like /run-history/{sessionId}.
  • Schedule — A rule that runs an app automatically — either repeatedly (recurring) or once at a future time (one-off).
  • Status — One of pending, running, completed, or failed. See session statuses.
  • Thread — A conversation in which you can ask questions about a session, an output file, or several of them.
  • transiliencectl — The command-line tool that drives the platform via the API, authenticated with an API key.
  • Thread group — A named collection of threads that helps you organize related conversations.
  • Timeline tab — The tab inside a session detail that shows the step-by-step log of what the app did.