API reference
JSON over HTTPS. Every endpoint is also an MCP tool and an SDK method, shown beside it. Hover a parameter to find it in the code.
- Base URL
https://scaffold.llc- Auth
Authorization: Bearer scf_live_…Tokens
Account
Link to Retrieve your accountRetrieve your account
/v1/accountShow 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.
account_get in account_readscaffold.account.get()ReadReturns
Your account, with how you sign in and any pending deletion.
Images
Link to Retrieve an imageRetrieve an image
/v1/images/{image_id}Read a logo or avatar by the image id ending its URL.
image_get in account_readscaffold.image.get()ReadPath parameters
image_idstringrequiredReturns
The image as a base64 PNG.
Errors
not_foundNo logo or avatar you can see has that id.Workspaces
Link to Create a workspaceCreate a workspace
/v1/workspacesCreate 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.
workspace_create in workspace_irreversiblescaffold.workspace.create()WriteAgents ask firstBody parameters
namestringrequiredReturns
The new workspace.
Errors
validation_failedThe name is blank, over 80 characters or has no letter or digit.conflictYou already have a workspace with that name, or a deleted one still holds it.plan_requiredYou own a Free workspace already, which details.workspace_id names: upgrade it first.Link to Rename a workspaceRename a workspace
/v1/workspaces/{workspace_id}/renameRename a workspace you own. Its slug stays the same.
workspace_rename in workspace_writescaffold.workspace.rename()WritePath parameters
workspace_idstringrequiredBody parameters
namestringrequiredReturns
The renamed workspace.
Errors
validation_failedThe name is blank or over 80 characters.forbiddenYou are not an owner of the workspace.Link to Set a workspace logoSet a workspace logo
/v1/workspaces/{workspace_id}/logoSet or clear the logo of a workspace you own.
workspace_logo_set in workspace_writescaffold.workspace.logo_set()WritePath parameters
workspace_idstringrequiredBody parameters
imagestringA new image. Omit it, and restore_image_id, to show none.
restore_image_idstringInstead of image, an earlier set's previous_image_id, to undo it.
Returns
The workspace with its new logo, and the id of the image it replaced.
Errors
validation_failedThe image is not an intact PNG, JPEG, GIF or WebP, is too large, or comes with restore_image_id.forbiddenYou are not an owner of the workspace.not_foundrestore_image_id is not the logo shown just before.Link to Delete a workspaceDelete a workspace
/v1/workspaces/{workspace_id}Delete a workspace you own, unless a paid plan renews.
workspace_delete in workspace_writescaffold.workspace.delete()WritePath parameters
workspace_idstringrequiredReturns
The workspace's id and when it is erased.
Errors
forbiddenYou are not an owner of the workspace.conflictA paid plan renews: cancel it first.upstreamStripe failed. Try again.Link to Restore a workspaceRestore a workspace
/v1/workspaces/{workspace_id}/restoreUndo workspace.delete within 24 hours. A Free one waits while you own another Free workspace, as each person owns one.
workspace_restore in workspace_writescaffold.workspace.restore()WritePath parameters
workspace_idstringrequiredReturns
The restored workspace.
Errors
forbiddenYou are not its owner, or it was erased.not_foundThe workspace is not deleted, or its 24 hours to restore have passed.plan_requiredIt is on Free and you own another Free workspace, which details.workspace_id names: upgrade or delete that one first.Link to Export a workspaceExport a workspace
/v1/workspaces/{workspace_id}/exportsZip a workspace you own. workspace.export_get shows its progress and workspace.export_download returns the zip once it is ready.
workspace_export_start in workspace_irreversiblescaffold.workspace.export_start()WriteAgents ask firstPath parameters
workspace_idstringrequiredReturns
The export, being prepared.
Errors
forbiddenYou are not an owner of the workspace.conflictAn export of the workspace is still being prepared.Link to Retrieve an exportRetrieve an export
/v1/workspaces/{workspace_id}/exportAn export's progress; the latest by default.
workspace_export_get in workspace_readscaffold.workspace.export_get()ReadPath parameters
workspace_idstringrequiredQuery parameters
export_idstringThe workspace's latest export when omitted.
Returns
The export with its status and progress.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe workspace has no export with that id, or none yet.Link to Download an exportDownload an export
/v1/workspaces/{workspace_id}/exports/{export_id}/downloadA ready export's zip, as base64. Needs write access, since it holds every project's database.
workspace_export_download in workspace_readscaffold.workspace.export_download()ReadPath parameters
export_idstringrequiredworkspace_idstringrequiredReturns
The export's zip as base64, with its file name.
Errors
forbiddenYou are not an owner of the workspace, or the token is read-only.not_foundThe workspace has no export with that id, or none yet.conflictThe export is not ready, failed or expired.Link to List workspacesList workspaces
/v1/workspacesList your workspaces and your role in each.
workspace_list in workspace_readscaffold.workspace.list()ReadQuery parameters
deletedbooleanList instead the deleted workspaces you own that can still be restored.
Returns
Your workspaces, each with your role.
Link to Invite a memberInvite a member
/v1/workspaces/{workspace_id}/invitesInvite an email to a workspace you own. Pass on the invite link secret it answers, shown only once.
workspace_member_invite in workspace_irreversiblescaffold.workspace.member_invite()WriteAgents ask firstPath parameters
workspace_idstringrequiredBody parameters
emailstringrequiredOnly the account with this email can accept.
Returns
The invite and its link secret, shown only once.
Errors
forbiddenYou are not an owner of the workspace.plan_requiredTeam members need the Paid plan.conflictThe email is already a member or has an open invite.secret_shownA retry under the same Idempotency-Key, whose secret was already shown.Link to Revoke an inviteRevoke an invite
/v1/invites/{invite_id}Revoke an open invite to a workspace you own, by its id from workspace.member_list.
workspace_invite_revoke in workspace_writescaffold.workspace.invite_revoke()WritePath parameters
invite_idstringrequiredReturns
The invite's id and when it was revoked.
Errors
forbiddenYou are not an owner of the workspace.not_foundNo invite you can see has that id.conflictThe invite was already accepted, revoked or expired.Link to Restore an inviteRestore an invite
/v1/invites/{invite_id}/restoreUndo a revoke before the invite expires.
workspace_invite_restore in workspace_writescaffold.workspace.invite_restore()WritePath parameters
invite_idstringrequiredReturns
The invite's id and when it now expires.
Errors
forbiddenYou are not an owner of the workspace.plan_requiredTeam members need the Paid plan.not_foundNo invite you can see has that id.conflictThe invite is not revoked, expired or was replaced.Link to Dismiss a declined inviteDismiss a declined invite
/v1/invites/{invite_id}/dismissHide a declined invite that workspace.member_list shows.
workspace_invite_dismiss in workspace_irreversiblescaffold.workspace.invite_dismiss()WriteAgents ask firstPath parameters
invite_idstringrequiredReturns
The invite's id and when it was dismissed.
Errors
forbiddenYou are not an owner of the workspace.not_foundNo invite you can see has that id.conflictThe invite was not declined, or is already dismissed.Link to Accept an inviteAccept an invite
/v1/invites/acceptJoin a workspace by an invite sent to your account's email.
workspace_invite_accept in workspace_writescaffold.workspace.invite_accept()WriteBody parameters
secretstringrequiredThe secret from the invite link.
Returns
The workspace you joined, with your role.
Errors
forbiddenThe invite is for another email, or you have not proven you read it.not_foundNo open invite has that secret.conflictYou are already a member.Link to Decline an inviteDecline an invite
/v1/invites/declineTurn down an invite sent to your account's email, by its secret.
workspace_invite_decline in workspace_irreversiblescaffold.workspace.invite_decline()WriteAgents ask firstBody parameters
secretstringrequiredThe secret from the invite link.
Returns
The invite's id and when you declined it.
Errors
forbiddenThe invite is for another email, or you have not proven you read it.not_foundNo open invite has that secret.Link to Retrieve an inviteRetrieve an invite
/v1/invites/previewShow an invite from its link secret, signed in or not, and whether it is still open.
workspace_invite_get in workspace_readscaffold.workspace.invite_get()ReadBody parameters
secretstringrequiredThe secret from the invite link.
Returns
The invite's workspace, sender, role and whether it is still open.
Errors
not_foundNo invite has that secret.Link to List membersList members
/v1/workspaces/{workspace_id}/membersList a workspace's members with roles, avatars and last activity, and its open invites.
workspace_member_list in workspace_readscaffold.workspace.member_list()ReadPath parameters
workspace_idstringrequiredReturns
The members with their roles, and the open, declined and expired invites.
Link to Transfer ownershipTransfer ownership
/v1/workspaces/{workspace_id}/transfer-ownershipMake 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.
workspace_ownership_transfer in workspace_irreversiblescaffold.workspace.ownership_transfer()WriteAgents ask firstPath parameters
workspace_idstringrequiredBody parameters
person_idstringrequiredA member who becomes the owner; you become a member.
Returns
The workspace's new and previous owner.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe person is not a member of the workspace.conflictThe person already owns it or is deleting their account.Link to Remove a memberRemove a member
/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.
workspace_member_remove in workspace_irreversiblescaffold.workspace.member_remove()WriteAgents ask firstPath parameters
person_idstringrequiredYour own id to leave the workspace.
workspace_idstringrequiredReturns
Who was removed, and when.
Errors
forbiddenYou remove someone else and are not an owner.not_foundThe person is not a member of the workspace.conflictIt would leave the workspace without an owner.Projects
Link to Create a projectCreate a project
/v1/projectsCreate 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.
project_create in project_writescaffold.project.create()WriteBody parameters
namestringrequiredworkspace_idstringrequiredignore_restorablebooleanCreate it even while a deleted one with this slug can be restored.
regionstringWhere it runs. eu-central when omitted.
One of eu-central
templatestringWhat the project starts from. empty when omitted.
One of node, python, static, booking, empty
Returns
The new project.
Errors
validation_failedThe name is blank, over 80 characters, has no letter or digit, or contains Scaffold.plan_requiredServer templates need the Paid plan, and a Free workspace holds 2 projects.conflictThe name is taken in the workspace.restorable_projectA deleted project still holds the name.Link to List projectsList projects
/v1/projectsList a workspace's projects, leaving out deleted ones.
project_list in project_readscaffold.project.list()ReadQuery parameters
workspace_idstringrequiredlimitinteger1 to 100, 20 when omitted.
starting_afterstringReturns
A page of the workspace's live projects with has_more and next_cursor.
Link to Retrieve a projectRetrieve a project
/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.
project_get in project_readscaffold.project.get()ReadPath parameters
project_idstringrequiredReturns
The project, what its app runs on, its newest deploy and any suspension.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo live project you can see has that id or slug.Link to Retrieve a project's metricsRetrieve a project's metrics
/v1/projects/{project_id}/metricsShow 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.
project_metrics_get in project_readscaffold.project.metrics_get()ReadPath parameters
project_idstringrequiredReturns
The app's users, signups and daily active users over the last 30 days, and this month's credits and agent runs of the runs started for the project, the seconds its apps ran and the bytes it stores, with what the plan includes.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Check a project addressCheck a project address
/v1/projects/address-checkShow the address a new project with this name would get and whether it is free. If not, project.create adds 4 random characters.
project_address_check in project_readscaffold.project.address_check()ReadQuery parameters
namestringrequiredThe project name you would create, as project.create takes it.
Returns
The address a project of that name would get, and whether it is free.
Errors
validation_failedThe name is blank, over 80 characters, contains Scaffold or cannot become an address.Link to Delete a projectDelete a project
/v1/projects/{project_id}Owner only: delete a project after a 24 hour grace period.
project_delete in project_writescaffold.project.delete()WritePath parameters
project_idstringrequiredReturns
The project's id and when it is erased.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.forbiddenYou are not an owner of the project's workspace.not_foundNo project you can see has that id or slug.Link to Restore a projectRestore a project
/v1/projects/{project_id}/restoreOwner only: restore a deleted project within 24 hours of deleting it, unless its Free workspace holds its 2 projects already.
project_restore in project_writescaffold.project.restore()WritePath parameters
project_idstringrequiredReturns
The restored project.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.forbiddenYou are not an owner of the project's workspace.not_foundNo deleted project you can see has that id or slug.plan_requiredA Free workspace holds 2 projects, and it has them.conflictA live project took the slug.Link to Erase a deleted projectErase a deleted project
/v1/projects/{project_id}/eraseOwner only: erase a deleted project now instead of when its 24 hours run out, with its deploys, env, domains and database.
project_erase in project_irreversiblescaffold.project.erase()WriteAgents ask firstPath parameters
project_idstringrequiredReturns
The project's id and when it was erased.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.forbiddenYou are not an owner of the project's workspace.not_foundNo deleted project you can see has that id or slug.Link to Retrieve a project's healthRetrieve a project's health
/v1/projects/{project_id}/healthShow a project's requests, errors, p95 latency, unavailable requests and downtime per hour over the last 24 hours, all its deploys together.
project_health_get in project_readscaffold.project.health_get()ReadPath parameters
project_idstringrequiredReturns
The last 24 hours, oldest first, with their totals, the latest outage and the requests of the day before. The tenant host counts in memory, so its counts start again when it restarts.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.upstreamThe project's tenant host did not answer. Try again.Link to Retrieve a project's statusRetrieve a project's status
/v1/projects/{project_id}/statusShow whether each deploy a project's host keeps is awake, asleep or exited, with its wakes, sleeps, OOM kills and CPU.
project_status_get in project_readscaffold.project.status_get()ReadPath parameters
project_idstringrequiredReturns
Whether Scaffold suspended the project, and its live, starting and previous deploys as its host sees them.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.upstreamThe project's tenant host did not answer. Try again.Link to Retrieve a project's limitsRetrieve a project's limits
/v1/projects/{project_id}/limitsShow the CPU, memory, disk, processes and sleep window a project's app runs under on its plan, and what its live deploy uses now.
project_limits_get in project_readscaffold.project.limits_get()ReadPath parameters
project_idstringrequiredReturns
The limits of the workspace's plan, and the live deploy's CPU, memory, processes and disk while it is awake.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.upstreamThe project's tenant host did not answer. Try again.Link to Retrieve a project's alertsRetrieve a project's alerts
/v1/projects/{project_id}/alertsShow the error share that alerts a project's owners, 1, 2 or 5%, and the alert firing now with its errors since it started.
project_alert_get in project_readscaffold.project.alert_get()ReadPath parameters
project_idstringrequiredReturns
The alert rule, the plan alerts need, and the alert firing now with the host's count of its window.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.upstreamAn alert fires and the project's tenant host did not answer.Link to Set a project's alertsSet a project's alerts
/v1/projects/{project_id}/alertsSet 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.
project_alert_set in project_writescaffold.project.alert_set()WritePath parameters
project_idstringrequiredBody parameters
error_percentintegerrequiredOne of 1, 2, 5
Returns
The project's alert rule.
Errors
validation_failederror_percent is not 1, 2 or 5.not_foundNo project you can see has that id or slug.forbiddenYou are not an owner of the workspace.plan_requiredAlerts need the Paid plan.Link to Set maintenance modeSet maintenance mode
/v1/projects/{project_id}/maintenanceTurn 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.
project_maintenance_set in project_writescaffold.project.maintenance_set()WritePath parameters
project_idstringrequiredBody parameters
onbooleanrequiredTrue shows visitors the maintenance page; false serves the app again.
Returns
Whether the project is in maintenance, and since when.
Errors
forbiddenYou are not an owner of the project's workspace.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.Link to Move a projectMove a project
/v1/projects/{project_id}/moveMove 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.
project_move in project_writescaffold.project.move()WritePath parameters
project_idstringrequiredBody parameters
workspace_idstringrequiredThe workspace to move it to. You own both.
Returns
The project, in its new workspace.
Errors
forbiddenYou do not own both workspaces.plan_requiredIt runs server code and the other is Free, or would take the other past Free's 2 projects or 1 custom domain.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictIt is in that workspace already, a live project there has its slug, or it takes payments or deploys from GitHub: run app_payments.disconnect or github.disconnect first.Link to Rotate app credentialsRotate app credentials
/v1/projects/{project_id}/credentials/rotateOwners 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.
project_credentials_rotate in project_irreversiblescaffold.project.credentials_rotate()WriteAgents ask firstPath parameters
project_idstringrequiredReturns
Which credentials changed, and the redeploy that started with them.
Errors
forbiddenYou are not an owner of the project's workspace.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.Link to Make a claim linkMake a claim link
/v1/projects/{project_id}/claim-linkMake 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.
project_claim_link_create in project_irreversiblescaffold.project.claim_link_create()WriteAgents ask firstPath parameters
project_idstringrequiredReturns
The link's secret, shown only once, and when it expires.
Errors
forbiddenYou are not an owner of the project's workspace.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.Link to Cancel a claim linkCancel a claim link
/v1/projects/{project_id}/claim-linkCancel a project's open claim link, so it no longer moves the project.
project_claim_link_cancel in project_irreversiblescaffold.project.claim_link_cancel()WriteAgents ask firstPath parameters
project_idstringrequiredReturns
The project and when its link was canceled.
Errors
forbiddenYou are not an owner of the project's workspace.project_suspendedScaffold suspended the project.not_foundThe project, or an open claim link of it, does not exist.Environment variables
Link to Set an env varSet an env var
/v1/projects/{project_id}/envSet 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.
env_set in project_writescaffold.env.set()WritePath parameters
project_idstringrequiredBody parameters
namestringrequiredLetters, digits and underscores, not starting with a digit, like STRIPE_KEY.
valuestringrequiredAt most 32 KiB.
deploybooleanFalse leaves the change for the next deploy. Left out, a live app is redeployed with it.
secretbooleanFalse shows the value in env.list; otherwise it stays a secret no command returns.
Returns
The var's name, when it was set, and the redeploy that started with it or that it waits for the next deploy.
Errors
validation_failedThe name or value breaks a rule, or the name is one Scaffold sets.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe project already holds the most env vars it may, or its env holds a name the runtime sets.Link to List env varsList env vars
/v1/projects/{project_id}/envList a project's env vars. Secrets show their name, never their value.
env_list in project_readscaffold.env.list()ReadPath parameters
project_idstringrequiredReturns
The project's env vars, secrets without their values.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Delete an env varDelete an env var
/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.
env_delete in project_irreversiblescaffold.env.delete()WriteAgents ask firstPath parameters
namestringrequiredproject_idstringrequiredQuery parameters
deploybooleanFalse leaves the change for the next deploy. Left out, a live app is redeployed with it.
Returns
The var's name, when it was deleted, and the redeploy that started without it or that it waits for the next deploy.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.project_suspendedScaffold suspended the project.not_foundThe project, or its env var of that name, does not exist.Link to Restore an env varRestore an env var
/v1/projects/{project_id}/env/{name}/restoreUndo 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.
env_restore in project_writescaffold.env.restore()WritePath parameters
namestringrequiredproject_idstringrequiredBody parameters
deploybooleanFalse leaves the change for the next deploy. Left out, a live app is redeployed with it.
Returns
The var's name, whether its value is secret, and the redeploy that started with it or that it waits for the next deploy.
Errors
validation_failedThe name is one Scaffold sets.project_suspendedScaffold suspended the project.not_foundThe project, or an env.set of the var to undo, does not exist.conflictThe value put back would take the project past its env limits.App source
Link to Upload app sourceUpload app source
/v1/projects/{project_id}/sourcesUpload 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.
source_upload in project_writescaffold.source.upload()WritePath parameters
project_idstringrequiredBody parameters
archivestringrequiredReturns
The upload with its SHA-256, which deploys name it by.
Errors
validation_failedThe archive is not a safe zip: over 50 MB, too many entries, too large unpacked, or a path or link that leaves its folder.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe same archive was deleted while it uploaded: upload it again.Link to Delete an uploadDelete an upload
/v1/projects/{project_id}/sources/{sha256}Delete a project's upload and its file. source.list gives each upload's sha256.
source_delete in project_irreversiblescaffold.source.delete()WriteAgents ask firstPath parameters
project_idstringrequiredsha256stringrequiredReturns
The upload's hash and when it was deleted.
Errors
project_suspendedScaffold suspended the project.not_foundThe project, or its upload with that hash, does not exist.conflictA deploy is building the upload: wait until it is live or failed.Link to List uploadsList uploads
/v1/projects/{project_id}/sourcesList a project's uploads of its code, newest first. An upload's sha256 is all deploy.create needs to build it.
source_list in project_readscaffold.source.list()ReadPath parameters
project_idstringrequiredReturns
The project's uploads, newest first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to List an upload's filesList an upload's files
/v1/projects/{project_id}/sources/{sha256}/filesList the files in one of a project's uploads, by path. source.list or a deploy's source_sha256 gives the hash.
source_file_list in project_readscaffold.source.file_list()ReadPath parameters
project_idstringrequiredsha256stringrequiredThe upload's SHA-256, as source.list or a deploy's source_sha256 gives it.
Returns
Each file's path, unpacked size and whether it is a link.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its upload with that hash, does not exist.Link to Read an upload's fileRead an upload's file
/v1/projects/{project_id}/sources/{sha256}/fileRead 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.
source_file_get in project_readscaffold.source.file_get()ReadPath parameters
project_idstringrequiredsha256stringrequiredThe upload's SHA-256, as source.list or a deploy's source_sha256 gives it.
Query parameters
pathstringrequiredThe file's path in the upload, as source.file_list gives it.
Returns
The file's text, or that it is binary, too large or a link.
Errors
validation_failedThe path is absolute or holds .., or the slug names projects in more than one of your workspaces.not_foundThe project, its upload with that hash, or the file does not exist.GitHub
Link to List GitHub repositoriesList GitHub repositories
/v1/workspaces/{workspace_id}/github/repositoriesList the GitHub repositories a workspace linked, which its members reach and gave Scaffold's GitHub App, for github.connect.
github_repository_list in project_readscaffold.github.repository_list()ReadPath parameters
workspace_idstringrequiredReturns
The repositories, each with its id and default branch.
Errors
forbiddenYou are not a member of the workspace.not_configuredThis Scaffold has no GitHub App set up.upstreamGitHub did not answer.Link to Connect a GitHub repositoryConnect a GitHub repository
/v1/projects/{project_id}/githubConnect a project to a GitHub repository, so each push to its branch deploys. Replaces the repository it followed.
github_connect in project_writescaffold.github.connect()WritePath parameters
project_idstringrequiredBody parameters
repository_idintegerrequiredThe id github.repository_list gives.
branchstringThe branch whose pushes deploy. Left out, the repository's default branch.
release_commandstringRun before each pushed deploy goes live, after a dump of the database, as deploy.create runs its release_command. Left out, none.
Returns
The project's repository, branch and latest pushes.
Errors
validation_failedThe branch is not a name git takes, the release command is blank or over 1,000 bytes, or the slug names projects in more than one of your workspaces.project_suspendedScaffold suspended the project.not_foundThe project, or the repository among the workspace's linked GitHub repositories, does not exist.not_configuredThis Scaffold has no GitHub App set up.upstreamGitHub did not answer.Link to Retrieve a project's GitHub sourceRetrieve a project's GitHub source
/v1/projects/{project_id}/githubShow a project's GitHub repository and branch, and its latest pushes with the deploy each started.
github_get in project_readscaffold.github.get()ReadPath parameters
project_idstringrequiredReturns
The repository and branch, or null, and the newest 10 pushes.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Change the deployed branchChange the deployed branch
/v1/projects/{project_id}/githubChange the branch whose pushes deploy a project connected to GitHub.
github_branch_set in project_writescaffold.github.branch_set()WritePath parameters
project_idstringrequiredBody parameters
branchstringrequiredReturns
The project's repository, branch and latest pushes.
Errors
validation_failedThe branch is not a name git takes.project_suspendedScaffold suspended the project.not_foundThe project, or its GitHub connection, does not exist.Link to Set the release commandSet the release command
/v1/projects/{project_id}/github/release_commandSet 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.
github_release_command_set in project_writescaffold.github.release_command_set()WritePath parameters
project_idstringrequiredBody parameters
release_commandstringRun with sh -c in each pushed deploy's sandbox, with its env and DATABASE_URL, before
it goes live, like npx prisma migrate deploy. The database is dumped first. At most
1,000 bytes. Left out or null, pushed deploys run none.
Returns
The project's repository, branch, release command and latest pushes.
Errors
validation_failedThe release command is blank or over 1,000 bytes.project_suspendedScaffold suspended the project.not_foundThe project, or its GitHub connection, does not exist.Link to Disconnect a GitHub repositoryDisconnect a GitHub repository
/v1/projects/{project_id}/githubStop deploying a project from GitHub. Its uploads and deploys stay.
github_disconnect in project_writescaffold.github.disconnect()WritePath parameters
project_idstringrequiredReturns
The project's source, with no repository, and its latest pushes.
Errors
project_suspendedScaffold suspended the project.not_foundThe project, or its GitHub connection, does not exist.Link to Deploy from GitHubDeploy from GitHub
/v1/projects/{project_id}/github/deployDeploy the head of a connected project's branch now, as a push would. github.get shows the deploy it starts.
github_deploy in project_writescaffold.github.deploy()WritePath parameters
project_idstringrequiredReturns
The push, queued. Poll github.get until it deployed or failed.
Errors
plan_requiredServer code needs the Paid plan.project_suspendedScaffold suspended the project.not_foundThe project, or its GitHub connection, does not exist.App databases
Link to Get the databaseGet the database
/v1/projects/{project_id}/databaseShow a project's Postgres database: its state, version, stored size, and DATABASE_URL with the password masked.
app_db_get in project_readscaffold.app_db.get()ReadPath parameters
project_idstringrequiredReturns
The database, or state none until the project's first deploy creates it.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.not_configuredThis Scaffold has no customer Postgres set up.Link to List backupsList backups
/v1/projects/{project_id}/database/backupsPaid 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.
app_db_backup_list in project_readscaffold.app_db.backup_list()ReadPath parameters
project_idstringrequiredReturns
The backups, newest first, the latest restore with its progress, and the latest dump while it downloads.
Errors
plan_requiredBackups need the Paid plan.not_foundNo project you can see has that id or slug.Link to Restore a backupRestore a backup
/v1/projects/{project_id}/database/backups/{backup_id}/restorePaid 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.
app_db_backup_restore in project_writescaffold.app_db.backup_restore()WritePath parameters
backup_idstringrequiredA backup app_db.backup_list shows, of this project.
project_idstringrequiredReturns
The restore, started. app_db.backup_list shows its progress.
Errors
plan_requiredBackups need the Paid plan.forbiddenYou are not an owner of the workspace.project_suspendedScaffold suspended the project.not_foundThe project has no kept backup with that id.conflictThe project has no database yet, or a restore of it is still running, by app_db.backup_restore or by deploy.rollback with restore_database.Cron jobs
Link to Create a cron jobCreate a cron job
/v1/projects/{project_id}/cron-jobsPaid 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.
cron_create in project_writescaffold.cron.create()WritePath parameters
project_idstringrequiredBody parameters
pathstringrequiredThe app path to POST to, starting with /.
schedulestringrequiredFive cron fields, like */15 * * * * or 0 9 * * MON-FRI; every minute at most.
timezonestringAn IANA timezone, like Europe/Berlin. Left out, UTC.
Returns
The new cron job with when it fires next.
Errors
validation_failedThe schedule is not five cron fields, the timezone is not an IANA one, or the path does not start with /.plan_requiredCron jobs call server code, which needs the Paid plan.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe project already has 20 cron jobs.Link to List cron jobsList cron jobs
/v1/projects/{project_id}/cron-jobsList a project's cron jobs with their next time and newest fires.
cron_list in project_readscaffold.cron.list()ReadPath parameters
project_idstringrequiredReturns
The project's cron jobs, oldest first, each with its 10 newest fires.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Update a cron jobUpdate a cron job
/v1/cron-jobs/{cron_job_id}Change a cron job's schedule, timezone or path, or pause and resume it.
cron_update in project_writescaffold.cron.update()WritePath parameters
cron_job_idstringrequiredBody parameters
enabledbooleanFalse pauses it, true resumes it from its next time.
pathstringschedulestringtimezonestringReturns
The cron job with when it fires next.
Errors
validation_failedThe schedule is not five cron fields, the timezone is not an IANA one, or the path does not start with /.plan_requiredCron jobs call server code, which needs the Paid plan.project_suspendedScaffold suspended the project.not_foundNo cron job you can see has that id.Link to Delete a cron jobDelete a cron job
/v1/cron-jobs/{cron_job_id}Delete a cron job and its fires. It answers the job as it was.
cron_delete in project_writescaffold.cron.delete()WritePath parameters
cron_job_idstringrequiredReturns
The deleted cron job as it was.
Errors
project_suspendedScaffold suspended the project.not_foundNo cron job you can see has that id.Test runs
Link to Start a test runStart a test run
/v1/projects/{project_id}/test-runsStart 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.
test_run_start in project_writescaffold.test_run.start()WritePath parameters
project_idstringrequiredBody parameters
commandstringrequiredWhat runs the tests, like pnpm test.
agentstringWho runs them, like Frontend agent.
filesobject[]The test files and how many tests each holds, when the runner knows before they run.
pull_requeststringWhat they test, like PR #214.
Returns
The run, running, with nothing reported yet.
Errors
validation_failedThe command is empty or a file is planned twice.cap_reachedThe workspace stored the test runs its plan holds today: 20 MB on Free, 200 MB on Paid.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.Link to Report test resultsReport test results
/v1/test-runs/{test_run_id}/resultsReport 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.
test_run_report in project_writescaffold.test_run.report()WritePath parameters
test_run_idstringrequiredBody parameters
resultsobject[]requiredTests that finished since the last report, at most 1,000.
donebooleanTrue ends the attempt: every test it runs has reported.
Returns
The run with its passed and failed counts now.
Errors
validation_failedA result has no file or name, or the run would pass 10,000 tests.conflictThe attempt has ended: start a rerun first.cap_reachedThe workspace stored the test runs its plan holds today: 20 MB on Free, 200 MB on Paid.project_suspendedScaffold suspended the project.not_foundNo test run you can see has that id.Link to Show a test fixShow a test fix
/v1/test-runs/{test_run_id}/fixShow 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.
test_run_fix in project_writescaffold.test_run.fix()WritePath parameters
test_run_idstringrequiredBody parameters
filestringrequiredThe test file whose failures it fixes.
editsobject[]The files it changed so far.
notestringWhat it is doing, like reading the failures.
Returns
The run as it stands.
Errors
validation_failedThe run has no such test file.conflictThe latest attempt still runs.project_suspendedScaffold suspended the project.not_foundNo test run you can see has that id.Link to Rerun testsRerun tests
/v1/test-runs/{test_run_id}/rerunsStart 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.
test_run_rerun in project_writescaffold.test_run.rerun()WritePath parameters
test_run_idstringrequiredBody parameters
commandstringrequiredWhat runs them again, like pnpm test hero.test.tsx.
filesstring[]The test files it runs again; left out, every file.
Returns
The run, running its new attempt.
Errors
validation_failedThe command is empty or the run has no such test file.conflictThe latest attempt still runs, or the run reran 19 times.project_suspendedScaffold suspended the project.not_foundNo test run you can see has that id.Link to List test runsList test runs
/v1/projects/{project_id}/test-runsList a project's 20 newest test runs with their state and counts.
test_run_list in project_readscaffold.test_run.list()ReadPath parameters
project_idstringrequiredReturns
The project's newest test runs first, without their results.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Get a test runGet a test run
/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.
test_run_get in project_readscaffold.test_run.get()ReadPath parameters
test_run_idstringrequiredReturns
The run with its files, tests, attempts and fix.
Errors
not_foundNo test run you can see has that id.Link to Delete a test runDelete a test run
/v1/test-runs/{test_run_id}Delete a test run and every result it holds.
test_run_delete in project_irreversiblescaffold.test_run.delete()WriteAgents ask firstPath parameters
test_run_idstringrequiredReturns
The run as it was.
Errors
project_suspendedScaffold suspended the project.not_foundNo test run you can see has that id.File storage
Link to List filesList files
/v1/projects/{project_id}/storageList the files a project's app stores, by name, or only those whose name starts with prefix, like avatars/.
storage_list in project_readscaffold.storage.list()ReadPath parameters
project_idstringrequiredQuery parameters
limitinteger1 to 100, 20 when omitted.
prefixstringOnly names starting with this, like avatars/.
starting_afterstringThe next_cursor of the page before.
Returns
A page of the project's files by name with has_more and next_cursor.
Errors
validation_failedThe limit is not 1 to 100, or the slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Get storage useGet storage use
/v1/workspaces/{workspace_id}/storageShow what the files of all a workspace's apps take together, and the cap its plan sets on them.
storage_usage_get in project_readscaffold.storage.usage_get()ReadPath parameters
workspace_idstringrequiredReturns
The bytes the workspace's files take as uploaded, its plan and the plan's cap: 1 GB on Free, 10 GB on Paid.
Link to Sign an upload URLSign an upload URL
/v1/projects/{project_id}/storage/upload-urlSign 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.
storage_upload_sign in project_writescaffold.storage.upload_sign()WritePath parameters
project_idstringrequiredBody parameters
namestringrequiredexpires_in_secondsintegerHow long the URL works, 60 seconds to 7 days. Defaults to 15 minutes.
Returns
The URL to PUT the file to, and when it expires.
Errors
validation_failedThe name holds .., another character outside letters, digits, ., _, - and /, or expires_in_seconds is not 60 to 604800.storage_fullThe workspace's files are at its plan's cap: 1 GB on Free, 10 GB on Paid.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe project stores a file of that name, or one it would be a folder of.Link to Sign a download URLSign a download URL
/v1/projects/{project_id}/storage/download-urlSign 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.
storage_download_sign in project_readscaffold.storage.download_sign()ReadPath parameters
project_idstringrequiredQuery parameters
namestringrequiredexpires_in_secondsintegerHow long the URL works, 60 seconds to 7 days. Defaults to 15 minutes.
Returns
The URL that answers the file, whole or one byte Range of it, and when it expires.
Errors
validation_failedThe name breaks a rule, or expires_in_seconds is not 60 to 604800.not_foundThe project, or its file of that name, does not exist.Link to Delete a fileDelete a file
/v1/projects/{project_id}/storageDelete a project's stored file by name, so signed URLs answer not found and its bytes no longer count toward the workspace's cap.
storage_delete in project_irreversiblescaffold.storage.delete()WriteAgents ask firstPath parameters
project_idstringrequiredQuery parameters
namestringrequiredReturns
The file's name, the bytes it freed and when it was deleted.
Errors
validation_failedThe name breaks a rule.project_suspendedScaffold suspended the project.not_foundThe project, or its file of that name, does not exist.Tokens
Link to Create a tokenCreate a token
/v1/tokensCreate a token for a workspace, or a test one for your sandbox. Its secret is shown once.
token_create in account_writescaffold.token.create()WriteBody parameters
accessstringrequiredOne of read, write
namestringrequiredworkspace_idstringrequiredexpires_atstringRFC 3339 expiry, none if omitted, no later than the calling token's.
modestringOne of live, test
Returns
The token and its secret, shown only once.
Errors
validation_failedThe name is blank or too long, or expires_at is past, outlives the calling token, or is over 30 days away for a test token.forbiddenAn OAuth app called, which cannot create personal tokens, or a test token asked for a live one.conflictYou already hold 100 tokens that still work, across your workspaces: revoke one first.secret_shownA retry under the same Idempotency-Key, whose secret was already shown.Link to List tokensList tokens
/v1/tokensList the tokens of a workspace, revoked ones included, without secrets.
token_list in account_readscaffold.token.list()ReadQuery parameters
workspace_idstringrequiredReturns
The workspace's tokens, revoked ones included, without secrets.
Link to Revoke a tokenRevoke a token
/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.
token_revoke in account_irreversiblescaffold.token.revoke()WriteAgents ask firstPath parameters
token_idstringrequiredReturns
The token's id and when it was revoked.
Errors
forbiddenThe token is another member's and you are not an owner.not_foundNo token you can see has that id.conflictThe token is already revoked.OAuth apps
Link to List OAuth appsList OAuth apps
/v1/oauth/grantsList the OAuth apps you approved, and as an owner every app in your workspaces.
oauth_grant_list in account_readscaffold.oauth.grant_list()ReadReturns
The OAuth apps you approved, and as an owner every app in your workspaces.
Link to Revoke an OAuth appRevoke an OAuth app
/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.
oauth_grant_revoke in account_irreversiblescaffold.oauth.grant_revoke()WriteAgents ask firstPath parameters
grant_idstringrequiredReturns
The grant's id and when it was revoked.
Errors
not_foundNo grant you can see has that id.conflictThe grant is already revoked.Credits
Link to Retrieve the credit balanceRetrieve the credit balance
/v1/workspaces/{workspace_id}/creditsShow a workspace's credits: balance, held, available and the monthly cap.
credit_balance_get in billing_readscaffold.credit.balance_get()ReadPath parameters
workspace_idstringrequiredReturns
The balance, held and available credits, the allowance and the monthly cap.
Link to List credit entriesList credit entries
/v1/workspaces/{workspace_id}/credits/ledgerList a workspace's latest 200 credit entries, newest first.
credit_ledger_list in billing_readscaffold.credit.ledger_list()ReadPath parameters
workspace_idstringrequiredReturns
The latest 200 credit entries, newest first.
Link to Set the monthly capSet the monthly cap
/v1/workspaces/{workspace_id}/credits/capSet or remove a workspace's monthly spending cap. Owners only.
credit_cap_set in billing_writescaffold.credit.cap_set()WritePath parameters
workspace_idstringrequiredBody parameters
monthly_capintegerMillicredits the workspace may spend per calendar month (UTC). None removes the cap.
Returns
The balance with the new monthly cap.
Errors
validation_failedmonthly_cap is negative.forbiddenYou are not an owner of the workspace.plan_requiredA monthly cap needs the Paid plan.Link to List credit packsList credit packs
/v1/credits/packsList the credit packs a top-up can buy, with their prices.
credit_pack_list in billing_readscaffold.credit.pack_list()ReadReturns
Each pack's Stripe price, credits and price, smallest first.
Errors
upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Start a top-upStart a top-up
/v1/workspaces/{workspace_id}/credits/top-upsBuy the credit pack of a Stripe price with the card the plan is paid with. Owners only.
credit_top_up_start in billing_irreversiblescaffold.credit.top_up_start()WriteAgents ask firstPath parameters
workspace_idstringrequiredBody parameters
express_startbooleanrequiredMust be true: the owner ticked a box asking for the credits at once, so withdrawing refunds only the unused ones.
price_idstringrequiredThe Stripe Price of a top-up pack.
Returns
The top-up, added, failed with the reason, or waiting for the bank page to confirm it on, and the balance.
Errors
validation_failedThe price is not a top-up pack, or express_start is false.forbiddenYou are not an owner of the workspace.plan_requiredTop-ups need the Paid plan.conflictThe plan is not paid with a card.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Retrieve a top-upRetrieve a top-up
/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}Show whether a top-up was added, failed or still waits for the bank.
credit_top_up_get in billing_readscaffold.credit.top_up_get()ReadPath parameters
top_up_idstringrequiredworkspace_idstringrequiredReturns
The top-up's credits, status and any failure reason.
Errors
not_foundThe workspace has no such top-up.Link to Ask for a top-upAsk for a top-up
/v1/workspaces/{workspace_id}/credits/top-up-requestsAsk the workspace's owners to top up, in their inbox. Members only, once a day.
credit_top_up_request in billing_irreversiblescaffold.credit.top_up_request()WriteAgents ask firstPath parameters
workspace_idstringrequiredReturns
The owners asked, by name.
Errors
conflictYou are an owner, so you top up yourself.Link to Withdraw from a top-upWithdraw from a top-up
/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}/withdrawWithdraw from a top-up within 14 days and refund its unused credits, once any dispute ends. Owners only.
credit_top_up_withdraw in billing_irreversiblescaffold.credit.top_up_withdraw()WriteAgents ask firstPath parameters
top_up_idstringrequiredThe top-up's, as billing.get lists it.
workspace_idstringrequiredReturns
The credits the refund keeps, the refund and the new balance.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe workspace has no such top-up.conflictThe top-up is unpaid, withdrawn already, taken back by a refund or dispute, or past its 14 days, or its credits are all used or held by running work.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Billing
Link to Retrieve billingRetrieve billing
/v1/workspaces/{workspace_id}/billingShow 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.
billing_get in billing_readscaffold.billing.get()ReadPath parameters
workspace_idstringrequiredReturns
The workspace's plan, card, renewal and any unpaid payment page.
Errors
upstreamStripe failed while the plan can still be withdrawn from. Try again.Link to Retrieve plan pricesRetrieve plan prices
/v1/billing/pricesShow 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.
billing_prices_get in billing_readscaffold.billing.prices_get()ReadReturns
The Paid plan's yearly and monthly prices, the credits each grants a month, and what withdrawing charges per credit.
Errors
upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Subscribe to the Paid planSubscribe to the Paid plan
/v1/workspaces/{workspace_id}/billing/subscribeOpen a Stripe payment page for the paid plan, yearly or monthly, which grants nothing before Stripe confirms. Owners only, on the free plan.
billing_subscribe_start in billing_writescaffold.billing.subscribe_start()WritePath parameters
workspace_idstringrequiredBody parameters
express_startbooleanrequiredMust be true: the owner ticked a box asking for the plan at once, so withdrawing refunds less the credits used.
intervalstringrequiredOne of yearly, monthly
device_idstringA random id the browser keeps, to stop repeat withdrawals.
Returns
The Stripe payment page to pay at.
Errors
validation_failedexpress_start is not true.forbiddenYou are not an owner of the workspace.conflictThe workspace already has a paid plan or a subscription that may still start.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Abandon a payment pageAbandon a payment page
/v1/workspaces/{workspace_id}/billing/subscribe/cancelGive up on the plan's unpaid Stripe payment page, so it can no longer be paid. Owners only.
billing_subscribe_cancel in billing_irreversiblescaffold.billing.subscribe_cancel()WriteAgents ask firstPath parameters
workspace_idstringrequiredReturns
The workspace's billing.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe workspace has no payment page for the plan.conflictThe payment page was already paid.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Cancel the Paid planCancel the Paid plan
/v1/workspaces/{workspace_id}/billing/cancelEnd the Paid plan when its paid period ends. Owners only.
billing_cancel in billing_writescaffold.billing.cancel()WritePath parameters
workspace_idstringrequiredReturns
The workspace's billing, ending with its paid period.
Errors
forbiddenYou are not an owner of the workspace.conflictThe workspace is on the Free plan.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Keep the Paid planKeep the Paid plan
/v1/workspaces/{workspace_id}/billing/resumeKeep a cancelled Paid plan, so it renews again. Owners only, before its period ends.
billing_resume in billing_writescaffold.billing.resume()WritePath parameters
workspace_idstringrequiredReturns
The workspace's billing, renewing again.
Errors
forbiddenYou are not an owner of the workspace.conflictThe workspace is on the Free plan.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Open the billing portalOpen the billing portal
/v1/workspaces/{workspace_id}/billing/portalOpen Stripe's billing portal to change or cancel the plan. Owners only, once the workspace subscribed.
billing_portal_open in billing_irreversiblescaffold.billing.portal_open()WriteAgents ask firstPath parameters
workspace_idstringrequiredReturns
The Stripe billing portal's address.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe workspace never subscribed.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Withdraw from the Paid planWithdraw from the Paid plan
/v1/workspaces/{workspace_id}/billing/withdrawWithdraw 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.
billing_withdraw in billing_irreversiblescaffold.billing.withdraw()WriteAgents ask firstPath parameters
workspace_idstringrequiredReturns
The refunds, and whether one waits for a dispute.
Errors
forbiddenYou are not an owner of the workspace.not_foundThe workspace has no subscription.conflictThe 14 days to withdraw have passed, a lost dispute returned the money, or it was withdrawn already.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Changes
Link to List changesList changes
/v1/workspaces/{workspace_id}/changesList what changed in a workspace, newest first, 100 at a time. Pass the last position you saw as after to catch up oldest first.
change_list in workspace_readscaffold.change.list()ReadPath parameters
workspace_idstringrequiredQuery parameters
actor_idstringafterintegerOnly newer changes, oldest first.
agent_idstringOnly the changes this agent's runs made.
areastringOne of tasks, pages, projects, agents, settings
beforeintegerOnly older changes, newest first.
client_idstringrun_idstringOnly the changes this agent run made, and the settlements of what it made.
viastringOne of console, personal_token, oauth_app, app_user, agent, no_credential, cli
Returns
The workspace's changes, newest first or after a position.
Errors
validation_failedBoth before and after are sent.not_foundThe agent to filter by does not exist.Link to Retrieve a command's changesRetrieve a command's changes
/v1/commands/{command_id}/changesList the record versions one command made, before and after.
change_command_get in workspace_readscaffold.change.command_get()ReadPath parameters
command_idstringrequiredReturns
Who ran the command, how, and each record before and after.
Errors
not_foundNo command you can see changed records with that id.Link to Export changesExport changes
/v1/workspaces/{workspace_id}/changes/exportExport a workspace's changes as CSV. Owners only.
change_export in workspace_readscaffold.change.export()ReadPath parameters
workspace_idstringrequiredQuery parameters
actor_idstringagent_idstringOnly the changes this agent's runs made.
areastringOne of tasks, pages, projects, agents, settings
client_idstringdaysintegerThe last 1 to 90 days. 30 when omitted.
viastringOne of console, personal_token, oauth_app, app_user, agent, no_credential, cli
Returns
The changes as a CSV file, with row counts.
Errors
validation_faileddays is outside the kept history.forbiddenYou are not an owner of the workspace, or an agent run asked.not_foundThe agent to filter by does not exist.Trash
Link to List the trashList the trash
/v1/workspaces/{workspace_id}/trashList what was deleted in a workspace and can still be restored.
trash_list in workspace_readscaffold.trash.list()ReadPath parameters
workspace_idstringrequiredQuery parameters
beforeintegerOnly what was deleted before this position.
Returns
What was deleted in the workspace and can still be restored.
Databases
Link to Create a databaseCreate a database
/v1/workspaces/{workspace_id}/databasesCreate a database, which keeps a Title field; add each field asked for with field.create.
database_create in database_writescaffold.database.create()WritePath parameters
workspace_idstringrequiredBody parameters
namestringrequiredtemplatestringOne of empty, tasks, bugs
Returns
The new database with its Title field.
Errors
validation_failedThe name is blank or over 80 characters.Link to List databasesList databases
/v1/workspaces/{workspace_id}/databasesList a workspace's databases with their fields and option ids.
database_list in database_readscaffold.database.list()ReadPath parameters
workspace_idstringrequiredQuery parameters
include_archivedbooleanList archived databases too.
Returns
The workspace's databases with their fields and options.
Link to Rename a databaseRename a database
/v1/databases/{database_id}/renameRename a database.
database_rename in database_writescaffold.database.rename()WritePath parameters
database_idstringrequiredBody parameters
namestringrequiredReturns
The renamed database.
Errors
validation_failedThe name is blank or over 80 characters.not_foundNo database you can see has that id.conflictThe database is archived.Link to Archive a databaseArchive a database
/v1/databases/{database_id}/archiveArchive a database, hiding it from database.list unless include_archived. It is erased after 30 days, and relation fields lose their links to it.
database_archive in database_writescaffold.database.archive()WriteAgents ask firstPath parameters
database_idstringrequiredReturns
The archived database.
Errors
not_foundNo database you can see has that id.conflictThe database is already archived.Link to Restore a databaseRestore a database
/v1/databases/{database_id}/restoreRestore an archived database.
database_restore in database_writescaffold.database.restore()WritePath parameters
database_idstringrequiredReturns
The restored database.
Errors
not_foundNo database you can see has that id.conflictThe database is not archived.Fields
Link to Create a fieldCreate a field
/v1/databases/{database_id}/fieldsAdd a typed field to a database; its kind cannot change later. A select or multi_select takes options, a relation its relation_database_id.
field_create in database_writescaffold.field.create()WritePath parameters
database_idstringrequiredBody parameters
kindstringrequiredOne of text, number, select, multi_select, person, date, relation, checkbox
namestringrequiredoptionsstring[]A select's choices, in order.
relation_database_idstringA relation's database, which may be this one.
Returns
The new field.
Errors
validation_failedThe name, options or relation_database_id do not fit the field's kind.not_foundThe database, or the one to link to, does not exist.conflictThe database is archived.Link to Rename a fieldRename a field
/v1/fields/{field_id}/renameRename a field. Record values stay keyed by its id.
field_rename in database_writescaffold.field.rename()WritePath parameters
field_idstringrequiredBody parameters
namestringrequiredReturns
The renamed field.
Errors
validation_failedThe name is blank or over 80 characters.not_foundNo field you can see has that id.conflictThe field or its database is archived.Link to Set a field's optionsSet a field's options
/v1/fields/{field_id}/optionsSet 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.
field_options_set in database_writescaffold.field.options_set()WritePath parameters
field_idstringrequiredBody parameters
optionsobject[]requiredEvery option it keeps, in order.
Returns
The field with its new options.
Errors
validation_failedThe field is not a select, or an option is unknown, listed twice or badly named.not_foundNo field you can see has that id.conflictThe field or its database is archived, or a record holds an option left out.Link to Set a relationSet a relation
/v1/fields/{field_id}/relationSet the database a relation field links to, refused while records link through it, and two_way: whether that database shows its links back.
field_relation_set in database_writescaffold.field.relation_set()WritePath parameters
field_idstringrequiredBody parameters
relation_database_idstringrequiredMay be its own.
two_waybooleanrequiredReturns
The relation field with its new link.
Errors
validation_failedThe field is not a relation field.not_foundThe field, or the database to link to, does not exist.conflictThe field or a database is archived, records link through it, or it is still filling links.Link to Archive a fieldArchive a field
/v1/fields/{field_id}/archiveArchive a field, hiding its values. Search stops finding a text field's values within moments.
field_archive in database_writescaffold.field.archive()WriteAgents ask firstPath parameters
field_idstringrequiredReturns
The archived field.
Errors
not_foundNo field you can see has that id.conflictThe field is already archived or is its database's title, or the database is archived.Link to Restore a fieldRestore a field
/v1/fields/{field_id}/restoreRestore an archived field and show its values again. Search finds a text field's values again within moments.
field_restore in database_writescaffold.field.restore()WritePath parameters
field_idstringrequiredReturns
The restored field.
Errors
not_foundNo field you can see has that id.conflictThe field is not archived, or its database is.Records
Link to Create a recordCreate a record
/v1/databases/{database_id}/recordsAdd a record to a database, with values keyed by field id.
record_create in record_writescaffold.record.create()WritePath parameters
database_idstringrequiredBody parameters
valuesobjectValues keyed by field id, as each field's kind describes.
Returns
The new record.
Errors
validation_failedA value does not fit its field, or links a record outside the database its field links to.not_foundNo database you can see has that id.conflictThe database is archived.Link to Query recordsQuery records
/v1/databases/{database_id}/queryFilter, sort and page a database's records.
record_query in record_readscaffold.record.query()ReadPath parameters
database_idstringrequiredBody parameters
archivedbooleanList archived records instead of live ones.
filterobject[]Up to 20 conditions every listed record meets.
limitintegerAt most 100, 20 when omitted.
sortobjectThe manual order when omitted, which also breaks ties, reversed when descending.
starting_afterstringtodaystringYour date as YYYY-MM-DD, UTC's when omitted.
Returns
A page of matching records with has_more and next_cursor.
Errors
validation_failedA filter or sort does not fit its field, or limit is out of range.not_foundThe database, or the record to continue after, does not exist.Link to Retrieve a recordRetrieve a record
/v1/records/{record_id}Show a record with its version, live field values and subtasks.
record_get in record_readscaffold.record.get()ReadPath parameters
record_idstringrequiredReturns
The record with its version, values and subtasks.
Errors
validation_failedThe record key is in more than one of your workspaces: send the id.not_foundNo record you can see has that id or key.Link to Update a recordUpdate a record
/v1/records/{record_id}Change a record's values at the version you read.
record_update in record_writescaffold.record.update()WritePath parameters
record_idstringrequiredBody parameters
expected_versionintegerrequiredThe version you read.
valuesobjectrequiredThe fields to change, keyed by field id. null empties a field; others stay as they are.
Returns
The record at its new version.
Errors
validation_failedA value does not fit its field, or values names no field.not_foundNo record you can see has that id.conflictThe record or its database is archived.stale_versionThe record changed since the version you read.Link to Set subtasksSet subtasks
/v1/records/{record_id}/subtasksReplace a record's subtasks with this checklist.
record_subtasks_set in record_writescaffold.record.subtasks_set()WritePath parameters
record_idstringrequiredBody parameters
subtasksobject[]requiredIn order, up to 100.
Returns
The record with its new subtasks.
Errors
validation_failedThere are too many subtasks, or one is blank or too long.not_foundNo record you can see has that id.conflictThe record is archived.Link to Archive a recordArchive a record
/v1/records/{record_id}/archiveArchive a record at the version you read.
record_archive in record_writescaffold.record.archive()WriteAgents ask firstPath parameters
record_idstringrequiredBody parameters
expected_versionintegerrequiredThe version you read.
Returns
The archived record.
Errors
not_foundNo record you can see has that id.conflictThe record is already archived, or its database is.stale_versionThe record changed since the version you read.Link to Restore a recordRestore a record
/v1/records/{record_id}/restoreRestore an archived record at the version you read.
record_restore in record_writescaffold.record.restore()WritePath parameters
record_idstringrequiredBody parameters
expected_versionintegerrequiredThe version you read.
Returns
The restored record.
Errors
not_foundNo record you can see has that id.conflictThe record is not archived, or its database is.stale_versionThe record changed since the version you read.Link to Update recordsUpdate records
/v1/databases/{database_id}/records/bulk-updateChange records of one database in one command, each update shaped like record.update's input.
record_bulk_update in record_writescaffold.record.bulk_update()WritePath parameters
database_idstringrequiredBody parameters
updatesobject[]required1 to 200 records of the database, each once; one refused writes none.
Returns
The command's id and the records at their new versions.
Errors
validation_failedThe list is empty, too long or names a record twice, or a value does not fit its field.not_foundThe database does not exist, or a record is not in it.conflictA record or the database is archived.Link to Create recordsCreate records
/v1/databases/{database_id}/records/bulk-createAdd records to one database in one command.
record_bulk_create in record_writescaffold.record.bulk_create()WritePath parameters
database_idstringrequiredBody parameters
recordsobject[]required1 to 200 records, each its values keyed by field id.
Returns
The command's id and the new records.
Errors
validation_failedThe list is empty or too long, or a value does not fit its field.not_foundNo database you can see has that id.conflictThe database is archived.Link to Archive recordsArchive records
/v1/databases/{database_id}/records/bulk-archiveArchive records of one database in one command.
record_bulk_archive in record_writescaffold.record.bulk_archive()WriteAgents ask firstPath parameters
database_idstringrequiredBody parameters
recordsobject[]required1 to 200 records of the database, each once.
Returns
The command's id and the archived records.
Errors
validation_failedThe list is empty, too long or names a record twice.not_foundThe database does not exist, or a record is not in it.conflictA record is already archived, or the database is.Link to Restore recordsRestore records
/v1/databases/{database_id}/records/bulk-restoreRestore archived records of one database in one command.
record_bulk_restore in record_writescaffold.record.bulk_restore()WritePath parameters
database_idstringrequiredBody parameters
recordsobject[]required1 to 200 records of the database, each once.
Returns
The command's id and the restored records.
Errors
validation_failedThe list is empty, too long or names a record twice.not_foundThe database does not exist, or a record is not in it.conflictA record is not archived, or the database is.Link to List a record's versionsList a record's versions
/v1/records/{record_id}/historyList 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.
record_history in record_readscaffold.record.history()ReadPath parameters
record_idstringrequiredQuery parameters
before_versionintegerOnly versions older than this one. Omit it for the newest 100.
Returns
The record's versions, newest first, each with what changed.
Errors
not_foundNo record you can see has that id.Link to Undo a commandUndo a command
/v1/record-commands/{command_id}/undoUndo 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.
record_undo in record_writescaffold.record.undo()WritePath parameters
command_idstringrequiredThe command_id of a record change, as the change feed, record or history shows it.
Returns
The undo's id and the records it changed back.
Errors
validation_failedThe command changed no records this way: undo it with the command it names.not_foundNo command you can see changed records with that id.conflictA record changed since, or an option or link it would bring back is gone.Cards
Link to Move a cardMove a card
/v1/records/{record_id}/moveMove 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.
card_move in record_writescaffold.card.move()WritePath parameters
record_idstringrequiredBody parameters
expected_versionintegerrequiredThe version you read.
afterstringPlace it right after this record, like the card above.
beforestringOr right before this one, like the card below.
valuesobjectFields to change too, like a board's column field.
Returns
The moved record at its new version.
Errors
validation_failedBoth after and before are sent, the record moves next to itself, or a value does not fit.not_foundThe record, or the one to move next to, does not exist.conflictThe record or its database is archived.stale_versionThe record changed since the version you read.Link to List your assigned recordsList your assigned records
/v1/workspaces/{workspace_id}/records/assignedList a workspace's open or done records that name you in a person field, across its databases.
card_assigned_list in record_readscaffold.card.assigned_list()ReadPath parameters
workspace_idstringrequiredQuery parameters
donebooleanThe done records instead.
limitintegerAt most 100, 20 when omitted.
sortstringOmit it for the sort you last saved.
One of due, database
starting_afterstringReturns
A page of records that name you, with next_cursor and the sort.
Errors
validation_failedlimit or a date is out of range.not_foundThe record to continue after does not exist.Tasks
Link to List tasksList tasks
/v1/tasksList a workspace's tasks, newest first.
task_list in task_readscaffold.task.list()ReadQuery parameters
workspace_idstringrequiredassigneestringlabelstringlimitinteger1 to 100, 20 when omitted.
starting_afterstringstatusstringOne of todo, doing, review, done
Returns
A page of tasks with has_more and next_cursor.
Errors
validation_failedlimit is out of range.Link to Create a taskCreate a task
/v1/tasksAdd a task. New labels stay after its undo.
task_create in task_writescaffold.task.create()WriteBody parameters
titlestringrequiredworkspace_idstringrequiredassigneestringdatabase_idstringduestringYYYY-MM-DD.
labelsstring[]statusstringOne of todo, doing, review, done
Returns
The new task.
Errors
validation_failedThe title is blank or too long, or the database holds records, not tasks.not_foundThe database does not exist, or the workspace has no Tasks database.conflictThe database, or one of its task fields, is archived.Link to Update a taskUpdate a task
/v1/tasks/{task_id}Change a task's title, assignee or due date; null clears one.
task_update in task_writescaffold.task.update()WritePath parameters
task_idstringrequiredBody parameters
assigneestringduestringexpected_versionintegertitlestringReturns
The updated task.
Errors
validation_failedThe title is blank or too long.not_foundNo task you can see has that id.conflictThe task, its database or one of its task fields is archived.stale_versionThe task changed since the expected_version you sent.Link to Move a taskMove a task
/v1/tasks/{task_id}/moveMove a task to a column, at a position in it.
task_move in task_writescaffold.task.move()WritePath parameters
task_idstringrequiredBody parameters
columnstringrequiredOne of todo, doing, review, done
positionintegerReturns
The task in its new column.
Errors
not_foundNo task you can see has that id.conflictThe task, its database or one of its task fields is archived.Views
Link to Create a viewCreate a view
/v1/databases/{database_id}/viewsSave a view of a database. A board needs group_by, a timeline its dates, a sprint view its sprint source.
view_create in view_writescaffold.view.create()WritePath parameters
database_idstringrequiredBody parameters
namestringrequiredsettingsobjectrequiredReturns
The new view.
Errors
validation_failedThe name is blank or too long, or a setting does not fit the view's kind or fields.not_foundNo database you can see has that id.conflictThe database is archived.Link to List viewsList views
/v1/databases/{database_id}/viewsList a database's views with their settings, oldest first.
view_list in view_readscaffold.view.list()ReadPath parameters
database_idstringrequiredQuery parameters
include_archivedbooleanList archived views too.
Returns
The database's views with their settings.
Errors
not_foundNo database you can see has that id.Link to Update a viewUpdate a view
/v1/views/{view_id}Replace a view's settings; its name stays.
view_update in view_writescaffold.view.update()WritePath parameters
view_idstringrequiredBody parameters
settingsobjectrequiredReplaces every setting; the name stays.
Returns
The view with its new settings.
Errors
validation_failedA setting does not fit the view's kind or fields.not_foundNo view you can see has that id.conflictThe view is archived.Link to Rename a viewRename a view
/v1/views/{view_id}/renameRename a view.
view_rename in view_writescaffold.view.rename()WritePath parameters
view_idstringrequiredBody parameters
namestringrequiredReturns
The renamed view.
Errors
validation_failedThe name is blank or over 80 characters.not_foundNo view you can see has that id.conflictThe view is archived.Link to Archive a viewArchive a view
/v1/views/{view_id}/archiveArchive a view, hiding it from view.list unless include_archived.
view_archive in view_writescaffold.view.archive()WriteAgents ask firstPath parameters
view_idstringrequiredReturns
The archived view.
Errors
not_foundNo view you can see has that id.conflictThe view is already archived.Link to Restore a viewRestore a view
/v1/views/{view_id}/restoreRestore an archived view.
view_restore in view_writescaffold.view.restore()WritePath parameters
view_idstringrequiredReturns
The restored view.
Errors
not_foundNo view you can see has that id.conflictThe view is not archived.Link to List a view's recordsList a view's records
/v1/views/{view_id}/recordsPage 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.
view_record_list in view_readscaffold.view.record_list()ReadPath parameters
view_idstringrequiredQuery parameters
fromstringA timeline's window as YYYY-MM-DD, both days included. A timeline needs both.
groupstringOne group: an id the view's group_by field holds. Omit it for every group.
limitintegerAt most 100, 20 when omitted.
starting_afterstringtostringtodaystringYour date as YYYY-MM-DD, UTC's when omitted.
ungroupedbooleanThe column of records whose group_by field is empty instead.
Returns
A page of the view's records, with next_cursor and any sprint.
Errors
validation_failedgroup, ungrouped, from or to do not fit the view, or limit is out of range.not_foundThe view, or the record to continue after, does not exist.Pages
Link to Create a pageCreate a page
/v1/workspaces/{workspace_id}/pagesCreate a page in a workspace, or a record's body with record_id.
page_create in page_writescaffold.page.create()WritePath parameters
workspace_idstringrequiredBody parameters
record_idstringMakes the page this record's body instead, with no title of its own.
titlestringA standalone page's title.
Returns
The new page.
Errors
validation_failedNeither a title nor a record_id is sent, or the title is too long.not_foundNo record you can see has that record_id.conflictThe record or its database is archived, or the record already has a body.Link to List pagesList pages
/v1/workspaces/{workspace_id}/pagesList a workspace's pages, oldest first, without blocks.
page_list in page_readscaffold.page.list()ReadPath parameters
workspace_idstringrequiredQuery parameters
archivedbooleanList archived pages instead of live ones.
record_idstringOnly the body of this record.
Returns
The workspace's pages, without their blocks.
Link to Retrieve a pageRetrieve a page
/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.
page_get in page_readscaffold.page.get()ReadPath parameters
page_idstringrequiredQuery parameters
formatstringOne of markdown, blocks
state_vectorstringAn editor's Yjs state vector (v1, base64): answers the update it lacks instead.
Returns
The page with its content in the format you asked for.
Errors
validation_failedstate_vector is not a Yjs state vector.not_foundNo page you can see has that id.conflictThe page holds what Markdown cannot show: read it with format blocks.Link to Rename a pageRename a page
/v1/pages/{page_id}/renameSet a standalone page's title. A record's body has no title, since the record names it.
page_rename in page_writescaffold.page.rename()WritePath parameters
page_idstringrequiredBody parameters
titlestringrequiredReturns
The renamed page.
Errors
validation_failedThe title is too long, or the page is a record's body.not_foundNo page you can see has that id.conflictThe page is archived.Link to Archive a pageArchive a page
/v1/pages/{page_id}/archiveArchive 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.
page_archive in page_writescaffold.page.archive()WriteAgents ask firstPath parameters
page_idstringrequiredReturns
The archived page.
Errors
validation_failedThe page is a record's body: archive the record.not_foundNo page you can see has that id.conflictThe page is already archived.Link to Restore a pageRestore a page
/v1/pages/{page_id}/restoreRestore an archived page with the content it had.
page_restore in page_writescaffold.page.restore()WritePath parameters
page_idstringrequiredReturns
The restored page.
Errors
validation_failedThe page is a record's body: restore the record.not_foundNo page you can see has that id.conflictThe page is not archived.Link to Edit a pageEdit a page
/v1/pages/{page_id}/editChange 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.
page_edit in page_writescaffold.page.edit()WritePath parameters
page_idstringrequiredBody parameters
opsobject[]requiredconfirmstringThe confirm of a preview: applies the edit while the blocks it touches are unchanged.
previewbooleanAnswer what the edit would change, and change nothing.
Returns
The page's new revision and how to undo it, or a preview to confirm.
Errors
validation_failedThe ops are too many or too large, or a block or mention does not fit.not_foundThe page, or a block it targets, does not exist.conflictThe page or the record it is the body of is archived, or a new block's id is taken.Link to Append to a pageAppend to a page
/v1/pages/{page_id}/blocksAdd 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.
page_append in page_writescaffold.page.append()WritePath parameters
page_idstringrequiredBody parameters
markdownstringrequiredafterstringA block id. The end of the page when omitted.
Returns
The page's new revision and how to undo it.
Errors
validation_failedThe Markdown holds no text, too many blocks or what a page cannot hold.not_foundThe page, or the block to add after, does not exist.conflictThe page or the record it is the body of is archived.Link to Propose a page rewritePropose a page rewrite
/v1/pages/{page_id}/proposalsPropose 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.
page_propose in page_writescaffold.page.propose()WritePath parameters
page_idstringrequiredBody parameters
opsobject[]requiredOps as page.edit takes them.
Returns
The open proposal and the blocks it would change.
Errors
validation_failedThe ops are too many or too large, or a block or mention does not fit.not_foundThe page, or a block it targets, does not exist.conflictThe page or the record it is the body of is archived, a new block's id is taken, or the page has 20 open proposals.Link to Retrieve a page proposalRetrieve a page proposal
/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.
page_proposal_get in page_readscaffold.page.proposal_get()ReadPath parameters
page_idstringrequiredproposal_idstringrequiredReturns
The proposal, with the page before and after it while it is open.
Errors
not_foundNo page you can see has that id, or no such proposal.Link to List page proposalsList page proposals
/v1/pages/{page_id}/proposalsList the proposed rewrites of a page that wait for a person, oldest first.
page_proposal_list in page_readscaffold.page.proposal_list()ReadPath parameters
page_idstringrequiredReturns
The page's open proposals.
Errors
not_foundNo page you can see has that id.Link to Discard a page proposalDiscard a page proposal
/v1/pages/{page_id}/proposals/{proposal_id}/discardDiscard 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.
page_proposal_discard in page_writescaffold.page.proposal_discard()WritePath parameters
page_idstringrequiredproposal_idstringrequiredReturns
The discarded proposal.
Errors
not_foundNo page you can see has that id, or no such proposal.conflictThe proposal was accepted or discarded already.Models
Link to List modelsList models
/v1/modelsList the models runs may use, their token prices now in millicredits per million, and the price version.
model_list in run_readscaffold.model.list()ReadReturns
The models with their token prices and the price version.
Commands
Link to Describe a commandDescribe a command
/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.
command_describe in command_readscaffold.command.describe()ReadPath parameters
namestringrequiredA command as MCP names it, like task_create, or with a dot for the underscore.
Returns
The command's MCP tool and action, its description and its input schema.
Errors
not_foundNo command you may run has that name.App users
Link to List app usersList app users
/v1/projects/{project_id}/auth/usersList 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.
app_auth_user_list in project_readscaffold.app_auth.user_list()ReadPath parameters
project_idstringrequiredQuery parameters
limitinteger1 to 100, 20 when omitted.
searchstringOnly users whose name or email contains it.
starting_afterstringstatusstringReturns
A page of the app's users with has_more and next_cursor.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Show an app userShow an app user
/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.
app_auth_user_show in project_readscaffold.app_auth.user_show()ReadPath parameters
project_idstringrequireduser_idstringrequiredReturns
The user with their status, lock end and sign-in methods.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.Link to Unlock an app userUnlock an app user
/v1/projects/{project_id}/auth/users/{user_id}/unlockOwners only: end the 15-minute lock five wrong passwords put on an app user's email.
app_auth_user_unlock in project_irreversiblescaffold.app_auth.user_unlock()WriteAgents ask firstPath parameters
project_idstringrequireduser_idstringrequiredReturns
The unlocked user's id and when.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.forbiddenYou are not an owner of the workspace.conflictThe user is not locked.Link to Email an app userEmail an app user
/v1/projects/{project_id}/auth/users/{user_id}/emailEmail 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.
app_auth_user_email_send in project_irreversiblescaffold.app_auth.user_email_send()WriteAgents ask firstPath parameters
project_idstringrequireduser_idstringrequiredBody parameters
emailstringrequiredOne of recovery, confirmation
Returns
When the email was queued.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.conflictThey confirmed already, or this email went to them under a minute ago.cap_reachedThe address had its auth emails for the hour, or the workspace's apps their counted emails for the month.project_suspendedScaffold suspended the project.Link to List an app user's sessionsList an app user's sessions
/v1/projects/{project_id}/auth/users/{user_id}/sessionsList an app user's live sessions with the device and place each signed in from.
app_auth_user_session_list in project_readscaffold.app_auth.user_session_list()ReadPath parameters
project_idstringrequireduser_idstringrequiredReturns
The user's live sessions, most recently active first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.Link to Revoke an app user's sessionRevoke an app user's session
/v1/projects/{project_id}/auth/users/{user_id}/sessions/{session_id}End one of an app user's sessions.
app_auth_user_session_revoke in project_irreversiblescaffold.app_auth.user_session_revoke()WriteAgents ask firstPath parameters
project_idstringrequiredsession_idstringrequireduser_idstringrequiredReturns
The ended session's id and when it ended.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, its user or that user's live session does not exist.Link to Sign an app user out everywhereSign an app user out everywhere
/v1/projects/{project_id}/auth/users/{user_id}/sign-outEnd every session of an app user.
app_auth_user_sign_out_everywhere in project_irreversiblescaffold.app_auth.user_sign_out_everywhere()WriteAgents ask firstPath parameters
project_idstringrequireduser_idstringrequiredReturns
The user's id, the sessions that ended and when.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.Link to List app sign-in eventsList app sign-in events
/v1/projects/{project_id}/auth/sign-insList 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.
app_auth_sign_in_event_list in project_readscaffold.app_auth.sign_in_event_list()ReadPath parameters
project_idstringrequiredQuery parameters
beforestringThe id of the oldest event already seen. Omit it to start from the newest.
emailstringOnly users whose email contains it.
onlystringOne of failed, sign_ups, password_resets
user_idstringReturns
A page of sign-in events, newest first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Delete an app userDelete an app user
/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.
app_auth_user_delete in project_irreversiblescaffold.app_auth.user_delete()WriteAgents ask firstPath parameters
project_idstringrequireduser_idstringrequiredReturns
The deleted user's id and when they were erased.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundThe project, or its user with that id, does not exist.forbiddenYou are not an owner of the workspace.Link to Retrieve app auth settingsRetrieve app auth settings
/v1/projects/{project_id}/auth/settingsShow where a project's auth emails may link to.
app_auth_settings_get in project_readscaffold.app_auth.settings_get()ReadPath parameters
project_idstringrequiredReturns
Where the project's auth emails may link to.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Update app auth settingsUpdate app auth settings
/v1/projects/{project_id}/auth/settingsReplace the site URL a project's auth emails link to and the other URLs they may.
app_auth_settings_update in project_writescaffold.app_auth.settings_update()WritePath parameters
project_idstringrequiredBody parameters
redirect_urlsstring[]At most 20, each like site_url. Replaces the whole list.
site_urlstringAn https URL, or http on localhost. Omit it to send codes without links.
Returns
The project's new auth email settings.
Errors
validation_failedA URL is not valid or too long, or there are too many.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.Link to Retrieve an app's email usageRetrieve an app's email usage
/v1/projects/{project_id}/auth/email-usageShow 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.
app_auth_email_usage_get in project_readscaffold.app_auth.email_usage_get()ReadPath parameters
project_idstringrequiredReturns
The project's and its workspace's counted emails this month, the plan's quota, the hourly email.send limit and when the month resets.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to List suppressed addressesList suppressed addresses
/v1/projects/{project_id}/auth/email-suppressionsList the addresses a project's app no longer emails, after a bounce, a spam complaint or by hand.
app_auth_email_suppression_list in project_readscaffold.app_auth.email_suppression_list()ReadPath parameters
project_idstringrequiredReturns
The addresses the project's app no longer emails, newest first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Suppress an addressSuppress an address
/v1/projects/{project_id}/auth/email-suppressionsStop a project's app emailing an address: auth emails and email.send skip it.
app_auth_email_suppression_add in project_writescaffold.app_auth.email_suppression_add()WritePath parameters
project_idstringrequiredBody parameters
emailstringrequiredReturns
The suppressed address and when it was added.
Errors
validation_failedThe email is not an address, or the slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.conflictThe address is already suppressed.Link to Unsuppress an addressUnsuppress an address
/v1/projects/{project_id}/auth/email-suppressions/removeLet a project's app email a suppressed address again.
app_auth_email_suppression_remove in project_writescaffold.app_auth.email_suppression_remove()WritePath parameters
project_idstringrequiredBody parameters
emailstringrequiredReturns
The address and when the project's emails started reaching it again.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug, or the address is not suppressed.Link to Retrieve an app's email senderRetrieve an app's email sender
/v1/projects/{project_id}/auth/senderShow who a project's emails come from: its name beside the address every app sends from.
app_auth_sender_get in project_readscaffold.app_auth.sender_get()ReadPath parameters
project_idstringrequiredReturns
The name inboxes show and the address the project's emails come from.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Send an emailSend an email
/v1/projects/{project_id}/emailEmail 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.
email_send in project_irreversiblescaffold.email.send()WriteAgents ask firstPath parameters
project_idstringrequiredBody parameters
bodystringrequiredPlain text, at most 20,000 characters. A blank line starts a new paragraph.
subjectstringrequiredOne line, at most 200 characters.
tostringrequiredreply_tostringWhere a reply goes, like the app's support address. Left out, replies go to the address every app sends from, which nobody reads.
Returns
The queued message's id and when it was queued.
Errors
validation_failedAn address, the subject or the body is not valid, or the slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.project_suspendedScaffold suspended the project.conflictThe address is suppressed after a bounce or complaint.cap_reachedThe workspace used this month's email quota, or the project sent 100 within the hour.App payments
Link to Connect Stripe to an appConnect Stripe to an app
/v1/projects/{project_id}/payments/connectLink a project's app to a Stripe account its customer owns and answer its setup page. Rerun for a new page.
app_payments_connect_start in project_writescaffold.app_payments.connect_start()WritePath parameters
project_idstringrequiredBody parameters
countrystringTwo-letter country like us, for the first connect.
Returns
The linked Stripe account and its setup page, which works once.
Errors
validation_failedA first connect has no two-letter country, or the slug names projects in more than one of your workspaces.forbiddenYou are not an owner of the workspace.plan_requiredApp payments need the Paid plan.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe project already takes payments through another Stripe account.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Retrieve an app's Stripe accountRetrieve an app's Stripe account
/v1/projects/{project_id}/payments/accountShow if a project's Stripe account can charge and pay out, and what Stripe needs.
app_payments_account_get in project_readscaffold.app_payments.account_get()ReadPath parameters
project_idstringrequiredReturns
Whether the project's Stripe account can charge and pay out, and what Stripe still needs.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Retrieve an app's revenueRetrieve an app's revenue
/v1/projects/{project_id}/payments/revenueShow what a project's Stripe account took over 30 days, per currency.
app_payments_revenue_get in project_readscaffold.app_payments.revenue_get()ReadPath parameters
project_idstringrequiredReturns
The Stripe account's payments and refunds, less failed refunds, of the last 30 days per currency, or no account when Stripe is not connected. Disputes are not counted. A read counts the newest 1,000 balance changes and sets truncated when there were more.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.plan_requiredRevenue needs the Paid plan.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Link to Disconnect Stripe from an appDisconnect Stripe from an app
/v1/projects/{project_id}/payments/accountUnlink a project's app from its Stripe account; the customer keeps it.
app_payments_disconnect in project_writescaffold.app_payments.disconnect()WritePath parameters
project_idstringrequiredReturns
The unlinked Stripe account's id and when it was unlinked.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.forbiddenYou are not an owner of the workspace.not_foundNo project you can see has that id or slug, or it has no Stripe account linked.Link to Open the Stripe DashboardOpen the Stripe Dashboard
/v1/projects/{project_id}/payments/dashboardLink to the Stripe Dashboard of a project's Stripe account.
app_payments_dashboard_link in project_readscaffold.app_payments.dashboard_link()ReadPath parameters
project_idstringrequiredReturns
The linked account's id and where its owner signs in to Stripe.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug, or it has no Stripe account linked.Link to List Stripe deliveriesList Stripe deliveries
/v1/projects/{project_id}/payments/deliveriesList the Stripe events forwarded to a project's app, with each try.
app_payments_webhook_delivery_list in project_readscaffold.app_payments.webhook_delivery_list()ReadPath parameters
project_idstringrequiredReturns
The newest 100 deliveries of 30 days, each with its tries, what the app answered and the next try.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Resend a Stripe eventResend a Stripe event
/v1/projects/{project_id}/payments/deliveries/{event_id}/resendForward a Stripe event to a project's app again now.
app_payments_webhook_delivery_resend in project_irreversiblescaffold.app_payments.webhook_delivery_resend()WriteAgents ask firstPath parameters
event_idstringrequiredStripe's id of the event, like evt_1Q8L.
project_idstringrequiredReturns
The delivery with this try added.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug, or no delivery of that event from its linked Stripe account.upstreamStripe failed. Try again.not_configuredThis Scaffold has no Stripe set up.Realtime
Link to Publish a realtime messagePublish a realtime message
/v1/projects/{project_id}/realtime/channels/{channel}/messagesSend 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.
realtime_publish in project_irreversiblescaffold.realtime.publish()WriteAgents ask firstPath parameters
channelstringrequiredUp to 100 letters, digits and _-.:, like orders:42.
project_idstringrequiredBody parameters
dataanyrequiredAny JSON, at most 32 KiB, which subscribers get as the message's data.
Returns
The channel and how many subscriptions the message was sent to.
Errors
validation_failedThe channel name or data is too long or holds other characters, or the slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.project_suspendedScaffold suspended the project.Link to List realtime channelsList realtime channels
/v1/projects/{project_id}/realtime/channelsList the realtime channels of a project's app that its users subscribe to now, with each one's subscriptions and the project's cap.
realtime_channel_list in project_readscaffold.realtime.channel_list()ReadPath parameters
project_idstringrequiredReturns
The open subscriptions by channel, their total and the project's cap.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Agent runs
Link to Start an agent runStart an agent run
/v1/runsStart 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.
run_create in run_writescaffold.run.create()WriteSpends creditsBody parameters
agentstringrequiredWho does the work.
One of planner, qa, triage
promptstringrequiredWhat to do, at most 20000 characters.
workspace_idstringrequiredask_before_changesbooleanAsk a person before each change.
contextstring[]Pages, tasks, records, databases, projects or deploys to read first, at most 10.
modelstringLeft out, the agent's default. Advanced and Max need the Paid plan.
One of standard, advanced, max
project_idstringThe project of the workspace the run is for, whose costs count its credits.
Returns
The run, with its estimate and the credits held.
Errors
validation_failedThe prompt is blank or too long, or context names too many or the wrong things.credits_exhaustedThe workspace lacks the credits the run would hold.cap_reachedThe hold would pass the workspace's monthly cap, the agent's monthly limit or Scaffold's daily limit.plan_requiredAdvanced and Max need the Paid plan.not_foundSomething in context does not exist.conflictThe agent is paused.Link to Price an agent runPrice an agent run
/v1/runs/quotePrice a run: its estimate, what run.create would hold, the credits available and which cap, limit or shortfall would refuse it.
run_quote in run_readscaffold.run.quote()ReadBody parameters
agentstringrequiredWho does the work.
One of planner, qa, triage
promptstringrequiredWhat to do, at most 20000 characters.
workspace_idstringrequiredask_before_changesbooleanAsk a person before each change.
contextstring[]Pages, tasks, records, databases, projects or deploys to read first, at most 10.
modelstringLeft out, the agent's default. Advanced and Max need the Paid plan.
One of standard, advanced, max
project_idstringThe project of the workspace the run is for, whose costs count its credits.
Returns
The estimate, what run.create would hold, the credits available and what would refuse the hold.
Errors
validation_failedThe prompt is blank or too long, or context names too many or the wrong things.plan_requiredAdvanced and Max need the Paid plan.not_foundSomething in context does not exist.conflictThe agent is paused.Link to List agent runsList agent runs
/v1/runsList agent runs, newest first.
run_list in run_readscaffold.run.list()ReadQuery parameters
workspace_idstringrequiredagentstringOnly the runs of this agent.
One of planner, qa, triage
contextstringOnly the runs started for this.
limitinteger1 to 100, 20 when omitted.
starting_afterstringReturns
A page of runs, newest first, with has_more and next_cursor.
Link to Retrieve a runRetrieve a run
/v1/runs/{run_id}Read an agent run: status, steps with what each spent, credits, approvals and edits an undo keeps.
run_get in run_readscaffold.run.get()ReadPath parameters
run_idstringrequiredReturns
The run with its steps, credits, approvals and the edits an undo keeps. What each call said and read shows only to its starter and owners.
Errors
not_foundNo run you can see has that id.Link to Stop a runStop a run
/v1/runs/{run_id}/stopStop a running or waiting run. Its edits stay until run.undo.
run_stop in run_writescaffold.run.stop()WritePath parameters
run_idstringrequiredReturns
The stopped run.
Errors
forbiddenYou neither started the run nor own its workspace.not_foundNo run you can see has that id.conflictThe run already ended.Link to List approvalsList approvals
/v1/workspaces/{workspace_id}/approvalsList the changes waiting for your approval: your runs', and every member's for a workspace owner.
run_approval_list in run_readscaffold.run.approval_list()ReadPath parameters
workspace_idstringrequiredReturns
The changes runs wait to have approved, oldest first, each with who started its run.
Link to Deny a changeDeny a change
/v1/runs/{run_id}/denyDeny the change a run waits on and stop the run.
run_deny in run_writescaffold.run.deny()WriteSpends creditsPath parameters
run_idstringrequiredBody parameters
approvalintegerrequiredreasonstringAt most 1000 characters.
Returns
The stopped run.
Errors
validation_failedThe reason is too long.forbiddenYou neither started the run nor own its workspace.not_foundNo run you can see has that id.conflictThe run waits on no such approval.Link to Resume a runResume a run
/v1/runs/{run_id}/resumeResume a run stopped by a person, a limit or its credits.
run_resume in run_writescaffold.run.resume()WriteSpends creditsPath parameters
run_idstringrequiredBody parameters
legintegerrequiredReturns
The run, going on.
Errors
forbiddenYou did not start the run.not_foundNo run you can see has that id.conflictThe run is not stopped by a person, a limit or its credits, went on since, was undone, its agent is paused or its starter left.Link to Follow up on a runFollow up on a run
/v1/runs/{run_id}/follow-upAsk a done or denied run more; its agent goes on in the same run.
run_follow_up in run_writescaffold.run.follow_up()WriteSpends creditsPath parameters
run_idstringrequiredBody parameters
legintegerrequiredpromptstringrequiredAt most 20000 characters.
Returns
The run, going on.
Errors
validation_failedThe follow-up is blank or too long.forbiddenYou did not start the run.not_foundNo run you can see has that id.conflictThe run is not done or denied, went on since, was undone, its agent is paused or its starter left.Link to Undo a runUndo a run
/v1/runs/{run_id}/undoTake back every edit of an ended run as one change. Refused while run.get lists later edits, unless keep_changed.
run_undo in run_irreversiblescaffold.run.undo()WriteAgents ask firstPath parameters
run_idstringrequiredBody parameters
legintegerrequiredkeep_changedbooleanLeave things edited since the run as they are.
Returns
The run, undone.
Errors
not_foundNo run you can see has that id.conflictThe run is still going or already undone, or later edits would be overwritten.Agents
Link to List agentsList agents
/v1/workspaces/{workspace_id}/agentsList 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.
agent_list in run_readscaffold.agent.list()ReadPath parameters
workspace_idstringrequiredReturns
The workspace's agents with their settings.
Link to Retrieve an agentRetrieve an agent
/v1/agents/{agent_id}Read an agent: what it does, may do and asks before doing, and its settings.
agent_get in run_readscaffold.agent.get()ReadPath parameters
agent_idstringrequiredReturns
The agent with what it does, may do and asks before doing.
Errors
not_foundNo agent you can see has that id.Link to Update an agentUpdate an agent
/v1/agents/{agent_id}Owners only: change what an agent asks before doing, its default model or its monthly limit in millicredits.
agent_update in run_writescaffold.agent.update()WritePath parameters
agent_idstringrequiredBody parameters
asks_beforestringOne of big_changes, every_change
default_modelstringAdvanced and Max need the Paid plan.
One of standard, advanced, max
monthly_limitintegerMillicredits a month; null removes the limit. Left out, it stays.
Returns
The agent with its new settings.
Errors
validation_failedmonthly_limit is negative.forbiddenYou are not an owner of the workspace.plan_requiredAdvanced and Max need the Paid plan.not_foundNo agent you can see has that id.Link to Pause an agentPause an agent
/v1/agents/{agent_id}/pauseOwners only: pause an agent. It starts no runs and skips its schedules; runs going now finish.
agent_pause in run_writescaffold.agent.pause()WritePath parameters
agent_idstringrequiredReturns
The paused agent.
Errors
forbiddenYou are not an owner of the workspace.not_foundNo agent you can see has that id.Link to Resume an agentResume an agent
/v1/agents/{agent_id}/resumeOwners only: resume a paused agent. A stopped run resumes by run.resume.
agent_resume in run_writescaffold.agent.resume()WritePath parameters
agent_idstringrequiredReturns
The resumed agent.
Errors
forbiddenYou are not an owner of the workspace.not_foundNo agent you can see has that id.Schedules
Link to List schedulesList schedules
/v1/workspaces/{workspace_id}/schedulesList a workspace's schedules, oldest first, with when each runs next.
schedule_list in run_readscaffold.schedule.list()ReadPath parameters
workspace_idstringrequiredReturns
The workspace's schedules with when each runs next.
Link to Create a scheduleCreate a schedule
/v1/workspaces/{workspace_id}/schedulesPaid plan: run an agent on a repeating time, as you. A run it cannot start, as while the agent is paused, is skipped.
schedule_create in run_writescaffold.schedule.create()WritePath parameters
workspace_idstringrequiredBody parameters
agentstringrequiredOne of planner, qa, triage
promptstringrequiredWhat each run does, at most 20000 characters.
repeatsobjectrequiredmodelstringLeft out, the agent's default model when the schedule is made.
One of standard, advanced, max
Returns
The new schedule with when it runs next.
Errors
validation_failedThe prompt is blank or too long, or the time or timezone is not valid.plan_requiredSchedules need the Paid plan.conflictThe workspace already has 50 schedules.Link to Update a scheduleUpdate a schedule
/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.
schedule_update in run_writescaffold.schedule.update()WritePath parameters
schedule_idstringrequiredBody parameters
agentstringOne of planner, qa, triage
enabledbooleanFalse pauses it, true resumes it.
modelstringOne of standard, advanced, max
promptstringrepeatsobjectReturns
The schedule with when it runs next.
Errors
validation_failedThe prompt is blank or too long, or the time or timezone is not valid.forbiddenYou neither made the schedule nor own the workspace, or you change the prompt or agent of a schedule someone else made.plan_requiredSchedules need the Paid plan.not_foundNo schedule you can see has that id.conflictThe schedule is deleted.Link to Delete a scheduleDelete a schedule
/v1/schedules/{schedule_id}Delete a schedule. Only its maker and owners may.
schedule_delete in run_writescaffold.schedule.delete()WritePath parameters
schedule_idstringrequiredReturns
The deleted schedule.
Errors
forbiddenYou neither made the schedule nor own the workspace.not_foundNo schedule you can see has that id.conflictThe schedule is already deleted.Link to Restore a scheduleRestore a schedule
/v1/schedules/{schedule_id}/restoreBring back a deleted schedule.
schedule_restore in run_writescaffold.schedule.restore()WritePath parameters
schedule_idstringrequiredReturns
The restored schedule with when it runs next.
Errors
forbiddenYou neither made the schedule nor own the workspace.plan_requiredSchedules need the Paid plan.not_foundNo schedule you can see has that id.conflictThe schedule is not deleted, or the workspace already has 50 schedules.Link to Run a schedule nowRun a schedule now
/v1/schedules/{schedule_id}/runStart a run of a schedule now, as you, without moving its next run.
schedule_run_now in run_writescaffold.schedule.run_now()WriteSpends creditsPath parameters
schedule_idstringrequiredReturns
The run it started.
Errors
credits_exhaustedThe workspace lacks the credits the run would hold.cap_reachedThe hold would pass the workspace's monthly cap, the agent's monthly limit or Scaffold's daily limit.plan_requiredSchedules, or the schedule's model, need the Paid plan.not_foundNo schedule you can see has that id.conflictThe schedule is deleted or lost its prompt, or its agent is paused.Onboarding
Link to Retrieve the setup checklistRetrieve the setup checklist
/v1/workspaces/{workspace_id}/onboardingShow your setup checklist in a workspace and what ticked each step.
onboarding_get in account_readscaffold.onboarding.get()ReadPath parameters
workspace_idstringrequiredReturns
Your setup checklist in the workspace.
Link to Skip a setup stepSkip a setup step
/v1/workspaces/{workspace_id}/onboarding/{step}/skipPut off a setup step that is not done. It still ticks if it happens.
onboarding_step_skip in account_writescaffold.onboarding.step_skip()WritePath parameters
stepstringrequiredOne of connect, first_command, first_deploy
workspace_idstringrequiredReturns
The checklist with the step skipped.
Errors
conflictThe step is already done.Link to Bring back a setup stepBring back a setup step
/v1/workspaces/{workspace_id}/onboarding/{step}/resumeBring back a skipped setup step.
onboarding_step_resume in account_writescaffold.onboarding.step_resume()WritePath parameters
stepstringrequiredOne of connect, first_command, first_deploy
workspace_idstringrequiredReturns
The checklist with the step back.
Notifications
Link to List notificationsList notifications
/v1/workspaces/{workspace_id}/notificationsList your notifications in a workspace, newest first, by unread or source.
notification_list in workspace_readscaffold.notification.list()ReadPath parameters
workspace_idstringrequiredQuery parameters
limitinteger1 to 100, 20 when omitted.
sourcestringOne of approvals, deploys, mentions_and_assignments, credits
starting_afterstringunreadbooleanReturns
A page of your notifications with has_more and next_cursor.
Errors
validation_failedlimit is out of range.not_foundThe notification to continue after does not exist.Link to Mark notifications readMark notifications read
/v1/workspaces/{workspace_id}/notifications/readMark your notifications read, answering those it changed.
notification_read in workspace_writescaffold.notification.read()WritePath parameters
workspace_idstringrequiredBody parameters
notification_idsstring[]required1 to 1000.
Returns
The ids of the notifications it changed.
Errors
validation_failednotification_ids is empty or too long.not_foundA notification is not yours.Link to Mark notifications unreadMark notifications unread
/v1/workspaces/{workspace_id}/notifications/unreadMark your notifications unread, answering those it changed.
notification_unread in workspace_writescaffold.notification.unread()WritePath parameters
workspace_idstringrequiredBody parameters
notification_idsstring[]required1 to 1000.
Returns
The ids of the notifications it changed.
Errors
validation_failednotification_ids is empty or too long.not_foundA notification is not yours.Link to Mark all notifications readMark all notifications read
/v1/workspaces/{workspace_id}/notifications/read-allMark up to 1000 unread notifications read, newest first, answering them.
notification_read_all in workspace_writescaffold.notification.read_all()WritePath parameters
workspace_idstringrequiredReturns
The ids of the notifications it changed.
Link to Count unread notificationsCount unread notifications
/v1/workspaces/{workspace_id}/notifications/unread-countCount your unread notifications, in all and per source.
notification_unread_count in workspace_readscaffold.notification.unread_count()ReadPath parameters
workspace_idstringrequiredReturns
Your unread count, in all and per source.
Link to Retrieve notification preferencesRetrieve notification preferences
/v1/workspaces/{workspace_id}/notifications/preferencesShow how each source reaches you: in app, and by email at 18:00 UTC.
notification_preferences_get in workspace_readscaffold.notification.preferences_get()ReadPath parameters
workspace_idstringrequiredReturns
How each source reaches you.
Link to Set notification preferencesSet notification preferences
/v1/workspaces/{workspace_id}/notifications/preferencesSet whether a source reaches you in app and by email.
notification_preferences_set in workspace_writescaffold.notification.preferences_set()WritePath parameters
workspace_idstringrequiredBody parameters
emailbooleanrequiredOnly with in_app.
in_appbooleanrequiredsourcestringrequiredOne of approvals, deploys, mentions_and_assignments, credits
Returns
How each source reaches you now.
Errors
validation_failedEmail is on for a source whose in-app notifications are off.Search
Link to Search a workspaceSearch a workspace
/v1/workspaces/{workspace_id}/searchFind tasks, records, pages and runs by words or a record key, with counts per kind.
search_query in workspace_readscaffold.search.query()ReadPath parameters
workspace_idstringrequiredQuery parameters
querystringrequiredWords of 3 or more characters, or a record key, up to 200 characters in all.
bystringOnly what this member or agent changed last, or ran.
kindstringOne of task, record, page, run
limitinteger1 to 100, 50 when omitted.
Returns
The hits, with counts per kind.
Errors
validation_failedlimit is out of range, or by names no member or agent of the workspace.Comments
Link to Create a commentCreate a comment
/v1/records/{record_id}/commentsComment on a record.
comment_create in record_writescaffold.comment.create()WritePath parameters
record_idstringrequiredBody parameters
bodystringrequiredUp to 10000 characters. <@usr_...> mentions and notifies a member.
Returns
The new comment.
Errors
validation_failedThe body is blank or too long, or mentions too many or someone outside the workspace.not_foundNo record you can see has that id.conflictThe record is archived.Link to List commentsList comments
/v1/records/{record_id}/commentsList a record's comments, oldest first.
comment_list in record_readscaffold.comment.list()ReadPath parameters
record_idstringrequiredQuery parameters
limitinteger1 to 100, 20 when omitted.
starting_afterstringReturns
A page of the record's comments with has_more and next_cursor.
Errors
validation_failedlimit is out of range.not_foundThe record, or the comment to continue after, does not exist.Link to Delete a commentDelete a comment
/v1/comments/{comment_id}Delete your comment.
comment_delete in record_writescaffold.comment.delete()WritePath parameters
comment_idstringrequiredReturns
The deleted comment.
Errors
forbiddenThe comment is another member's.not_foundNo comment you can see has that id.conflictThe comment is already deleted.Link to Restore a commentRestore a comment
/v1/comments/{comment_id}/restoreBring back your deleted comment.
comment_restore in record_writescaffold.comment.restore()WritePath parameters
comment_idstringrequiredReturns
The restored comment.
Errors
forbiddenThe comment is another member's.not_foundNo comment you can see has that id.conflictThe comment is not deleted.Status
Link to Retrieve the statusRetrieve the status
/v1/statusShow Scaffold's status overall and per component, open incidents, planned maintenance and console notices. Needs no sign-in.
status_get in project_readscaffold.status.get()ReadReturns
How Scaffold is doing overall and per component, with open incidents and notices.
Link to Retrieve the versionRetrieve the version
/v1/versionShow which build of Scaffold answers: its git commit and when it was built. Needs no sign-in.
status_version_get in project_readscaffold.status.version_get()ReadReturns
The commit the running build was made from and when, both null on a build the release pipeline did not make.
Link to List incidentsList incidents
/v1/status/incidentsList incidents and maintenance open in the last 90 days, newest first, with updates. Needs no sign-in.
status_incident_list in project_readscaffold.status.incident_list()ReadQuery parameters
daysinteger1 to 90 days, 90 when omitted, listing every incident open in them and all upcoming maintenance.
Returns
The incidents and maintenance of the days asked for, newest first.
Errors
validation_faileddays is out of range.Link to Retrieve an incidentRetrieve an incident
/v1/status/incidents/{incident_id}Show one incident or maintenance window with every update and any write-up. Needs no sign-in.
status_incident_get in project_readscaffold.status.incident_get()ReadPath parameters
incident_idstringrequiredReturns
The incident or maintenance with every update and any write-up.
Errors
not_foundNo incident has that id.Deploys
Link to Create a deployCreate a deploy
/v1/projects/{project_id}/deploysBuild 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.
deploy_create in project_writescaffold.deploy.create()WriteAgents ask firstPath parameters
project_idstringrequiredBody parameters
release_commandstringRun with sh -c in the deploy's sandbox, with its env and DATABASE_URL, before it goes
live, like npx prisma migrate deploy. The project's database is dumped first, as before
every first start, and the dump kept 6 days. If it fails, the deploy fails and the live one keeps serving. At most
1,000 bytes; it may run for 10 minutes.
sha256stringThe upload to build, as source.list gives its sha256. Left out, the newest upload.
Returns
The deploy, queued. Poll deploy.get until it is live or failed; its build log holds the build's output.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id. Or the release command is blank, holds a NUL or passes 1,000 bytes.project_suspendedScaffold suspended the project.plan_requiredA Free workspace made 15 deploys in 24 hours or built for 120 minutes this month.cap_reachedA Paid workspace built for 1,000 minutes this month.not_foundThe project, or the upload with that hash, does not exist.conflictThe project has no address yet, or its env holds a name the runtime sets or more than a deploy takes.upstreamThis Scaffold has no tenant runtime set up to run deploys.Link to List deploysList deploys
/v1/projects/{project_id}/deploysList a project's deploys, newest first.
deploy_list in project_readscaffold.deploy.list()ReadPath parameters
project_idstringrequiredReturns
The project's deploys, newest first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to List each project's newest deployList each project's newest deploy
/v1/workspaces/{workspace_id}/deploysList the newest deploy of each project in a workspace, newest first, with its status, so one read shows where every project stands.
deploy_recent_list in project_readscaffold.deploy.recent_list()ReadPath parameters
workspace_idstringrequiredReturns
One deploy per project that has any, newest first.
Errors
forbiddenYou are not a member of the workspace.Link to Retrieve a deployRetrieve a deploy
/v1/deploys/{deploy_id}Show a deploy and its status: queued, building, starting, live, superseded, rolled_back or failed with its reason.
deploy_get in project_readscaffold.deploy.get()ReadPath parameters
deploy_idstringrequiredReturns
The deploy.
Errors
not_foundNo deploy you can see has that id.Link to Roll back a deployRoll back a deploy
/v1/deploys/{deploy_id}/rollbackUndo 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.
deploy_rollback in project_writescaffold.deploy.rollback()WriteAgents ask firstPath parameters
deploy_idstringrequiredAn earlier deploy of the project that was live before.
Body parameters
restore_databasebooleanAlso put back the project's database as its restorable_dump holds it. Rows written since are lost, so the database as it is now is dumped first, which rolling forward again with restore_database puts back.
Returns
The earlier deploy, live again.
Errors
plan_requiredThe deploy is a Node app, or restore_database was asked, and either needs the Paid plan.forbiddenrestore_database was asked and you are not an owner of the workspace.project_suspendedScaffold suspended the project.not_foundNo deploy you can see has that id.conflictThe deploy was never live, so it cannot go back live. Or restore_database was asked but no kept dump holds the database as it was then, or the database is being restored.Link to Read deploy logsRead deploy logs
/v1/deploys/{deploy_id}/logsRead 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.
deploy_logs in project_readscaffold.deploy.logs()ReadPath parameters
deploy_idstringrequiredQuery parameters
afterintegerA page's next, to read on from there. Left out, the newest runtime lines or every build line.
kindstringruntime, the app's output, or build, the deploy's steps to live. Left out, runtime.
One of runtime, build
max_bytesintegerThe most bytes of runtime lines to read, 1 to 65,536 and by default all of that. A page behind by more skips to the newest lines.
rangestringOnly lines from the last 15m, 1h, 24h or 7d. Left out, all that is kept.
One of 15m, 1h, 24h, 7d
Returns
A page of timed lines with where the next one starts, whether more can come, and when the host dropped older lines early to keep its log disk within its cap.
Errors
validation_failedmax_bytes is outside 1 to 65,536, range is not 15m, 1h, 24h or 7d, or after is no page's next.not_foundNo deploy you can see has that id.upstreamThe deploy's tenant host did not answer. Try again.Custom domains
Link to Add a custom domainAdd a custom domain
/v1/projects/{project_id}/domainsAdd 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.
domain_add in project_writescaffold.domain.add()WritePath parameters
project_idstringrequiredBody parameters
domainstringrequiredThe domain to serve the project's app on, like shop.example.com or example.com.
Returns
The domain, waiting for DNS, with the records to set.
Errors
validation_failedThe domain is not a domain name, or is under Scaffold's own.plan_requiredA Free workspace has 1 custom domain, and it has it.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe domain is on this project already, or the project holds the most domains it may, as the reason says.upstreamThis Scaffold has no edge for custom domains set up.Link to List custom domainsList custom domains
/v1/projects/{project_id}/domainsList a project's custom domains, oldest first, with where each stands, the DNS records it needs and when its certificate renews.
domain_list in project_readscaffold.domain.list()ReadPath parameters
project_idstringrequiredReturns
The project's custom domains, oldest first.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Check a custom domainCheck a custom domain
/v1/domains/{domain_id}/checkCheck 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.
domain_check in project_writescaffold.domain.check()WritePath parameters
domain_idstringrequiredReturns
The domain, waiting with the record it lacks, wrong with the problem found, or verified, marked when its records point away.
Errors
project_suspendedScaffold suspended the project.not_foundNo domain you can see has that id.upstreamA DNS lookup failed, so check again, or no edge is set up.Link to Remove a custom domainRemove a custom domain
/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.
domain_remove in project_writescaffold.domain.remove()WritePath parameters
domain_idstringrequiredReturns
The domain removed and when.
Errors
project_suspendedScaffold suspended the project.not_foundNo domain you can see has that id.Webhooks
Link to Create a webhook endpointCreate a webhook endpoint
/v1/projects/{project_id}/webhooksRegister 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.
webhook_endpoint_create in project_writescaffold.webhook.endpoint_create()WritePath parameters
project_idstringrequiredBody parameters
event_typesstring[]requiredThe events it takes, at least one.
urlstringrequiredAn https address without credentials, at most 2048 bytes.
Returns
The endpoint and its signing secret, shown only once. Each POST carries Scaffold-Webhook-Id, the same on every retry, and Scaffold-Signature as t=<unix seconds>,v1=<hex>: HMAC-SHA256 under the secret of <t>.<raw body>. Answer 2xx within 10 seconds; anything else is retried for about 3 days, and an endpoint that failed all that time is turned off.
Errors
validation_failedThe URL is not https, holds credentials or points at a private address, no event type was named, or the slug names projects in more than one of your workspaces.project_suspendedScaffold suspended the project.not_foundNo project you can see has that id or slug.conflictThe project already has 10 webhook endpoints.secret_shownA retry under the same Idempotency-Key, whose secret was already shown.Link to List webhook endpointsList webhook endpoints
/v1/projects/{project_id}/webhooksList a project's webhook endpoints, oldest first, without secrets.
webhook_endpoint_list in project_readscaffold.webhook.endpoint_list()ReadPath parameters
project_idstringrequiredReturns
The project's endpoints with the events each takes and whether it is on.
Errors
validation_failedThe slug names projects in more than one of your workspaces: send the id.not_foundNo project you can see has that id or slug.Link to Update a webhook endpointUpdate a webhook endpoint
/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.
webhook_endpoint_update in project_writescaffold.webhook.endpoint_update()WritePath parameters
endpoint_idstringrequiredBody parameters
enabledbooleanFalse turns it off; true turns it on again, also after Scaffold turned it off.
event_typesstring[]Replaces the whole list.
urlstringKeeps the signing secret.
Returns
The endpoint as it is now.
Errors
validation_failedThe URL is not https, holds credentials or points at a private address, or the event types are empty.project_suspendedScaffold suspended the project.not_foundNo webhook endpoint you can see has that id.Link to Delete a webhook endpointDelete a webhook endpoint
/v1/webhooks/{endpoint_id}Delete a webhook endpoint with its signing secret and delivery log. Nothing more is posted to it.
webhook_endpoint_delete in project_irreversiblescaffold.webhook.endpoint_delete()WriteAgents ask firstPath parameters
endpoint_idstringrequiredReturns
The deleted endpoint's id and when it was deleted.
Errors
project_suspendedScaffold suspended the project.not_foundNo webhook endpoint you can see has that id.Link to List webhook deliveriesList webhook deliveries
/v1/projects/{project_id}/webhook-deliveriesList a project's webhook deliveries of the last 30 days, newest first, with each try and what the endpoint answered.
webhook_delivery_list in project_readscaffold.webhook.delivery_list()ReadPath parameters
project_idstringrequiredQuery parameters
endpoint_idstringOnly this endpoint's deliveries.
failedbooleanOnly deliveries that failed for good.
limitinteger1 to 100, 20 when omitted.
starting_afterstringThe next_cursor of the page before.
Returns
A page of deliveries, newest first, each with its body and tries, with has_more and next_cursor.
Errors
validation_failedThe limit is out of range, or the slug names projects in more than one of your workspaces.not_foundNo project you can see has that id or slug.Link to Resend a webhook deliveryResend a webhook delivery
/v1/webhook-deliveries/{delivery_id}/resendTry a webhook delivery that has not succeeded again now, with the same event id and body.
webhook_delivery_resend in project_irreversiblescaffold.webhook.delivery_resend()WriteAgents ask firstPath parameters
delivery_idstringrequiredReturns
The delivery, its next try due now.
Errors
project_suspendedScaffold suspended the project.not_foundNo webhook delivery you can see has that id.conflictThe delivery succeeded already, was tried 26 times, or its endpoint is off.