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>",
    "references": [
      {
        "url": "<string>",
        "details": "<string>"
      }
    ]
  },
  "runtimeContext": "<any>",
  "brandVoiceOId": "bv_789"
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "apiKey": "<string>",
    "offering": {
      "oId": "p_1234",
      "createdAt": "2021-01-01",
      "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,
      "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>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "user": {
        "oId": "u_1234"
      },
      "workspace": {
        "oId": "wa_1234"
      }
    },
    "personas": [
      {
        "oId": "p_1234",
        "name": "VP of Sales",
        "internalName": "Sally the Sales Leader",
        "description": "<string>",
        "createdAt": "2021-01-01",
        "deletedAt": "2021-01-01",
        "archivedAt": "2021-01-01",
        "updatedAt": "2021-01-01",
        "unrecognized": false,
        "rejected": false,
        "active": true,
        "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>"
              ]
            }
          ]
        },
        "qualifyingQuestions": [
          {
            "question": "<string>",
            "rationale": "<string>",
            "fitType": "GOOD",
            "weight": "MEDIUM",
            "archivedAt": "<string>"
          }
        ],
        "user": {
          "oId": "u_1234"
        },
        "workspace": {
          "oId": "wa_1234"
        },
        "activeSequences": 123,
        "sentEmails": 123
      }
    ],
    "useCases": [
      {
        "oId": "uc_1234",
        "createdAt": "2021-01-01",
        "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>"
              ]
            }
          ]
        },
        "user": {
          "oId": "<string>"
        },
        "workspace": {
          "oId": "<string>"
        },
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ]
      }
    ],
    "references": [
      {
        "oId": "r_1234",
        "name": "Large filesharing service",
        "internalName": "Dropbox",
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01",
        "deletedAt": "2021-01-01",
        "archivedAt": "2021-01-01",
        "description": "Description of the reference",
        "active": true,
        "data": {
          "howTheyMakeMoney": "<string>",
          "howTheyUseProduct": "<string>",
          "howTheyBenefitFromProduct": "<string>",
          "emailSnippets": [
            "<string>"
          ],
          "howWeImpactedTheirBusiness": [
            "<string>"
          ],
          "keyStats": [
            "<string>"
          ],
          "customFields": [
            {
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        },
        "user": {
          "oId": "u_1234"
        },
        "workspace": {
          "oId": "w_1234"
        },
        "unrecognized": false
      }
    ],
    "workspace": {
      "oId": "<string>",
      "name": "<string>",
      "isDefault": true,
      "isOnboarded": true,
      "visibility": "public",
      "description": "<string>",
      "domain": "<string>",
      "logo": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": {
        "oId": "<string>"
      },
      "organization": {
        "oId": "<string>",
        "name": "<string>",
        "domain": "<string>"
      }
    },
    "workspaceCompany": {
      "oId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<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>"
            ]
          }
        ]
      },
      "description": "<string>",
      "name": "<string>",
      "url": "<string>",
      "user": {
        "oId": "<string>"
      },
      "workspace": {
        "oId": "<string>"
      }
    },
    "playbookSuggestions": {
      "solution": [
        "<string>"
      ],
      "sector": [
        "<string>"
      ],
      "practitioner": [
        "<string>"
      ],
      "milestone": [
        "<string>"
      ]
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Generate and build a Workspace input

The body is of type object.

Response

200
application/json

Workspace setup successful

The response is of type object.