api reference/workspace

workspace

discover workspaces, retrieve settings, and get a full overview of your workspace context including brand identity and connected accounts.

get the current authenticated user profile. returns user id, email, display name, and subscription status.

> who am i?
  using antwork.whoami

  [done] user identified
  [info] email: john@acme.com, plan: pro

list all workspaces the authenticated user belongs to. call this first if you need to know which workspaces are available.

> what workspaces do i have?
  using antwork.list_workspaces

  [done] 2 workspaces found
  [info] "Acme Inc", "Side Project"

get an overview of a workspace. returns workspace name, brand identity, connected platforms, voice profiles summary, and post stats.

> give me an overview of my workspace
  using antwork.get_workspace_context

  [done] workspace: "Acme Inc"
  [info] 3 connected accounts, 12 posts

parameters

workspace_idstringoptional

workspace id or name. optional if user has only one workspace

retrieve workspace settings including posting schedule and connected platforms.

> show me my workspace settings
  using antwork.get_workspace_settings

  [done] settings retrieved
  [info] posting schedule: Mon-Fri 9am, 12pm, 5pm

parameters

workspace_idstringoptional

workspace id or name. optional if user has only one workspace