Quickstart
Get the first working search-and-gather loop running.
This is the shortest useful integration. Once this loop works, the rest of the product is an extension of the same pattern.
Minimum setup
Create the Valmar workspace
In the Admin UI, create an organization and a project, then make sure the organization already contains the people Valmar may contact for missing context.
Create the client
Initialize one authenticated client close to the part of your app that already owns workflow orchestration.
Search first, gather second
Run a search on every request and create a knowledge request only when the answer is still missing.
Create the client
Configure one project-scoped client with the project key, organization ID, and project ID. Search and gather calls use that scope.
import os
from valmar import ValmarClient
client = ValmarClient(
api_key=os.environ["VALMAR_API_KEY"],
organization_id=os.environ["VALMAR_ORGANIZATION_ID"],
project_id=os.environ["VALMAR_PROJECT_ID"],
base_url=os.environ["VALMAR_BASE_URL"],
)import { Valmar } from "@valmar/sdk";
const valmar = new Valmar({
apiKey: process.env.VALMAR_API_KEY!,
organizationId: process.env.VALMAR_ORGANIZATION_ID!,
projectId: process.env.VALMAR_PROJECT_ID!,
baseUrl: process.env.VALMAR_BASE_URL,
});Next
- Search Knowledge — query the project-scoped answer store.
- Create Knowledge Requests — hand off to a real person when the answer is missing.