ForgeTrail docs · quickstart

Wire your studio to the ForgeTrail Ship API

  • Pick a language tab and copy the boot snippet for your automation host.
  • Mirror the kanban lanes so producers, design, and engineering share one gate vocabulary.
  • Point CI at the sandbox key until your slice passes the documented exit checks.
Browse programs Teams report 4.8/10 clarity lift on internal surveys after week two.
Language
import { createClient } from "@forge-trail/sdk";

const client = createClient({ apiKey: process.env.FTA_KEY });
const build = await client.ship.getStatus({ branch: "vertical-slice" });
console.log(build.gates);

Plan

  • Lock vertical slice
  • Define review gates
  • Publish risk log

Build

  • Instrument loops
  • Capture repro clips
  • Ship weekly notes

Verify

  • Desk playtests
  • Profiler snapshots
  • Docs sync

Ship API reference preview

These endpoints mirror how ForgeTrail documents operational hooks for studios. Responses are typed, cache-friendly, and designed for automation hosts—not browser secrets. The preview below lists verbs, paths, and a single-line contract each.

  • Typed JSON envelopes with stable error codes for CI parsers.
  • Idempotent retries on PATCH annotate routes within a 10-minute window.
  • Sandbox and production keys are visually distinct in the dashboard kit.
  • Every route ships with an OpenAPI fragment you can paste into your internal portal.
GET /v1/ship/status

Returns gate checklist for the active vertical slice branch.

  • Auth: scoped studio token
  • Body: JSON only
  • Rate: soft burst for CI
POST /v1/reviews/submit

Queues a mentor review packet with asset hashes and repro steps.

  • Auth: scoped studio token
  • Body: JSON only
  • Rate: soft burst for CI
PATCH /v1/builds/{id}/annotate

Attaches structured notes after a desk playtest without mutating binaries.

  • Auth: scoped studio token
  • Body: JSON only
  • Rate: soft burst for CI

Interactive playground

Run a mocked request against the static sandbox. Nothing leaves your browser; the inspector below shows the shape of a happy-path response so engineers can align parsers before wiring real keys.

Request builder

Response inspector

Awaiting sandbox call…

Subheadings in this playground map to future SDK chapters: authentication, pagination cursors, and annotation merges.

Contributor desk

Editorial leads maintain beat pages tied to live programs. Each card routes to the course or studio track where their review notes surface most often.

Mina Cho, Program Director

Mina Cho

Program Director

Shapes cohort pacing and keeps milestones honest across disciplines.

View beat →
Jonas Meyer, Lead Game Design Mentor

Jonas Meyer

Lead Game Design Mentor

Focuses on tactile PC loops, encounter clarity, and reviewable tuning notes.

View beat →
Sora Han, Technical Production Coach

Sora Han

Technical Production Coach

Bridges art exports and engineering integration without turning meetings into theater.

View beat →
Elias Vance, PC Launch Strategist

Elias Vance

PC Launch Strategist

Keeps storefront language aligned with build facts and launch-week operations calm.

View beat →
Noah Kim, Community Operations Manager

Noah Kim

Community Operations Manager

Designs async rituals that respect deep work while unblocking distributed crews.

View beat →

Recent changelog

Breaking changes are flagged loudly so automation hosts can pin versions. Patch entries stay terse; migration notes live beside each gate.

  • breaking 2026.05.1 — Ship status schema adds gates[] string enum; migrate parsers before May 20.
  • patch 2026.04.9 — Annotate route accepts optional desk notes without bumping binary hashes.

What studios mention after week two

“The Steam Launch Readiness Sprint forced our capsule copy to match what the build actually does. Patch note template is still our default; trailer pacing is a separate fight.”

Yuki Morita, Creative director · Lantern Vector

“Physics Feel Bootcamp gave us coyote time bounds we could argue with politely. Profiler readings are calmer, though audio occlusion remains our noisy neighbor.”

Amir Haddad, Engine lead · Brushline Studio

“Loop Lab worksheets exposed a redundant encounter check we had cargo-culted from an old jam build.”

Client in gameplay tooling

“Shader clinic checklists stopped our “export mystery” cycle. Verified badge would feel odd here, but the critique was concrete.”

Chen Wei ★★★★★

“Remote rituals doc reads simple until you try it—decision log is the quiet MVP.”

Nora Elling ★★★★☆

Wire the studio, then ship the slice

Read the program catalog, compare Standard and Premium touchpoints, and send a docs-style note when you are ready for a walkthrough. We respond with calendar options rather than automated sales drips.