Quickstart

Everything below runs against your own workspace. If you do not have one yet, create a workspace first.

1. Get an API key

Open Settings, then API keys, and create a key scoped to the workspace you want to read. Keys are shown once. Store it as FRONTAL_API_KEY.

2. Install the SDK

Copynpm install frontal-sdk

3. Make a call

Copyimport { Frontal } from "frontal-sdk";
 
const frontal = new Frontal({
  security: { apiKey: process.env.FRONTAL_API_KEY ?? "" },
});
 
const runs = await frontal.runs.list({ pageSize: 10 });
 
console.log(runs.object?.data);

An empty list is a successful response. It means the key is valid and the workspace has not run anything yet.

4. What to read next

Context and ontology explains how your data is modelled, and Build an agent turns that model into something that acts.