Sign in
Open console
Docs/Getting started/Quickstart
docs · getting started

Quickstart

journey

Stand up your first assistant — corpus, scope, channels — in about ten minutes.

This journey takes you from an empty workspace to a live Assistant that answers from your own sources and cites them. You will create an Assistant, bind a Corpus, set its Scope Gate, and publish a Channel — about ten minutes end to end. It crosses four screens, so this page leaves its own console anchor empty and names each screen's anchor inline.

What you'll accomplish

By the end you will have one Assistant that retrieves from a bound Corpus, refuses questions outside its scope, and is reachable through a published Channel. You verify success by asking a Query and getting back a cited answer drawn from your sources.

Before you start

  • A Tenant Administrator or Content Manager role. Most steps save under setting:update (Tenant Administrator); a Content Manager can manage the Corpus and its documents. Without the gating permission the screens load read-only and a save returns 403.
  • At least one source file ready to ingest. Supported formats are PDF, PNG, JPG, JPEG, TXT, and MD, up to 10 MB each. DOCX is rejected at the gateway — convert it to PDF or text first.
  • A public API key (pk_…) for the embed snippet, available on the API keys screen.

Steps

1

Create an assistant

Open the Assistants list and create a new Assistant. Give it a name and a short system prompt describing what it answers. This becomes the configuration root for everything that follows — its own prompts, corpora, channels, and snapshots.

2

Connect a corpus

From the Assistant's Corpora panel, bind a Corpus so the Assistant has something to retrieve from. Documents are surfaced read-only here — there is no per-Assistant upload control today, so ingest files through the uploadDocument API path (see Uploading documents). A document is ready to serve answers once its status reaches ready (the terminal success state; the UI labels it indexed).

3

Set the scope gate

On the Scope Gate screen, define which questions are in scope before retrieval runs. Start narrow. Changes hot-reload within about 60 seconds. The 'Minimum confidence' field is a reserved no-op and has no effect yet; the 'Disable now' kill switch renders for superadmins only, so as a tenant admin you will not see it.

4

Publish a channel

On the Channels panel, bind the Assistant to a transport. For the web, use the Embed widget card — it renders the <vericite-widget> snippet you paste into your site. Note the 'Copy embed snippet' button is non-functional today; copy the snippet text manually.

Embed widget snippet (Channels → Embed widget card)html
<script src="https://widget.vericite.ai/widget.umd.js"></script><vericite-widget  tenant="your-tenant-id"  channel="your-channel-id"  api-url="https://api.vericite.ai"  api-key="pk_your_public_key"></vericite-widget>
Allowed origins are advisory today — The widget's allowed-domains configuration is not enforced on the request path yet. CORS at the gateway (ALLOWED_ORIGINS) is what actually controls where the widget loads, so treat the origin field as documentation rather than a hard restriction for now.
Start narrow, then widen — Bind one Corpus and keep the Scope Gate tight. Measure which Queries get deflected, then loosen scope deliberately as you see what your users actually ask.

Verify it worked

Open the published widget and ask a Query you know your source material answers. Success is observable: an answer comes back with a citation pointing to the document you ingested. If the Assistant says it doesn't know, confirm the document reached status ready and that the question falls inside your Scope Gate.

featureCorporaGroup approved documents into corpora an assistant can read.
featureChannelsPublish an assistant to web, Slack, Teams, or the API.
conceptWhat is VeriCiteVeriCite gives institutions trusted answers with citations to approved source material.
Was this page helpful?