Skip to main content
POST
Workspace Builder Agent

Authorizations

api_key
string
header
required

Body

application/json

Generate and build a Workspace input

workspace
object
required
offering
object
runtimeContext
any | null

Additional context to help build the Workspace, Persona, Use Cases, etc

brandVoiceOId
string

Optional brand voice ID to apply to generated entities

Example:

"bv_789"

createDefaultAgents
boolean

Whether to create default agents (Email, Prospector, etc.) for the new workspace

Example:

true

async
boolean

If true, the workspace build will be processed asynchronously

Example:

false

callbackUrl
string<uri>

Optional callback URL. When provided with async: true, the API will POST the result to this URL once processing completes.

Example:

"https://example.com/webhook/workspace"

Response

Workspace setup successful

_metadata
object
required
found
boolean
required

Whether the operation was successful

Example:

true

message
string | null

Message

Example:

"Additional information"

data
object | null