DocsConnect

TypeScript SDK

The SDK wraps every command in a typed method. Method names match command names, so scaffold.task.create() is the task_create action of the task_write tool and POST /v1/tasks.

Install

npm install @scaffold-llc/sdk

Create a client

client.ts
import { Scaffold } from "@scaffold-llc/sdk"; const scaffold = new Scaffold({  token: process.env.SCAFFOLD_TOKEN,  maxRetries: 2,  timeout: 30_000,});

Options

tokenstring

A token from Settings, then Apps and tokens. Defaults to SCAFFOLD_TOKEN. It acts as you in its workspace, so never send it to a browser.

baseUrlstring

Defaults to https://scaffold.llc. Must be https, or http on localhost.

timeoutnumber

Milliseconds per request. Defaults to 30000.

maxRetriesnumber

Retries for 429 and 5xx responses, with backoff. Defaults to 2.

versionstring

The API version every request sends. Defaults to the SDK's own, 2026-10-01.

appSecretstring

Your app's secret, for the app_auth methods its server calls for its users. Defaults to SCAFFOLD_AUTH_SECRET, which every server app gets. Never send it to a browser.

Call a command

Arguments are one object. Answers are plain objects with the same field names as the HTTP API.

create-task.ts
const task = await scaffold.task.create({  workspace_id: "ws_01jbz5m8q6e4w3r2t1y0v9h8g7",  title: "Ship the booking page",  status: "doing",  assignee: "me",  labels: ["launch"],  due: "2026-11-04",});

Lists and pages

List methods return one page and its next cursor. Loop with for await and the SDK fetches each next page as you reach it.

lists.ts
for await (const task of scaffold.task.list({ workspace_id, status: "doing" })) {  console.log(task.id, task.title);} // Or one page at a timeconst page = await scaffold.task.list({ workspace_id, limit: 50 });const next = await scaffold.task.list({ workspace_id, starting_after: page.next_cursor });

Errors and retries

Failed calls throw a ScaffoldError with the same type as the HTTP error. Rate limits and unavailable answers are retried for you, after the wait Retry-After asks for.

errors.ts
import { Scaffold, ScaffoldError } from "@scaffold-llc/sdk"; try {  await scaffold.run.create({ workspace_id, agent: "planner", prompt: "Plan next week" });} catch (err) {  if (err instanceof ScaffoldError && err.type === "credits_exhausted") {    console.log("Out of credits. Top up in Settings, then Billing.");  } else throw err;}

Safe retries for writes

Pass an idempotency key and a retried write returns the first result instead of running twice. Keys last 24 hours.

create-task.ts
await scaffold.task.create(  { workspace_id, title: "Ship the booking page" },  { idempotencyKey: "launch-2026-10-29" },);

Your app's users

Your app's server signs its users up and in with scaffold.app_auth.sign_up(), sign_in(), email_send(), verify() and password_reset(), which need no token. Pass each user's address as clientIp, and each user spends their own rate limits while your server gets a larger budget of its own, rather than all your users sharing one. Only a call with the app's secret may pass an address, so a browser can't. Your app sits behind Scaffold's edge, which sends each visitor's address as X-Forwarded-For: in Express, set trust proxy to 1 so req.ip is that address rather than the edge's. Keep SCAFFOLD_AUTH_SECRET on the server.

server.ts
import { Scaffold } from "@scaffold-llc/sdk"; // In your app's server, which Scaffold gives SCAFFOLD_AUTH_SECRETconst scaffold = new Scaffold(); // Scaffold's edge sends each visitor's address as X-Forwarded-For, so req.ip is theirsapp.set("trust proxy", 1); app.post("/sign-in", async (req, res) => {  const session = await scaffold.app_auth.sign_in(    { project_id: process.env.SCAFFOLD_PROJECT_ID, email: req.body.email, password: req.body.password },    { clientIp: req.ip },  );  res.json(session);});

Types

types.ts
import type { Task, Run } from "@scaffold-llc/sdk"; function summary(task: Task): string {  return `${task.title} is ${task.status}`;}

Every method

