FR Desk / API
Get a token

Driving FR Desk from code

Everything the web app does is available over HTTP. The base URL is https://api.skillsafe.ai/v1/app-api, every request carries Authorization: Bearer <token>, and every response is the same envelope.

The task field comes first

This app has five lanes behind one endpoint. Every run body must carry a task field naming the lane - it is what the system prompt routes on. Send the wrong one and you get a valid package of the wrong kind; omit it and the model picks the closest lane and tells you which it chose.

One more shape trap: the run body is the input object. Do not wrap it in an {"input": ...} envelope - that returns 200 while hiding task from the model, which is the most confusing way this API can fail.

taskLaneFieldsSections returned
planTurn a layout brief into a row that fitsbrief, knownSummary, The Sheet, The Numbers, Reasoning, Next Step
auditWhat each track resolves to, and which one is taking the roomsheet, worrySummary, Verdict, Findings, Corrected Sheet, Next Step
spaceThe division: gutters, fixed tracks, and what one fr is worthsheetSummary, Every Track Resolved, Where The Width Went, The Two Wrong Answers, Next Step
toggleWhat hiding each part does to the restsheetSummary, Every Part Toggled, Where The Space Goes, What Breaks When It Is Hidden, Next Step
decideDecide what changes: a floor, a size, or the number of partssheet, fixedSummary, One Floor Fixes, Only A Resize Fixes, Nothing Fixes, Next Step

Only task and the lane's own required fields are mandatory: sheet on audit, space, toggle and decide; brief on plan. Every field is a string - there are no number fields on this app. sheet is the layout sheet itself: a header of KEY: value lines and a TRACKS: block for a grid row, or a FLEX: block for a flex row, one part per line.

A track is a length, a percentage, an Nfr, a minmax(a, b), auto, min-content or max-content. A repeat(auto-fit, …), fit-content(), a subgrid or an unresolved var() is reported rather than guessed at.

Write the tracks in the order they appear in the row. Every figure this app returns is positional: which gutter belongs to which track, what a hidden part gives back and to whom, and which neighbour pays when a floor bites all depend on the order.

WIDTH is the container's content box, gutters included; assumed 1000. GAP comes off the top before anything is divided - (N − 1) × GAP for N visible tracks; assumed 24. ROOT multiplies every rem track length; assumed 16.

min= is the one number this app cannot compute for you. It is the track's min-content width - the widest unbreakable thing inside it - and only a browser with your content and your fonts can measure it. Leave it off and the track is treated as minmax(0, 1fr), which is usually what was meant; supply it and the response says what it costs the tracks beside it.

hidden=1 keeps a track in the sheet without a width or a gutter, which is how a closed panel is written. Every visible track is also resolved once more with itself hidden, so the toggle figures are the real layout rather than an estimate.

In a FLEX: block each item takes flex=<grow> <shrink> <basis> or grow= with an optional shrink= and basis=, plus a content= width. The two spellings are not the same rule: flex: 1 expands to flex: 1 1 0% and every item starts at zero, while flex-grow: 1 leaves flex-basis: auto and every item starts at its own content.

Anything the reader cannot place is listed as a problem rather than skipped, and so is a track named twice. A track that quietly vanished would make every width in the response a division among the wrong list.

A width is reported in pixels to one decimal place, a container and a gap in whole pixels, a share as a percentage, and a change as a signed pixel figure. The engine runs the real track-sizing algorithm including the iterated clamp-up pass: it has not parsed CSS at large or laid anything out, and it models one row on one axis with no wrapping, no spanning and no nesting.

Add $model to any body to choose the model for that run: gpt-5.6-luna, gpt-5.6-terra (the default) or gpt-5.6-sol. Luna caps output at 4,096 tokens and will fail the audit, space and toggle lanes rather than shorten them - a findings table, a corrected sheet, or three tables with a row per track, is several thousand characters before the reasoning starts.

The response envelope

Success and failure have the same outer shape, so one check covers both.

{
  "ok": true,
  "data": {
    "...": "the result"
  }
}
{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "seconds should be number, got string",
    "details": {}
  }
}
HTTPerror.codeWhat it means
400VALIDATION_ERRORThe body was not a JSON object, or a declared field had the wrong type. A number field sent as a string is the usual cause.
401UNAUTHORIZEDNo token, or a token that has expired or been revoked. Mint a new one.
402INSUFFICIENT_CREDITSThe balance is below the run's minimum. Call /estimate first and compare hold_credits against /me.
404NOT_FOUNDWrong path, or a job id that does not belong to this token.
409CONFLICTAn Idempotency-Key replay whose body differs from the original request.
429RATE_LIMITEDToo many requests. Back off; do not tight-loop.
503UPSTREAM_UNAVAILABLEThe model provider is unavailable. Retry with backoff.

