curl --request POST \
--url https://app.octavehq.com/api/v2/workspace-company/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"domain": "acme.com",
"sources": [
{
"type": "TEXT",
"value": "We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data."
}
]
}
'import requests
url = "https://app.octavehq.com/api/v2/workspace-company/generate"
payload = {
"domain": "acme.com",
"sources": [
{
"type": "TEXT",
"value": "We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data."
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
domain: 'acme.com',
sources: [
{
type: 'TEXT',
value: 'We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.'
}
]
})
};
fetch('https://app.octavehq.com/api/v2/workspace-company/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/workspace-company/generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'domain' => 'acme.com',
'sources' => [
[
'type' => 'TEXT',
'value' => 'We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/workspace-company/generate"
payload := strings.NewReader("{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/workspace-company/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/workspace-company/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"name": "<string>",
"url": "<string>",
"data": {
"whyWeExist": [
"<string>"
],
"howWePositionOurselves": [
"<string>"
],
"whoWeHelp": [
"<string>"
],
"whatMakesUsUnique": [
"<string>"
],
"businessModel": [
"<string>"
],
"marketDynamics": [
"<string>"
],
"whatWeDo": "<string>",
"whyCustomersBuy": [
"<string>"
],
"whyCustomersCare": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"customMarketFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"internalName": "<string>",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"intelOverride": {
"enabled": true,
"guidance": "<string>"
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Generate Workspace Company
Generate workspace company content from a domain, free-form source materials (text, URLs, or Resource references), or both. At least one of domain or sources is required. When domain is provided it is scraped; when sources are provided they are expanded; both feed the workspace builder LLM. The result is persisted: the existing workspace company is updated in place, or one is created if it does not exist.
curl --request POST \
--url https://app.octavehq.com/api/v2/workspace-company/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"domain": "acme.com",
"sources": [
{
"type": "TEXT",
"value": "We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data."
}
]
}
'import requests
url = "https://app.octavehq.com/api/v2/workspace-company/generate"
payload = {
"domain": "acme.com",
"sources": [
{
"type": "TEXT",
"value": "We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data."
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
domain: 'acme.com',
sources: [
{
type: 'TEXT',
value: 'We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.'
}
]
})
};
fetch('https://app.octavehq.com/api/v2/workspace-company/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/workspace-company/generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'domain' => 'acme.com',
'sources' => [
[
'type' => 'TEXT',
'value' => 'We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/workspace-company/generate"
payload := strings.NewReader("{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/workspace-company/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/workspace-company/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"acme.com\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data.\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"name": "<string>",
"url": "<string>",
"data": {
"whyWeExist": [
"<string>"
],
"howWePositionOurselves": [
"<string>"
],
"whoWeHelp": [
"<string>"
],
"whatMakesUsUnique": [
"<string>"
],
"businessModel": [
"<string>"
],
"marketDynamics": [
"<string>"
],
"whatWeDo": "<string>",
"whyCustomersBuy": [
"<string>"
],
"whyCustomersCare": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"customMarketFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"internalName": "<string>",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"intelOverride": {
"enabled": true,
"guidance": "<string>"
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
Workspace Company generation input
The domain or URL to scrape and generate the workspace company from. Optional if sources is provided.
1"acme.com"
Optional source materials (text or URLs) to feed into the workspace company generation. At least one of domain or sources must be provided. When both are provided, the scraped domain content and the expanded sources are combined.
Show child attributes
Show child attributes
[
{
"type": "TEXT",
"value": "We are a stealth-mode B2B platform helping mid-market RevOps teams unify pipeline data."
}
]