Prospector Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/prospector/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"companyDomain": "example.com",
"agentOId": "agent_123",
"limit": 10,
"minimal": true,
"searchContext": {
"playbookOId": "<string>",
"personaOIds": [
"<string>"
],
"fuzzyTitles": [
"<string>"
],
"exactTitles": [
"<string>"
],
"excludeTitles": [
"<string>"
],
"personCountry": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"personLocation": {
"countryCode": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"city": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"text": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
}
}
}
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/prospector/run"
payload = {
"companyDomain": "example.com",
"agentOId": "agent_123",
"limit": 10,
"minimal": True,
"searchContext": {
"playbookOId": "<string>",
"personaOIds": ["<string>"],
"fuzzyTitles": ["<string>"],
"exactTitles": ["<string>"],
"excludeTitles": ["<string>"],
"personCountry": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"personLocation": {
"countryCode": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"city": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"text": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
}
}
}
}
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({
companyDomain: 'example.com',
agentOId: 'agent_123',
limit: 10,
minimal: true,
searchContext: {
playbookOId: '<string>',
personaOIds: ['<string>'],
fuzzyTitles: ['<string>'],
exactTitles: ['<string>'],
excludeTitles: ['<string>'],
personCountry: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
personLocation: {
countryCode: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
city: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
text: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
}
}
}
})
};
fetch('https://app.octavehq.com/api/v2/agents/prospector/run', 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/agents/prospector/run",
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([
'companyDomain' => 'example.com',
'agentOId' => 'agent_123',
'limit' => 10,
'minimal' => true,
'searchContext' => [
'playbookOId' => '<string>',
'personaOIds' => [
'<string>'
],
'fuzzyTitles' => [
'<string>'
],
'exactTitles' => [
'<string>'
],
'excludeTitles' => [
'<string>'
],
'personCountry' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'personLocation' => [
'countryCode' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'city' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'text' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
]
]
]
]),
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/agents/prospector/run"
payload := strings.NewReader("{\n \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\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/agents/prospector/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/prospector/run")
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 \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\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"
},
"found": true,
"message": "Additional information",
"data": {
"contacts": [
{
"contact": {
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>",
"profileUrl": "<string>",
"company": {
"name": "<string>",
"description": "<string>",
"domain": "<string>",
"website": "<string>",
"founded": 123,
"location": {
"region": "<string>",
"locality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"streetAddress": "<string>"
},
"employeeCount": 123,
"followerCount": 123,
"type": "<string>",
"slug": "<string>",
"logoUrl": "<string>",
"countryCode": "<string>",
"specialties": [
"<string>"
],
"industry": "<string>",
"crunchBaseFunding": [
{
"fundingRoundCount": 123,
"roundDate": "2023-11-07T05:31:56Z",
"roundName": "<string>",
"investorNames": [
"<string>"
],
"investorCount": 123,
"roundAmount": 123,
"roundCurrency": "<string>"
}
]
},
"companyName": "<string>",
"companyDomain": "<string>",
"companyFoundedYear": 123,
"companyEmployeeCount": 123,
"companyDescription": "<string>",
"headline": "<string>",
"summary": "<string>",
"slug": "<string>",
"internalPictureUrl": "<string>",
"countryCode": "<string>",
"location": "<string>",
"city": "<string>",
"currentJobFunction": "<string>",
"currentSeniority": "<string>",
"followers": 123,
"allPositionsCount": 123,
"currentPositionsCount": 123,
"positions": [
{
"companyName": "<string>",
"title": "<string>",
"summary": "<string>",
"is_current": false,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"seniority": "<string>",
"jobFunction": "<string>",
"company": {
"name": "<string>",
"domain": "<string>",
"founded": 123,
"employeeCount": 123,
"description": "<string>",
"location": {
"region": "<string>",
"locality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"streetAddress": "<string>"
},
"slug": "<string>"
}
}
]
},
"lookalikeSource": "<string>",
"personas": [
{
"name": "<string>",
"oId": "<string>"
}
]
}
],
"count": 123
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Agents
Prospector Agent
Find relevant people at a company or lookalike companies
POST
/
api
/
v2
/
agents
/
prospector
/
run
Prospector Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/prospector/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"companyDomain": "example.com",
"agentOId": "agent_123",
"limit": 10,
"minimal": true,
"searchContext": {
"playbookOId": "<string>",
"personaOIds": [
"<string>"
],
"fuzzyTitles": [
"<string>"
],
"exactTitles": [
"<string>"
],
"excludeTitles": [
"<string>"
],
"personCountry": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"personLocation": {
"countryCode": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"city": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
},
"text": {
"matches": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
},
"excludes": {
"exact": [
"<string>"
],
"contains": [
"<string>"
],
"prefix": [
"<string>"
]
}
}
}
}
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/prospector/run"
payload = {
"companyDomain": "example.com",
"agentOId": "agent_123",
"limit": 10,
"minimal": True,
"searchContext": {
"playbookOId": "<string>",
"personaOIds": ["<string>"],
"fuzzyTitles": ["<string>"],
"exactTitles": ["<string>"],
"excludeTitles": ["<string>"],
"personCountry": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"personLocation": {
"countryCode": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"city": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
},
"text": {
"matches": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
},
"excludes": {
"exact": ["<string>"],
"contains": ["<string>"],
"prefix": ["<string>"]
}
}
}
}
}
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({
companyDomain: 'example.com',
agentOId: 'agent_123',
limit: 10,
minimal: true,
searchContext: {
playbookOId: '<string>',
personaOIds: ['<string>'],
fuzzyTitles: ['<string>'],
exactTitles: ['<string>'],
excludeTitles: ['<string>'],
personCountry: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
personLocation: {
countryCode: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
city: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
},
text: {
matches: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']},
excludes: {exact: ['<string>'], contains: ['<string>'], prefix: ['<string>']}
}
}
}
})
};
fetch('https://app.octavehq.com/api/v2/agents/prospector/run', 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/agents/prospector/run",
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([
'companyDomain' => 'example.com',
'agentOId' => 'agent_123',
'limit' => 10,
'minimal' => true,
'searchContext' => [
'playbookOId' => '<string>',
'personaOIds' => [
'<string>'
],
'fuzzyTitles' => [
'<string>'
],
'exactTitles' => [
'<string>'
],
'excludeTitles' => [
'<string>'
],
'personCountry' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'personLocation' => [
'countryCode' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'city' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
],
'text' => [
'matches' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
],
'excludes' => [
'exact' => [
'<string>'
],
'contains' => [
'<string>'
],
'prefix' => [
'<string>'
]
]
]
]
]
]),
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/agents/prospector/run"
payload := strings.NewReader("{\n \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\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/agents/prospector/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/prospector/run")
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 \"companyDomain\": \"example.com\",\n \"agentOId\": \"agent_123\",\n \"limit\": 10,\n \"minimal\": true,\n \"searchContext\": {\n \"playbookOId\": \"<string>\",\n \"personaOIds\": [\n \"<string>\"\n ],\n \"fuzzyTitles\": [\n \"<string>\"\n ],\n \"exactTitles\": [\n \"<string>\"\n ],\n \"excludeTitles\": [\n \"<string>\"\n ],\n \"personCountry\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"personLocation\": {\n \"countryCode\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"city\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n },\n \"text\": {\n \"matches\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n },\n \"excludes\": {\n \"exact\": [\n \"<string>\"\n ],\n \"contains\": [\n \"<string>\"\n ],\n \"prefix\": [\n \"<string>\"\n ]\n }\n }\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"
},
"found": true,
"message": "Additional information",
"data": {
"contacts": [
{
"contact": {
"firstName": "<string>",
"lastName": "<string>",
"title": "<string>",
"profileUrl": "<string>",
"company": {
"name": "<string>",
"description": "<string>",
"domain": "<string>",
"website": "<string>",
"founded": 123,
"location": {
"region": "<string>",
"locality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"streetAddress": "<string>"
},
"employeeCount": 123,
"followerCount": 123,
"type": "<string>",
"slug": "<string>",
"logoUrl": "<string>",
"countryCode": "<string>",
"specialties": [
"<string>"
],
"industry": "<string>",
"crunchBaseFunding": [
{
"fundingRoundCount": 123,
"roundDate": "2023-11-07T05:31:56Z",
"roundName": "<string>",
"investorNames": [
"<string>"
],
"investorCount": 123,
"roundAmount": 123,
"roundCurrency": "<string>"
}
]
},
"companyName": "<string>",
"companyDomain": "<string>",
"companyFoundedYear": 123,
"companyEmployeeCount": 123,
"companyDescription": "<string>",
"headline": "<string>",
"summary": "<string>",
"slug": "<string>",
"internalPictureUrl": "<string>",
"countryCode": "<string>",
"location": "<string>",
"city": "<string>",
"currentJobFunction": "<string>",
"currentSeniority": "<string>",
"followers": 123,
"allPositionsCount": 123,
"currentPositionsCount": 123,
"positions": [
{
"companyName": "<string>",
"title": "<string>",
"summary": "<string>",
"is_current": false,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"seniority": "<string>",
"jobFunction": "<string>",
"company": {
"name": "<string>",
"domain": "<string>",
"founded": 123,
"employeeCount": 123,
"description": "<string>",
"location": {
"region": "<string>",
"locality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"streetAddress": "<string>"
},
"slug": "<string>"
}
}
]
},
"lookalikeSource": "<string>",
"personas": [
{
"name": "<string>",
"oId": "<string>"
}
]
}
],
"count": 123
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Prospector input
Company to find prospects or use as lookalike source
Example:
"example.com"
AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.
Example:
"agent_123"
Override the Agent's configured limit
Required range:
1 <= x <= 1000Example:
10
Minimize the output. If set to true, positions, internalPictureUrl, and the nested company object will be omitted from the output.
Example:
true
Optional search context to override agent's configured search context. If provided, the two objects will be merged.
Show child attributes
Show child attributes
⌘I