1. Get a token

Open /tokens.html in a browser and copy the token this app already holds - no developer console needed. A guest token is minted automatically and is enough for /me and /estimate; writing a package is metered and needs a personal token, which comes from signing in on that page.

Keep it in an environment variable rather than in source:

export SKILLSAFE_TOKEN="YOUR_TOKEN"

2. Check the session and the balance

GET /me is free. It returns only three fields: subject_type, subject_id and credits. Signed-in means subject_type == "user" - there is no username or email to test.

curl -sS -X GET "https://api.skillsafe.ai/v1/app-api/me" \
  -H "Authorization: Bearer $SKILLSAFE_TOKEN"

3. Price the run before making it

POST /estimate costs nothing, creates no job, and returns the worst-case cost. Compare hold_credits against the balance from step 2 before you submit: a 402 after the fact is avoidable. hold_credits is a reservation priced at the full output cap - the actual charge is usually far lower.

It also echoes model, model_alias and markup_bps, which is the authoritative check that a run is bound to the model you think it is. Estimate each lane separately: their prompts and caps differ, so their holds do.

curl -sS -X POST "https://api.skillsafe.ai/v1/app-api/estimate" \
  -H "Authorization: Bearer $SKILLSAFE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "task": "audit",
  "sheet": "<WIDTH, GAP and a TRACKS block, one track per line; the grammar is in /llms.txt>",
  "worry": "it graded fine last time and this one will not come clean",
  "rules": "<the working rules for this lane, sent by the app>"
}'

4. Write a package

POST /run submits the job. Always send an Idempotency-Key: a network blip that replays the same request must not bill twice. A replay with the same key returns the stored result and is not charged again; a replay with the same key but a different body is a 409.

The response carries output.output (the Markdown package), charged_credits and truncated. If truncated is true the balance sat between min_credits and hold_credits and the output was cut short - render what arrived and say so rather than presenting it as complete.

curl -sS -X POST "https://api.skillsafe.ai/v1/app-api/run" \
  -H "Authorization: Bearer $SKILLSAFE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "task": "audit",
  "sheet": "<WIDTH, GAP and a TRACKS block, one track per line; the grammar is in /llms.txt>",
  "worry": "it graded fine last time and this one will not come clean",
  "rules": "<the working rules for this lane, sent by the app>"
}'

5. Stream a run

POST /run-stream is the same call with a text/event-stream response. Worth knowing before you build on it: from a server or from cURL you get event: delta frames carrying the output token by token; from a browser you get event: tick heartbeats and then one event: done with the whole output. Handle both, and treat ticks as liveness rather than progress.

Frame types are job (the job id), delta ({"text": "..."}), tick ({"t": seconds}), done, and error. An idempotent replay returns plain JSON with no stream at all, so check the content type before you start reading frames.

curl -sS -N -X POST "https://api.skillsafe.ai/v1/app-api/run-stream" \
  -H "Authorization: Bearer $SKILLSAFE_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -H "Idempotency-Key: cbd-$(date +%s)" \
  -d '{
  "task": "audit",
  "sheet": "<WIDTH, GAP and a TRACKS block, one track per line; the grammar is in /llms.txt>",
  "worry": "it graded fine last time and this one will not come clean",
  "rules": "<the working rules for this lane, sent by the app>"
}'

6. Read the result

output.output is Markdown in the envelope this app's system prompt guarantees: every section is a level-two heading spelled exactly as listed in the lane table above, in that order; tables are GitHub pipe tables with the declared columns; prompts are in fenced blocks opened with three backticks and the word text; checklists are - [x] lines.

So parsing is a split on /^## / - but do it fence-aware, because a prompt block can legitimately contain a line starting with ##. Count the sections you got against the ones the lane declares: a short list means the run was truncated, not that the contract changed.

def sections(md):
    out, name, buf, fence = {}, None, [], False
    for line in md.split("\n"):
        if line.lstrip().startswith("```"):
            fence = not fence
        if not fence and line.startswith("## "):
            if name:
                out[name] = "\n".join(buf).strip()
            name, buf = line[3:].strip(), []
            continue
        if name:
            buf.append(line)
    if name:
        out[name] = "\n".join(buf).strip()
    return out

The artifact most callers want is the fenced text block inside ## The Sheet or ## Corrected Sheet - that is a complete sheet in the grammar above, so it can be fed straight back into another lane with nothing carried alongside it. Every other section is prose and tables meant to be read.

Rate limits and good manners