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
}
'{
"_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,
"visibility": "public",
"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": {
"businessModel": [
"<string>"
],
"operatingEnvironment": [
"<string>"
],
"uniqueCharacteristics": [
"<string>"
],
"marketSummary": [
"<string>"
],
"customersWeServe": [
"<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>",
"capabilities": [
"Capability 1",
"Capability 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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"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"
],
"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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"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>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
],
"references": [
{
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"unrecognized": false
}
],
"playbookSuggestions": {
"solution": [
"<string>"
],
"sector": [
"<string>"
],
"practitioner": [
"<string>"
],
"milestone": [
"<string>"
]
}
}
}Generate and build a Workspace
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
}
'{
"_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,
"visibility": "public",
"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": {
"businessModel": [
"<string>"
],
"operatingEnvironment": [
"<string>"
],
"uniqueCharacteristics": [
"<string>"
],
"marketSummary": [
"<string>"
],
"customersWeServe": [
"<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>",
"capabilities": [
"Capability 1",
"Capability 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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"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"
],
"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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"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>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
],
"references": [
{
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<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,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"unrecognized": false
}
],
"playbookSuggestions": {
"solution": [
"<string>"
],
"sector": [
"<string>"
],
"practitioner": [
"<string>"
],
"milestone": [
"<string>"
]
}
}
}Generate and build a Workspace input
Show child attributes
Name of the Workspace
"Octave"
URL of the Workspace
"https://octave.com"
If true, existing users of the parent workspace will be added to the new workspace
true
Optional array of agent OIds to copy from the source workspace
["agent_oid1", "agent_oid2"]Show child attributes
Type of offering - currently only PRODUCT is supported for workspace building.
PRODUCT, SERVICE "PRODUCT"
Name of the Offering if different than the workspace
"Octave"
Additional URLs for the Offering. By default the workspace URL will be used
Differentiated Value of the Product
"Our unique approach to..."
Status Quo of the Product
Comparative Advantage of the Product
"Our main advantage over the competition is..."
Likely Alternative of the Product
"A more traditional approach to..."
Optional array of existing reference customers that use the offering
Additional context to help build the Workspace, Persona, Use Cases, etc
Optional brand voice ID to apply to generated entities
"bv_789"
Whether to create default agents (Email, Prospector, etc.) for the new workspace
true
Workspace setup successful
Whether the operation was successful
true
Message
"Additional information"
Show child attributes
Show child attributes
1public, private Show child attributes
Show child attributes
API Key for the newly created Workspace
Show child attributes
The ID of the product
1"p_1234"
The date and time the product was created
"2021-01-01"
Show child attributes
PRODUCT, SERVICE The internal name of the product
Key capabilities of the product
["Capability 1", "Capability 2"]The differentiated value of the product
[
"Differentiated Value 1",
"Differentiated Value 2"
]The status quo of the product
["Status Quo 1", "Status Quo 2"]The challenges addressed by the offering
["Challenge 1", "Challenge 2"]The customer benefits of the offering
["Benefit 1", "Benefit 2"]Show child attributes
The ID of the user who created the product
"u_1234"
The first name of the user who created the product
"John"
The last name of the user who created the product
"Doe"
The date and time the product was updated
"2021-01-01"
The date and time the product was archived
"2021-01-01"
The date and time the product was deleted
"2021-01-01"
The external facing name of the product
"Product Name"
The internal name of the product
"Product Internal Name"
The description of the product
"Product Description"
The primary URL of the product
"https://www.product.com"
Whether the product is active and can be used
true
Show child attributes
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID Show child attributes
1 <= x <= 20WEBSITE, WEBSITE_SCREENSHOT, REFERENCE_SCAN_WEBSITE, REFERENCE_SCAN_SCREENSHOT, FILE, TEXT, WORKSPACE_COMPANY, PRODUCT, PERSONA, USE_CASE, REFERENCE, PLAYBOOK, HYPOTHESIS, COMPETITOR, PROOF_POINT, TOPIC_CLUSTER, SEGMENT, FEATURE, FEATURE_SET, FEATURE_SET_REQUEST, TESTING, GLOBAL_RESOURCE 0 <= x <= 1Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived
Show child attributes
The ID of the persona
1"p_1234"
The date and time the persona was created
"2021-01-01"
Show child attributes
The internal name of the persona
The primary responsibilities of the persona
["Responsibility 1", "Responsibility 2"]The pain points of the persona
["Pain Point 1", "Pain Point 2"]The key concerns of the persona
["Concern 1", "Concern 2"]The key objectives of the persona
["Objective 1", "Objective 2"]The common job titles of the persona
["Job Title 1", "Job Title 2"]The reasons why the persona matters to us
["Reason 1", "Reason 2"]The reasons why we matter to this type of persona
["Reason 1", "Reason 2"]Show child attributes
The ID of the user who created the persona
"u_1234"
The first name of the user who created the persona
"John"
The last name of the user who created the persona
"Doe"
The name of the persona
"VP of Sales"
The internal name of the persona
"Sally the Sales Leader"
The description of the persona
The date and time the persona was deleted
"2021-01-01"
The date and time the persona was archived
"2021-01-01"
The date and time the persona was updated
"2021-01-01"
Whether the persona is unrecognized
false
Whether the persona is rejected
false
Whether the persona is active and can be used
true
Show child attributes
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID Show child attributes
1 <= x <= 20WEBSITE, WEBSITE_SCREENSHOT, REFERENCE_SCAN_WEBSITE, REFERENCE_SCAN_SCREENSHOT, FILE, TEXT, WORKSPACE_COMPANY, PRODUCT, PERSONA, USE_CASE, REFERENCE, PLAYBOOK, HYPOTHESIS, COMPETITOR, PROOF_POINT, TOPIC_CLUSTER, SEGMENT, FEATURE, FEATURE_SET, FEATURE_SET_REQUEST, TESTING, GLOBAL_RESOURCE 0 <= x <= 1Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived
Show child attributes
The ID of the use case
1"uc_1234"
The date and time the use case was created
"2021-01-01"
The date and time the use case was updated
"2021-01-01"
The date and time the use case was deleted
"2021-01-01"
The date and time the use case was archived
"2021-01-01"
The name of the use case
"Use Case Name"
The internal name of the use case
"Use Case Internal Name"
The description of the use case
"Use Case Description"
The primary URL of the use case
"https://www.use-case.com"
Whether the use case is active and can be used
true
Show child attributes
Summary
Scenarios
Desired Outcomes
Business Drivers
Show child attributes
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID Show child attributes
1 <= x <= 20WEBSITE, WEBSITE_SCREENSHOT, REFERENCE_SCAN_WEBSITE, REFERENCE_SCAN_SCREENSHOT, FILE, TEXT, WORKSPACE_COMPANY, PRODUCT, PERSONA, USE_CASE, REFERENCE, PLAYBOOK, HYPOTHESIS, COMPETITOR, PROOF_POINT, TOPIC_CLUSTER, SEGMENT, FEATURE, FEATURE_SET, FEATURE_SET_REQUEST, TESTING, GLOBAL_RESOURCE 0 <= x <= 1Scenarios
Desired Outcomes
Show child attributes
The ID of the reference
1"r_1234"
The date and time the reference was created
"2021-01-01"
Show child attributes
Show child attributes
The external facing name of the reference
"Large filesharing service"
The internal name of the reference
"Dropbox"
The date and time the reference was updated
"2021-01-01"
The date and time the reference was deleted
"2021-01-01"
The date and time the reference was archived
"2021-01-01"
The description of the reference
"Description of the reference"
Whether the reference is active and can be used
true
Show child attributes
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID Show child attributes
1 <= x <= 20WEBSITE, WEBSITE_SCREENSHOT, REFERENCE_SCAN_WEBSITE, REFERENCE_SCAN_SCREENSHOT, FILE, TEXT, WORKSPACE_COMPANY, PRODUCT, PERSONA, USE_CASE, REFERENCE, PLAYBOOK, HYPOTHESIS, COMPETITOR, PROOF_POINT, TOPIC_CLUSTER, SEGMENT, FEATURE, FEATURE_SET, FEATURE_SET_REQUEST, TESTING, GLOBAL_RESOURCE 0 <= x <= 1Whether the reference is unrecognized
false