dryRun, expectedVersion and confirmation tokens. All examples use synthetic data.
create_workspace
Create a workspace inDRAFT status in a team. It uses a workspace slot of the plan. Nothing is generated or monitored until the workspace goes LIVE.
Parameters
Example
update_workspace
Change the profile of a workspace, or move it betweenDRAFT, LIVE and ARCHIVED. Send only the fields you want to change.
Parameters
The domain, the workspace type and the confirmed onboarding profile cannot be changed.
Lifecycle and confirmation
Every change needs a confirmation token from a preview. A move toLIVE also prices the collection it triggers.
As in the dashboard, archiving is available to agencies, or to any team while it has more active workspaces than its plan includes. Restoring is refused while another active workspace tracks the same domain for the same language and country.
Activating a workspace does not start a run, but the next scheduler pass collects the prompts that are due: those never collected while automatic answers are on, and those the schedule collects that day (for example on the analysis day of a weekly workspace). The preview prices that collection in
credits.oneOff. To collect at once, use start_run.
Example
update_monitoring
Change the monitoring frequency, schedule and models of a workspace, or stop its schedule with frequencyNONE.
Parameters
Every change needs a confirmation token from a preview, which reports any change in recurring credit use, for example a move from weekly to daily monitoring or a larger model list.
NONE stops the prompts that inherit the workspace schedule; prompts with their own frequency keep running, as in the dashboard. It keeps the monitoring setting of each prompt, and work already accepted can still finish. A workspace without saved settings has no model and does not generate answers automatically.
Example
Related
- Run and credit tools to check the balance before raising frequency.
- Writing data for the REST equivalents.

