Account
Workspace, plan and usage, the CLI's device login, deleting workspaces and the workspace's own storage bucket.
Start a device authorisation
Unauthenticated, modelled on OAuth's device authorisation (RFC 8628). The CLI calls this, shows `user_code`, and polls `/auth/device/token` until the person approves it in the app at `verification_uri`, signed in, picking the workspace. The codes expire after 10 minutes.
Poll a device authorisation
Unauthenticated. Answers 202 while the request is pending and 200 with the API key once it is approved. The key belongs to the workspace the person picked, carries the scopes of their role there and appears under API keys in the app. It is handed over exactly once. A refused request answers 403 `forbidden`, a key already handed over 409 `conflict`, an expired or unknown code 404 `not_found`.
Get workspace and plan
The key's workspace and organisation, the organisation's plan with its limits, and the units of the current billing period. Units belong to the organisation and are shared by all its workspaces. Needs `account:read`.
Get usage for the current period
Units of the organisation's current or an earlier billing period, in total, per UTC day and per template. With a paid subscription the periods run monthly from its billing day; without one they are calendar months. Needs `account:read`.
Delete a workspace
Deletes a workspace of the key's organisation, for example a per-branch preview workspace your
Read the storage connection
The bucket this workspace's outputs are copied to (bring your own storage, Pro plan and above),
Connect a bucket
Creates or replaces the workspace's connection. Formfeed writes the test object
Disconnect the bucket
Removes the connection and its credentials. Deliveries still waiting end; objects already in the bucket stay there.
Test the storage connection again
Writes the test object with the stored credentials. A connection paused after five permanent
Deliver failed copies again
Queues every failed delivery again whose output Formfeed still keeps, for one render, one