scaffold.account.get()GET/v1/account Show the person you act for: name, email, signup time, how they sign in, the request's console session and any pending deletion. An ended console session answers 401 with why in the error's details.scaffold.image.get()GET/v1/images/{image_id} Read a logo or avatar by the image id ending its URL.scaffold.workspace.create()POST/v1/workspaces Create a workspace on Free with you as its owner, named 1 to 80 characters and unlike your other workspaces. Each person owns one Free workspace: while you own one, upgrade it before creating another. Your first workspace gets your 50 starter credits once your email is verified.scaffold.workspace.rename()POST/v1/workspaces/{workspace_id}/rename Rename a workspace you own. Its slug stays the same.scaffold.workspace.logo_set()POST/v1/workspaces/{workspace_id}/logo Set or clear the logo of a workspace you own.scaffold.workspace.delete()DELETE/v1/workspaces/{workspace_id} Delete a workspace you own, unless a paid plan renews.scaffold.workspace.restore()POST/v1/workspaces/{workspace_id}/restore Undo workspace.delete within 24 hours. A Free one waits while you own another Free workspace, as each person owns one.scaffold.workspace.export_start()POST/v1/workspaces/{workspace_id}/exports Zip a workspace you own. workspace.export_get shows its progress and workspace.export_download returns the zip once it is ready.scaffold.workspace.export_get()GET/v1/workspaces/{workspace_id}/export An export's progress; the latest by default.scaffold.workspace.export_download()GET/v1/workspaces/{workspace_id}/exports/{export_id}/download A ready export's zip, as base64. Needs write access, since it holds every project's database.scaffold.workspace.list()GET/v1/workspaces List your workspaces and your role in each.scaffold.workspace.member_invite()POST/v1/workspaces/{workspace_id}/invites Invite an email to a workspace you own. Pass on the invite link secret it answers, shown only once.scaffold.workspace.invite_revoke()DELETE/v1/invites/{invite_id} Revoke an open invite to a workspace you own, by its id from workspace.member_list.scaffold.workspace.invite_restore()POST/v1/invites/{invite_id}/restore Undo a revoke before the invite expires.scaffold.workspace.invite_dismiss()POST/v1/invites/{invite_id}/dismiss Hide a declined invite that workspace.member_list shows.scaffold.workspace.invite_accept()POST/v1/invites/accept Join a workspace by an invite sent to your account's email.scaffold.workspace.invite_decline()POST/v1/invites/decline Turn down an invite sent to your account's email, by its secret.scaffold.workspace.invite_get()POST/v1/invites/preview Show an invite from its link secret, signed in or not, and whether it is still open.scaffold.workspace.member_list()GET/v1/workspaces/{workspace_id}/members List a workspace's members with roles, avatars and last activity, and its open invites.scaffold.workspace.ownership_transfer()POST/v1/workspaces/{workspace_id}/transfer-ownership Make a member the owner of a workspace you own. The plan stops using your card and billing details; the new owner adds theirs in the billing portal.scaffold.workspace.member_remove()DELETE/v1/workspaces/{workspace_id}/members/{person_id} Remove a member from a workspace you own, or leave one with your own person_id. Revokes their tokens there.scaffold.project.create()POST/v1/projects Create a project in a workspace. Refused while a deleted one with the slug can be restored, unless ignore_restorable. A Free workspace holds 2 projects; server templates need the Paid plan.scaffold.project.list()GET/v1/projects List a workspace's projects, leaving out deleted ones.scaffold.project.get()GET/v1/projects/{project_id} Show a live project with its runtime, its newest deploy and, while Scaffold has it suspended, why and the statement of reasons to appeal.scaffold.project.metrics_get()GET/v1/projects/{project_id}/metrics Show a project's app users over 30 days and its costs this month: the credits of runs started for it, the hours its apps ran and what it stores.scaffold.project.address_check()GET/v1/projects/address-check Show the address a new project with this name would get and whether it is free. If not, project.create adds 4 random characters.scaffold.project.delete()DELETE/v1/projects/{project_id} Owner only: delete a project after a 24 hour grace period.scaffold.project.restore()POST/v1/projects/{project_id}/restore Owner only: restore a deleted project within 24 hours of deleting it, unless its Free workspace holds its 2 projects already.scaffold.project.erase()POST/v1/projects/{project_id}/erase Owner only: erase a deleted project now instead of when its 24 hours run out, with its deploys, env, domains and database.scaffold.env.set()POST/v1/projects/{project_id}/env Set a project's env var, encrypted at rest. A live server app is redeployed with it at once, without a rebuild, unless deploy is false.scaffold.env.list()GET/v1/projects/{project_id}/env List a project's env vars. Secrets show their name, never their value.scaffold.env.delete()DELETE/v1/projects/{project_id}/env/{name} Delete a project's env var by name. A live server app is redeployed without it, unless deploy is false; deploys made before keep their value for a rollback until the project is erased.scaffold.env.restore()POST/v1/projects/{project_id}/env/{name}/restore Undo a var's latest env.set: put back the value it replaced, or delete the var it created. A live server app is redeployed with that, unless deploy is false.scaffold.source.upload()PUT/v1/projects/{project_id}/sources Upload a project's code as one zip, stored once by its hash. Only the newest 5 uploads are kept, and uploading one again makes it the newest. The app's files sit at the zip's root, not in a folder: index.html for a static site, or package.json with a start script or main file for a Node app, without node_modules.scaffold.source.delete()DELETE/v1/projects/{project_id}/sources/{sha256} Delete a project's upload and its file. source.list gives each upload's sha256.scaffold.github.repository_list()GET/v1/workspaces/{workspace_id}/github/repositories List the GitHub repositories a workspace linked, which its members reach and gave Scaffold's GitHub App, for github.connect.scaffold.github.connect()POST/v1/projects/{project_id}/github Connect a project to a GitHub repository, so each push to its branch deploys. Replaces the repository it followed.scaffold.github.get()GET/v1/projects/{project_id}/github Show a project's GitHub repository and branch, and its latest pushes with the deploy each started.scaffold.github.branch_set()PATCH/v1/projects/{project_id}/github Change the branch whose pushes deploy a project connected to GitHub.scaffold.github.release_command_set()PUT/v1/projects/{project_id}/github/release_command Set the command, like a migration, that each pushed deploy of a project connected to GitHub runs before it goes live, after a dump of its database. Null for none.scaffold.github.disconnect()DELETE/v1/projects/{project_id}/github Stop deploying a project from GitHub. Its uploads and deploys stay.scaffold.github.deploy()POST/v1/projects/{project_id}/github/deploy Deploy the head of a connected project's branch now, as a push would. github.get shows the deploy it starts.scaffold.source.list()GET/v1/projects/{project_id}/sources List a project's uploads of its code, newest first. An upload's sha256 is all deploy.create needs to build it.scaffold.source.file_list()GET/v1/projects/{project_id}/sources/{sha256}/files List the files in one of a project's uploads, by path. source.list or a deploy's source_sha256 gives the hash.scaffold.source.file_get()GET/v1/projects/{project_id}/sources/{sha256}/file Read one file of a project's upload. Text of at most 256 KB comes back whole; a binary or longer file comes back as its kind and size only.scaffold.app_db.get()GET/v1/projects/{project_id}/database Show a project's Postgres database: its state, version, stored size, and DATABASE_URL with the password masked.scaffold.app_db.backup_list()GET/v1/projects/{project_id}/database/backups Paid plan: list a project database's backups, newest first: daily at 03:00 UTC, before each restore and before each deploy's migrations, each kept 6 days. Also its latest restore and dump.scaffold.app_db.backup_restore()POST/v1/projects/{project_id}/database/backups/{backup_id}/restore Paid plan, owners only: put a backup in place of everything in a project's database, which is read-only from when the restore starts until it ends. Rows written since are lost, so the current data is backed up first as undo_backup_id; restoring that backup undoes this. A restore that fails leaves the database as it was.scaffold.cron.create()POST/v1/projects/{project_id}/cron-jobs Paid plan: POST to a path of the project's live app on a cron schedule, waking it if asleep. Each fire runs once, signed by a Scaffold-Signature JWT the project's JWKS verifies. A project sends 2 fires at once and a workspace 8; times that pass while it waits show as one missed fire, and the newest runs.scaffold.cron.list()GET/v1/projects/{project_id}/cron-jobs List a project's cron jobs with their next time and newest fires.scaffold.cron.update()PATCH/v1/cron-jobs/{cron_job_id} Change a cron job's schedule, timezone or path, or pause and resume it.scaffold.cron.delete()DELETE/v1/cron-jobs/{cron_job_id} Delete a cron job and its fires. It answers the job as it was.scaffold.test_run.start()POST/v1/projects/{project_id}/test-runs Start showing a test run of the project's code in the console, live: the command, who runs it and, when the runner knows, each test file and its test count. Report results with test_run.report as tests finish.scaffold.test_run.report()POST/v1/test-runs/{test_run_id}/results Report tests that finished in a test run's latest attempt, up to 1,000 at once, each with its file, name, status and duration. done ends the attempt. A test reported again in the same attempt replaces its result.scaffold.test_run.fix()PUT/v1/test-runs/{test_run_id}/fix Show what you are doing to fix a test run's failures, over its graph: the test file, a short note and the files you changed with lines added and removed. Each call replaces the last.scaffold.test_run.rerun()POST/v1/test-runs/{test_run_id}/reruns Start the next attempt of a test run once the last ended, of every file or the files named, then report it with test_run.report. A run reruns 19 times at most.scaffold.test_run.list()GET/v1/projects/{project_id}/test-runs List a project's 20 newest test runs with their state and counts.scaffold.test_run.get()GET/v1/test-runs/{test_run_id} Get a test run with every test's result in each attempt, the agent's fix and the files it changed.scaffold.test_run.delete()DELETE/v1/test-runs/{test_run_id} Delete a test run and every result it holds.scaffold.storage.list()GET/v1/projects/{project_id}/storage List the files a project's app stores, by name, or only those whose name starts with prefix, like avatars/.scaffold.storage.usage_get()GET/v1/workspaces/{workspace_id}/storage Show what the files of all a workspace's apps take together, and the cap its plan sets on them.scaffold.storage.upload_sign()POST/v1/projects/{project_id}/storage/upload-url Sign a URL that uploads one file of up to 50 MB to a project, for 15 minutes or expires_in_seconds: PUT the bytes to it with their Content-Type, from the app's server or a user's browser. A name a file holds already is refused.scaffold.storage.download_sign()GET/v1/projects/{project_id}/storage/download-url Sign a URL that downloads one of a project's files, for 15 minutes or expires_in_seconds, up to a week: link to it or put it in an img tag.scaffold.storage.delete()DELETE/v1/projects/{project_id}/storage Delete a project's stored file by name, so signed URLs answer not found and its bytes no longer count toward the workspace's cap.scaffold.token.create()POST/v1/tokens Create a token for a workspace, or a test one for your sandbox. Its secret is shown once.scaffold.token.list()GET/v1/tokens List the tokens of a workspace, revoked ones included, without secrets.scaffold.token.revoke()DELETE/v1/tokens/{token_id} Revoke a token and every token it created, so their next request fails. A member may revoke only their own tokens, an owner any in the workspace.scaffold.oauth.grant_list()GET/v1/oauth/grants List the OAuth apps you approved, and as an owner every app in your workspaces.scaffold.oauth.grant_revoke()DELETE/v1/oauth/grants/{grant_id} Revoke an OAuth app you approved, or as an owner any app in your workspace, so its next request fails. oauth.grant_list gives each grant_id.scaffold.credit.balance_get()GET/v1/workspaces/{workspace_id}/credits Show a workspace's credits: balance, held, available and the monthly cap.scaffold.credit.ledger_list()GET/v1/workspaces/{workspace_id}/credits/ledger List a workspace's latest 200 credit entries, newest first.scaffold.credit.cap_set()POST/v1/workspaces/{workspace_id}/credits/cap Set or remove a workspace's monthly spending cap. Owners only.scaffold.credit.pack_list()GET/v1/credits/packs List the credit packs a top-up can buy, with their prices.scaffold.credit.top_up_start()POST/v1/workspaces/{workspace_id}/credits/top-ups Buy the credit pack of a Stripe price with the card the plan is paid with. Owners only.scaffold.credit.top_up_get()GET/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id} Show whether a top-up was added, failed or still waits for the bank.scaffold.credit.top_up_request()POST/v1/workspaces/{workspace_id}/credits/top-up-requests Ask the workspace's owners to top up, in their inbox. Members only, once a day.scaffold.credit.top_up_withdraw()POST/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}/withdraw Withdraw from a top-up within 14 days and refund its unused credits, once any dispute ends. Owners only.scaffold.billing.get()GET/v1/workspaces/{workspace_id}/billing Show a workspace's plan, Free or Paid: price, card, renewal or end, a failed renewal's fix-by date, withdrawal deadlines and any unpaid payment page.scaffold.billing.prices_get()GET/v1/billing/prices Show yearly and monthly Paid plan prices before tax, the credits each grants a month (null when it grants none), and the 14-day withdrawal charge per credit.scaffold.billing.subscribe_start()POST/v1/workspaces/{workspace_id}/billing/subscribe Open a Stripe payment page for the paid plan, yearly or monthly, which grants nothing before Stripe confirms. Owners only, on the free plan.scaffold.billing.subscribe_cancel()POST/v1/workspaces/{workspace_id}/billing/subscribe/cancel Give up on the plan's unpaid Stripe payment page, so it can no longer be paid. Owners only.scaffold.billing.cancel()POST/v1/workspaces/{workspace_id}/billing/cancel End the Paid plan when its paid period ends. Owners only.scaffold.billing.resume()POST/v1/workspaces/{workspace_id}/billing/resume Keep a cancelled Paid plan, so it renews again. Owners only, before its period ends.scaffold.billing.portal_open()POST/v1/workspaces/{workspace_id}/billing/portal Open Stripe's billing portal to change or cancel the plan. Owners only, once the workspace subscribed.scaffold.billing.withdraw()POST/v1/workspaces/{workspace_id}/billing/withdraw Withdraw from the paid plan within 14 days of subscribing: cancel it now and refund it, less the credits used if the owner asked to start at once, once any dispute ends. Owners only.scaffold.change.list()GET/v1/workspaces/{workspace_id}/changes List what changed in a workspace, newest first, 100 at a time. Pass the last position you saw as after to catch up oldest first.scaffold.change.command_get()GET/v1/commands/{command_id}/changes List the record versions one command made, before and after.scaffold.change.export()GET/v1/workspaces/{workspace_id}/changes/export Export a workspace's changes as CSV. Owners only.scaffold.trash.list()GET/v1/workspaces/{workspace_id}/trash List what was deleted in a workspace and can still be restored.scaffold.database.create()POST/v1/workspaces/{workspace_id}/databases Create a database, which keeps a Title field; add each field asked for with field.create.scaffold.database.list()GET/v1/workspaces/{workspace_id}/databases List a workspace's databases with their fields and option ids.scaffold.database.rename()POST/v1/databases/{database_id}/rename Rename a database.scaffold.database.archive()POST/v1/databases/{database_id}/archive Archive a database, hiding it from database.list unless include_archived. It is erased after 30 days, and relation fields lose their links to it.scaffold.database.restore()POST/v1/databases/{database_id}/restore Restore an archived database.scaffold.field.create()POST/v1/databases/{database_id}/fields Add a typed field to a database; its kind cannot change later. A select or multi_select takes options, a relation its relation_database_id.scaffold.field.rename()POST/v1/fields/{field_id}/rename Rename a field. Record values stay keyed by its id.scaffold.field.options_set()POST/v1/fields/{field_id}/options Set a select or multi_select field's options in order: keep or rename one by id, add one without. One left out is removed, refused while any record holds it, archived ones too.scaffold.field.relation_set()POST/v1/fields/{field_id}/relation Set the database a relation field links to, refused while records link through it, and two_way: whether that database shows its links back.scaffold.field.archive()POST/v1/fields/{field_id}/archive Archive a field, hiding its values. Search stops finding a text field's values within moments.scaffold.field.restore()POST/v1/fields/{field_id}/restore Restore an archived field and show its values again. Search finds a text field's values again within moments.scaffold.record.create()POST/v1/databases/{database_id}/records Add a record to a database, with values keyed by field id.scaffold.record.query()POST/v1/databases/{database_id}/query Filter, sort and page a database's records.scaffold.record.get()GET/v1/records/{record_id} Show a record with its version, live field values and subtasks.scaffold.record.update()POST/v1/records/{record_id} Change a record's values at the version you read.scaffold.record.subtasks_set()POST/v1/records/{record_id}/subtasks Replace a record's subtasks with this checklist.scaffold.record.archive()POST/v1/records/{record_id}/archive Archive a record at the version you read.scaffold.record.restore()POST/v1/records/{record_id}/restore Restore an archived record at the version you read.scaffold.record.bulk_update()POST/v1/databases/{database_id}/records/bulk-update Change records of one database in one command, each update shaped like record.update's input.scaffold.record.bulk_create()POST/v1/databases/{database_id}/records/bulk-create Add records to one database in one command.scaffold.record.bulk_archive()POST/v1/databases/{database_id}/records/bulk-archive Archive records of one database in one command.scaffold.record.bulk_restore()POST/v1/databases/{database_id}/records/bulk-restore Restore archived records of one database in one command.scaffold.record.history()GET/v1/records/{record_id}/history List a record's versions, newest first, 100 at a time, each with who made it, its command_id and each changed field before and after.scaffold.record.undo()POST/v1/record-commands/{command_id}/undo Undo one command's record changes by its command_id. Refused as a conflict if any of its records changed since. Undoing an undo redoes it.scaffold.card.move()POST/v1/records/{record_id}/move Move a record at the version you read, like a board card, after or before another of its database, setting values in the same write. Without after or before it stays put.scaffold.card.assigned_list()GET/v1/workspaces/{workspace_id}/records/assigned List a workspace's open or done records that name you in a person field, across its databases.scaffold.task.list()GET/v1/tasks List a workspace's tasks, newest first.scaffold.task.create()POST/v1/tasks Add a task. New labels stay after its undo.scaffold.task.update()PATCH/v1/tasks/{task_id} Change a task's title, assignee or due date; null clears one.scaffold.task.move()POST/v1/tasks/{task_id}/move Move a task to a column, at a position in it.scaffold.view.create()POST/v1/databases/{database_id}/views Save a view of a database. A board needs group_by, a timeline its dates, a sprint view its sprint source.scaffold.view.list()GET/v1/databases/{database_id}/views List a database's views with their settings, oldest first.scaffold.view.update()POST/v1/views/{view_id} Replace a view's settings; its name stays.scaffold.view.rename()POST/v1/views/{view_id}/rename Rename a view.scaffold.view.archive()POST/v1/views/{view_id}/archive Archive a view, hiding it from view.list unless include_archived.scaffold.view.restore()POST/v1/views/{view_id}/restore Restore an archived view.scaffold.view.record_list()GET/v1/views/{view_id}/records Page a view's records as its settings show them: a board column by group, a timeline from and to, my tasks for you, or the current sprint's records with that sprint.scaffold.page.create()POST/v1/workspaces/{workspace_id}/pages Create a page in a workspace, or a record's body with record_id.scaffold.page.list()GET/v1/workspaces/{workspace_id}/pages List a workspace's pages, oldest first, without blocks.scaffold.page.get()GET/v1/pages/{page_id} Read a page as Markdown, or with format blocks as blocks with stable ids, types, props, styled text and children, which page.edit targets.scaffold.page.rename()POST/v1/pages/{page_id}/rename Set a standalone page's title. A record's body has no title, since the record names it.scaffold.page.archive()POST/v1/pages/{page_id}/archive Archive a page: it leaves page.list, takes no edits and is erased after 30 days. A record's body goes with its record through record.archive instead.scaffold.page.restore()POST/v1/pages/{page_id}/restore Restore an archived page with the content it had.scaffold.page.edit()POST/v1/pages/{page_id}/edit Change a page's blocks by id with 1 to 100 ops that insert, update or delete blocks. An edit of over 10 blocks, or with preview true, changes nothing and answers each block before and after with a confirm token; send the same ops with it to apply them. It answers new block ids and the ops that undo it. An edit that could not be undone is refused, like deleting over about 256 KiB at once, so delete big sections in steps.scaffold.page.append()POST/v1/pages/{page_id}/blocks Add Markdown at the end of a page or after a block. <@usr_...> mentions a member; an image alone in its paragraph adds an image block.scaffold.page.propose()POST/v1/pages/{page_id}/proposals Propose a rewrite of a page with ops as page.edit takes them, for a person to accept or discard in the console. Nothing changes until they accept it, so propose rewrites a person should see first.scaffold.page.proposal_get()GET/v1/pages/{page_id}/proposals/{proposal_id} Read a proposed rewrite of a page. While it is open it answers the page's blocks now and as accepting it would leave them, or that it is stale since a block it rewrites changed.scaffold.page.proposal_list()GET/v1/pages/{page_id}/proposals List the proposed rewrites of a page that wait for a person, oldest first.scaffold.page.proposal_discard()POST/v1/pages/{page_id}/proposals/{proposal_id}/discard Discard a proposed rewrite of a page and leave the page as it is. It answers the proposal's ops, which page.propose takes to propose it again.scaffold.model.list()GET/v1/models List the models runs may use, their token prices now in millicredits per million, and the price version.scaffold.command.describe()GET/v1/commands/{name} Describe a command by its catalog or MCP name: its MCP tool and action, what it does, how to undo it and the JSON schema of its input.scaffold.app_auth.user_list()GET/v1/projects/{project_id}/auth/users List a project's app users in id order, a page at a time, with their status, last sign-in and live sessions, filtered by name or email and status. Counts the matches and all users.scaffold.app_auth.user_show()GET/v1/projects/{project_id}/auth/users/{user_id} Show one app user: status, lock end, sign-up, last sign-in, sign-in methods and, while unconfirmed, when they are deleted.scaffold.app_auth.user_unlock()POST/v1/projects/{project_id}/auth/users/{user_id}/unlock Owners only: end the 15-minute lock five wrong passwords put on an app user's email.scaffold.app_auth.user_email_send()POST/v1/projects/{project_id}/auth/users/{user_id}/email Email an app user a password reset, or their unconfirmed address's confirmation again. At most one of each a minute, counted like the user's own requests: 3 auth emails an hour per address, and the workspace's monthly quota while the address is unproven.scaffold.app_auth.user_session_list()GET/v1/projects/{project_id}/auth/users/{user_id}/sessions List an app user's live sessions with the device and place each signed in from.scaffold.app_auth.user_session_revoke()DELETE/v1/projects/{project_id}/auth/users/{user_id}/sessions/{session_id} End one of an app user's sessions.scaffold.app_auth.user_sign_out_everywhere()POST/v1/projects/{project_id}/auth/users/{user_id}/sign-out End every session of an app user.scaffold.app_auth.sign_in_event_list()GET/v1/projects/{project_id}/auth/sign-ins List a project's app sign-in events of the last 90 days, newest first, 100 at a time: sign-ups, sign-ins, wrong passwords, locks, emails and sign-outs, with place and IP.scaffold.app_auth.user_delete()DELETE/v1/projects/{project_id}/auth/users/{user_id} Owners only: delete an app user. Their email, password and sign-in history are erased and every session ends.scaffold.app_auth.settings_get()GET/v1/projects/{project_id}/auth/settings Show where a project's auth emails may link to.scaffold.app_auth.settings_update()POST/v1/projects/{project_id}/auth/settings Replace the site URL a project's auth emails link to and the other URLs they may.scaffold.app_auth.email_usage_get()GET/v1/projects/{project_id}/auth/email-usage Show the emails a project's app queued this month, its workspace's total against the plan's monthly quota, and its hourly email.send limit.scaffold.app_auth.email_suppression_list()GET/v1/projects/{project_id}/auth/email-suppressions List the addresses a project's app no longer emails, after a bounce, a spam complaint or by hand.scaffold.app_auth.email_suppression_add()POST/v1/projects/{project_id}/auth/email-suppressions Stop a project's app emailing an address: auth emails and email.send skip it.scaffold.app_auth.email_suppression_remove()POST/v1/projects/{project_id}/auth/email-suppressions/remove Let a project's app email a suppressed address again.scaffold.app_auth.sender_get()GET/v1/projects/{project_id}/auth/sender Show who a project's emails come from: its name beside the address every app sends from.scaffold.email.send()POST/v1/projects/{project_id}/email Email one person from a project's app, like a receipt or a reminder, with the project's name as the sender. It counts against the workspace's monthly quota and the project's 100 an hour.scaffold.app_payments.connect_start()POST/v1/projects/{project_id}/payments/connect Link a project's app to a Stripe account its customer owns and answer its setup page. Rerun for a new page.scaffold.app_payments.account_get()GET/v1/projects/{project_id}/payments/account Show if a project's Stripe account can charge and pay out, and what Stripe needs.scaffold.app_payments.revenue_get()GET/v1/projects/{project_id}/payments/revenue Show what a project's Stripe account took over 30 days, per currency.scaffold.app_payments.disconnect()DELETE/v1/projects/{project_id}/payments/account Unlink a project's app from its Stripe account; the customer keeps it.scaffold.app_payments.dashboard_link()GET/v1/projects/{project_id}/payments/dashboard Link to the Stripe Dashboard of a project's Stripe account.scaffold.app_payments.webhook_delivery_list()GET/v1/projects/{project_id}/payments/deliveries List the Stripe events forwarded to a project's app, with each try.scaffold.app_payments.webhook_delivery_resend()POST/v1/projects/{project_id}/payments/deliveries/{event_id}/resend Forward a Stripe event to a project's app again now.scaffold.realtime.publish()POST/v1/projects/{project_id}/realtime/channels/{channel}/messages Send JSON to a channel of a project's app, reaching each of its signed-in users subscribed to the channel now. Nothing is stored, so a later subscriber never gets it. Any signed-in user of the app can subscribe to any of its channels, so never publish one user's private data to a guessable channel; per-user private channels are not built yet.scaffold.realtime.channel_list()GET/v1/projects/{project_id}/realtime/channels List the realtime channels of a project's app that its users subscribe to now, with each one's subscriptions and the project's cap.scaffold.run.create()POST/v1/runs Start a run of an agent. It holds the top of its estimate, or its first model call's cost if more, from the workspace's credits and gives back what it does not spend.scaffold.run.quote()POST/v1/runs/quote Price a run: its estimate, what run.create would hold, the credits available and which cap, limit or shortfall would refuse it.scaffold.run.list()GET/v1/runs List agent runs, newest first.scaffold.run.get()GET/v1/runs/{run_id} Read an agent run: status, steps with what each spent, credits, approvals and edits an undo keeps.scaffold.run.stop()POST/v1/runs/{run_id}/stop Stop a running or waiting run. Its edits stay until run.undo.scaffold.run.approval_list()GET/v1/workspaces/{workspace_id}/approvals List the changes waiting for your approval: your runs', and every member's for a workspace owner.scaffold.run.deny()POST/v1/runs/{run_id}/deny Deny the change a run waits on and stop the run.scaffold.run.resume()POST/v1/runs/{run_id}/resume Resume a run stopped by a person, a limit or its credits.scaffold.run.follow_up()POST/v1/runs/{run_id}/follow-up Ask a done or denied run more; its agent goes on in the same run.scaffold.run.undo()POST/v1/runs/{run_id}/undo Take back every edit of an ended run as one change. Refused while run.get lists later edits, unless keep_changed.scaffold.agent.list()GET/v1/workspaces/{workspace_id}/agents List a workspace's agents, their settings and whether each is paused or working. Which models agents may use and what they cost is model.list's answer.scaffold.agent.get()GET/v1/agents/{agent_id} Read an agent: what it does, may do and asks before doing, and its settings.scaffold.agent.update()PATCH/v1/agents/{agent_id} Owners only: change what an agent asks before doing, its default model or its monthly limit in millicredits.scaffold.agent.pause()POST/v1/agents/{agent_id}/pause Owners only: pause an agent. It starts no runs and skips its schedules; runs going now finish.scaffold.agent.resume()POST/v1/agents/{agent_id}/resume Owners only: resume a paused agent. A stopped run resumes by run.resume.scaffold.schedule.list()GET/v1/workspaces/{workspace_id}/schedules List a workspace's schedules, oldest first, with when each runs next.scaffold.schedule.create()POST/v1/workspaces/{workspace_id}/schedules Paid plan: run an agent on a repeating time, as you. A run it cannot start, as while the agent is paused, is skipped.scaffold.schedule.update()PATCH/v1/schedules/{schedule_id} Change a schedule. Only its maker and owners may, and only its maker its prompt or agent, as it runs as them.scaffold.schedule.delete()DELETE/v1/schedules/{schedule_id} Delete a schedule. Only its maker and owners may.scaffold.schedule.restore()POST/v1/schedules/{schedule_id}/restore Bring back a deleted schedule.scaffold.schedule.run_now()POST/v1/schedules/{schedule_id}/run Start a run of a schedule now, as you, without moving its next run.scaffold.onboarding.get()GET/v1/workspaces/{workspace_id}/onboarding Show your setup checklist in a workspace and what ticked each step.scaffold.onboarding.step_skip()POST/v1/workspaces/{workspace_id}/onboarding/{step}/skip Put off a setup step that is not done. It still ticks if it happens.scaffold.onboarding.step_resume()POST/v1/workspaces/{workspace_id}/onboarding/{step}/resume Bring back a skipped setup step.scaffold.notification.list()GET/v1/workspaces/{workspace_id}/notifications List your notifications in a workspace, newest first, by unread or source.scaffold.notification.read()POST/v1/workspaces/{workspace_id}/notifications/read Mark your notifications read, answering those it changed.scaffold.notification.unread()POST/v1/workspaces/{workspace_id}/notifications/unread Mark your notifications unread, answering those it changed.scaffold.notification.read_all()POST/v1/workspaces/{workspace_id}/notifications/read-all Mark up to 1000 unread notifications read, newest first, answering them.scaffold.notification.unread_count()GET/v1/workspaces/{workspace_id}/notifications/unread-count Count your unread notifications, in all and per source.scaffold.notification.preferences_get()GET/v1/workspaces/{workspace_id}/notifications/preferences Show how each source reaches you: in app, and by email at 18:00 UTC.scaffold.notification.preferences_set()POST/v1/workspaces/{workspace_id}/notifications/preferences Set whether a source reaches you in app and by email.scaffold.search.query()GET/v1/workspaces/{workspace_id}/search Find tasks, records, pages and runs by words or a record key, with counts per kind.scaffold.comment.create()POST/v1/records/{record_id}/comments Comment on a record.scaffold.comment.list()GET/v1/records/{record_id}/comments List a record's comments, oldest first.scaffold.comment.delete()DELETE/v1/comments/{comment_id} Delete your comment.scaffold.comment.restore()POST/v1/comments/{comment_id}/restore Bring back your deleted comment.scaffold.status.get()GET/v1/status Show Scaffold's status overall and per component, open incidents, planned maintenance and console notices. Needs no sign-in.scaffold.status.version_get()GET/v1/version Show which build of Scaffold answers: its git commit and when it was built. Needs no sign-in.scaffold.status.incident_list()GET/v1/status/incidents List incidents and maintenance open in the last 90 days, newest first, with updates. Needs no sign-in.scaffold.status.incident_get()GET/v1/status/incidents/{incident_id} Show one incident or maintenance window with every update and any write-up. Needs no sign-in.scaffold.deploy.create()POST/v1/projects/{project_id}/deploys Build a project's upload in a sandbox, a Node app or a static site, and put it live once it serves. It needs only the upload's sha256 from source.list, or none for the newest, and answers the deploy with its status and URL. The live deploy stays ready for deploy.rollback. A Node app needs the Paid plan and takes the env as it is now, plus DATABASE_URL; an optional release command runs first, after a dump of the database. A deploy of the project not yet live fails in its favour. package.json "scaffold": {"kind": "worker"} makes a worker: no web page, never sleeps, Paid only.scaffold.deploy.list()GET/v1/projects/{project_id}/deploys List a project's deploys, newest first.scaffold.deploy.recent_list()GET/v1/workspaces/{workspace_id}/deploys List the newest deploy of each project in a workspace, newest first, with its status, so one read shows where every project stands.scaffold.deploy.get()GET/v1/deploys/{deploy_id} Show a deploy and its status: queued, building, starting, live, superseded, rolled_back or failed with its reason.scaffold.deploy.rollback()POST/v1/deploys/{deploy_id}/rollback Undo a deploy.create: put an earlier deploy of the project back live, without a rebuild, and its database too with restore_database, which only an owner on the Paid plan may ask. A static site goes back on any plan, a Node app needs the Paid plan. The deploy it replaces can be rolled back to in turn, and a deploy not yet live fails. While the database is put back, the project's address shows the maintenance page.scaffold.domain.add()POST/v1/projects/{project_id}/domains Add a custom domain to a project's app. A Free workspace has 1 custom domain; more need the Paid plan. It waits for the DNS records it answers: a CNAME to Scaffold, or an A record at the apex, and a TXT record proving it is yours. Other projects' claims never block it, verified ones included: the project whose records verify the domain takes it from the rest, and a claim that never verifies expires after 7 days.scaffold.domain.list()GET/v1/projects/{project_id}/domains List a project's custom domains, oldest first, with where each stands, the DNS records it needs and when its certificate renews.scaffold.domain.check()POST/v1/domains/{domain_id}/check Check a custom domain's DNS now. Once it points at Scaffold with its TXT record it is verified: it serves the project's live deploy and gets its certificate on its first visit, other projects' unverified claims on it are removed, and one that held it verified goes back to waiting. A wrong or missing record is named with its fix. Scaffold rechecks verified domains daily: one whose records are gone 3 days goes back to waiting and stops serving. A verified domain whose records point away from Scaffold is marked so, with the problem found, and gets no new certificate until a check finds them pointing back.scaffold.domain.remove()DELETE/v1/domains/{domain_id} Remove a custom domain from its project. The app stops answering there at once, its certificate is deleted within a day and never renewed, and any project can add it again with domain.add.scaffold.deploy.logs()GET/v1/deploys/{deploy_id}/logs Read a deploy's log a page at a time: its app's output, each line with its time and newest first read, or its build steps. range keeps the last 15m, 1h, 24h or 7d; pass next as after to read on. Over HTTP, follow it as a stream to get each new page as the log grows.scaffold.project.health_get()GET/v1/projects/{project_id}/health Show a project's requests, errors, p95 latency, unavailable requests and downtime per hour over the last 24 hours, all its deploys together.scaffold.project.status_get()GET/v1/projects/{project_id}/status Show whether each deploy a project's host keeps is awake, asleep or exited, with its wakes, sleeps, OOM kills and CPU.scaffold.project.limits_get()GET/v1/projects/{project_id}/limits Show the CPU, memory, disk, processes and sleep window a project's app runs under on its plan, and what its live deploy uses now.scaffold.webhook.endpoint_create()POST/v1/projects/{project_id}/webhooks Register an https endpoint for a project's deploy and app user events. Each is POSTed signed, under an event id to dedupe by. The signing secret is shown once.scaffold.webhook.endpoint_list()GET/v1/projects/{project_id}/webhooks List a project's webhook endpoints, oldest first, without secrets.scaffold.webhook.endpoint_update()PATCH/v1/webhooks/{endpoint_id} Change a webhook endpoint's URL or event types, or turn it off or on again. It keeps its signing secret.scaffold.webhook.endpoint_delete()DELETE/v1/webhooks/{endpoint_id} Delete a webhook endpoint with its signing secret and delivery log. Nothing more is posted to it.scaffold.webhook.delivery_list()GET/v1/projects/{project_id}/webhook-deliveries List a project's webhook deliveries of the last 30 days, newest first, with each try and what the endpoint answered.scaffold.webhook.delivery_resend()POST/v1/webhook-deliveries/{delivery_id}/resend Try a webhook delivery that has not succeeded again now, with the same event id and body.scaffold.project.alert_get()GET/v1/projects/{project_id}/alerts Show the error share that alerts a project's owners, 1, 2 or 5%, and the alert firing now with its errors since it started.scaffold.project.alert_set()PUT/v1/projects/{project_id}/alerts Set the error share over 5 minutes, 1, 2 or 5%, above which a project's owners get an email and an inbox item. Owners only, on the Paid plan.scaffold.project.maintenance_set()PUT/v1/projects/{project_id}/maintenance Turn a project's maintenance mode on or off, as its owner. While on, its address and domains show a maintenance page and its deploys keep running on their own addresses.scaffold.project.move()POST/v1/projects/{project_id}/move Move a project to another workspace, owning both. Its deploys, domains, env, database with its backups, files, source uploads, logs, cron jobs, webhooks and app users go with it and nothing goes offline. For someone else's workspace, make a claim link. A Free workspace takes no server code and holds 2 projects and 1 custom domain.scaffold.project.credentials_rotate()POST/v1/projects/{project_id}/credentials/rotate Owners only: give a project's DATABASE_URL a new password and SCAFFOLD_STRIPE_WEBHOOK_SECRET a new value, so copies anyone kept stop working, and redeploy its live server app with them. Sessions opened with the old password end once a deploy with the new one is live, or within an hour. Removing a member and moving the project do this too.scaffold.project.claim_link_create()POST/v1/projects/{project_id}/claim-link Make a claim link for a project you own, in place of any open one. The owner of another workspace who opens it moves the project there, once, within 7 days, with its backups, source uploads and logs. Its secret is answered only once.scaffold.project.claim_link_cancel()DELETE/v1/projects/{project_id}/claim-link Cancel a project's open claim link, so it no longer moves the project.