Skip to content
SynthBoard
ENעב

Build with SynthBoard

Offices

One office per user of your app, keyed by your own user id: the same experts, their own file and record, isolated from every other user.

One per user#

Create an office the first time a user of yours asks something. It is keyed by your external_user_id: creating it again returns the same office. Each office is its own isolated space — nothing one user tells it reaches another.

  • POST /v1/offices — Create a managed office for one of your users (idempotent by external_user_id) (createOffice, scope offices:write)
  • GET /v1/offices — List your managed offices (cursor-paged, newest first) (listOffices, scope offices:read)
  • GET /v1/offices/{officeId} — Get a managed office (getOffice, scope offices:read)
  • DELETE /v1/offices/{officeId} — Delete a managed office and erase everything in it (deleteOffice, scope offices:write)

Language#

Pass the user's language when you create the office; answers follow the language each message is written in, and the notice comes back in the office's language.

Pause, export, erase#

In the console, an office's page can pause it (new asks get office_paused; work already running finishes), export everything in it as JSON, or erase it. DELETE /v1/offices/{officeId} erases it from your code: every matter, file, fact and record goes; the console keeps a tombstone with the ids and dates only.