Set up your first share and put it in front of a class.
Five steps, all performed in the faculty admin app. You do not write SQL or code to define a share. You configure a scenario, order a few transformations, and issue keys.
1. Sign in
Open the faculty admin and sign in with your institutional account. Faculty access is session based; there is no API key for the faculty surface.
2. Create a course
A course is the container for shares and a roster. Create one for the class and term you are teaching, for example IS 566, Winter 2027. Optionally attach a seed-ID pool so multiple shares in the course can join on the same entity IDs.
3. Build a share with transformations
A share is a configured dataset. You start from a scenario and a clean, internally consistent set of tables, then add an ordered list of transformations from the v1 catalog. Order matters: a near-duplicate step after a missingness step produces duplicates that share the missingness pattern, so the admin UI keeps the order explicit.
The v1 catalog covers missingness, format and unit inconsistency, type coercion, near duplicates, referential breakage, late arrival, out-of-order arrival, and scheduled drift events. Scheduled drift is a planned learning moment, not a hidden trap. Publishing the share creates an immutable version that the generator runs.
4. Issue API keys
Import your roster, then issue keys. You can issue one key for a single student or issue keys for the whole roster in one call. A key is shown exactly once on creation and stored only as a digest after that, so distribute it at issue time and re-issue if a student loses theirs.
5. Reveal the manifest
The share manifest is the ordered account of every transformation that was applied, generated from the configuration. It is the answer key alternative. You read it any time; students only see it after you set the manifest to revealed on the active version. There is no deterministic auto-grader in v1; the manifest is the artifact you walk the class through.
What students need from you
Give each student their API key and the student API base URL. Everything they do from there is covered in the student quick start.
https://app.blueforge.dev/api/student/v1
For the conceptual model behind shares and the manifest, see How it works. For every endpoint, see the API reference.