Workspace Builder Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/workspace/build \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"workspace": {
"name": "Octave",
"url": "https://octave.com",
"addExistingUsers": true,
"agentOIds": [
"agent_oid1",
"agent_oid2"
]
},
"offering": {
"type": "PRODUCT",
"name": "Octave",
"additionalUrls": [
"<string>"
],
"differentiatedValue": "Our unique approach to...",
"statusQuo": "<string>",
"comparativeAdvantage": "Our main advantage over the competition is...",
"likelyAlternative": "A more traditional approach to...",
"references": [
{
"url": "<string>",
"details": "<string>"
}
]
},
"runtimeContext": "<unknown>",
"brandVoiceOId": "bv_789",
"createDefaultAgents": true,
"async": false,
"callbackUrl": "https://example.com/webhook/workspace"
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"found": true,
"message": "Additional information",
"data": {
"workspace": {
"oId": "<string>",
"name": "<string>",
"isOnboarded": true,
"createdBy": {
"oId": "<string>"
},
"isDefault": true,
"description": "<string>",
"domain": "<string>",
"logo": "<string>",
"active": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"organization": {
"oId": "<string>",
"name": "<string>",
"domain": "<string>",
"slug": "<string>",
"logo": "<string>"
}
},
"workspaceCompany": {
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"name": "<string>",
"url": "<string>",
"data": {
"whyWeExist": [
"<string>"
],
"howWePositionOurselves": [
"<string>"
],
"whoWeHelp": [
"<string>"
],
"whatMakesUsUnique": [
"<string>"
],
"businessModel": [
"<string>"
],
"marketDynamics": [
"<string>"
],
"whyCustomersBuy": [
"<string>"
],
"whyCustomersCare": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"customMarketFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"internalName": "<string>",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
}
},
"apiKey": "<string>",
"offering": {
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFeatures": [
"Feature 1",
"Feature 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"updatedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"name": "Product Name",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
},
"personas": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"updatedAt": "2021-01-01",
"unrecognized": false,
"rejected": false,
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
],
"useCases": [
{
"oId": "uc_1234",
"createdAt": "2021-01-01",
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"name": "Use Case Name",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"active": true,
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
],
"segments": [
{
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"strategicFit": [],
"firmographics": {
"industry": [],
"businessModel": [],
"geography": [],
"revenue": [],
"employees": []
},
"operatingCharacteristics": [],
"strategicPriorities": [],
"marketPressures": [],
"buyingDynamics": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}
],
"references": [
{
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": "<string>",
"theirChallenge": "<string>",
"howTheyUseUs": "<string>",
"whyTheyChoseUs": "<string>",
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "w_1234"
},
"name": "Large filesharing service",
"internalName": "Dropbox",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"unrecognized": false
}
],
"playbookSuggestions": {
"solution": [
"<string>"
],
"sector": [
"<string>"
],
"practitioner": [
"<string>"
],
"milestone": [
"<string>"
]
}
}
}Workspace
Workspace Builder Agent
Generate and build a Workspace
POST
/
api
/
v2
/
agents
/
workspace
/
build
Workspace Builder Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/workspace/build \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"workspace": {
"name": "Octave",
"url": "https://octave.com",
"addExistingUsers": true,
"agentOIds": [
"agent_oid1",
"agent_oid2"
]
},
"offering": {
"type": "PRODUCT",
"name": "Octave",
"additionalUrls": [
"<string>"
],
"differentiatedValue": "Our unique approach to...",
"statusQuo": "<string>",
"comparativeAdvantage": "Our main advantage over the competition is...",
"likelyAlternative": "A more traditional approach to...",
"references": [
{
"url": "<string>",
"details": "<string>"
}
]
},
"runtimeContext": "<unknown>",
"brandVoiceOId": "bv_789",
"createDefaultAgents": true,
"async": false,
"callbackUrl": "https://example.com/webhook/workspace"
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"found": true,
"message": "Additional information",
"data": {
"workspace": {
"oId": "<string>",
"name": "<string>",
"isOnboarded": true,
"createdBy": {
"oId": "<string>"
},
"isDefault": true,
"description": "<string>",
"domain": "<string>",
"logo": "<string>",
"active": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"organization": {
"oId": "<string>",
"name": "<string>",
"domain": "<string>",
"slug": "<string>",
"logo": "<string>"
}
},
"workspaceCompany": {
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"name": "<string>",
"url": "<string>",
"data": {
"whyWeExist": [
"<string>"
],
"howWePositionOurselves": [
"<string>"
],
"whoWeHelp": [
"<string>"
],
"whatMakesUsUnique": [
"<string>"
],
"businessModel": [
"<string>"
],
"marketDynamics": [
"<string>"
],
"whyCustomersBuy": [
"<string>"
],
"whyCustomersCare": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"customMarketFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"internalName": "<string>",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
}
},
"apiKey": "<string>",
"offering": {
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFeatures": [
"Feature 1",
"Feature 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"updatedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"name": "Product Name",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
},
"personas": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"updatedAt": "2021-01-01",
"unrecognized": false,
"rejected": false,
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
],
"useCases": [
{
"oId": "uc_1234",
"createdAt": "2021-01-01",
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"name": "Use Case Name",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"active": true,
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
],
"segments": [
{
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"strategicFit": [],
"firmographics": {
"industry": [],
"businessModel": [],
"geography": [],
"revenue": [],
"employees": []
},
"operatingCharacteristics": [],
"strategicPriorities": [],
"marketPressures": [],
"buyingDynamics": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}
],
"references": [
{
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": "<string>",
"theirChallenge": "<string>",
"howTheyUseUs": "<string>",
"whyTheyChoseUs": "<string>",
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "w_1234"
},
"name": "Large filesharing service",
"internalName": "Dropbox",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"unrecognized": false
}
],
"playbookSuggestions": {
"solution": [
"<string>"
],
"sector": [
"<string>"
],
"practitioner": [
"<string>"
],
"milestone": [
"<string>"
]
}
}
}Authorizations
Body
application/json
Generate and build a Workspace input
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Additional context to help build the Workspace, Persona, Use Cases, etc
Optional brand voice ID to apply to generated entities
Example:
"bv_789"
Whether to create default agents (Email, Prospector, etc.) for the new workspace
Example:
true
If true, the workspace build will be processed asynchronously
Example:
false
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"
⌘I