Qualify Company Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/qualify-company/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"includeFullAnnotation": true
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/qualify-company/run"
payload = {
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"includeFullAnnotation": True
}
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({
agentOId: 'agent_123',
companyDomain: 'example.com',
companyName: '<string>',
crmAccountId: '<string>',
runtimeContext: '<unknown>',
includeFullAnnotation: true
})
};
fetch('https://app.octavehq.com/api/v2/agents/qualify-company/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/qualify-company/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([
'agentOId' => 'agent_123',
'companyDomain' => 'example.com',
'companyName' => '<string>',
'crmAccountId' => '<string>',
'runtimeContext' => '<unknown>',
'includeFullAnnotation' => true
]),
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/qualify-company/run"
payload := strings.NewReader("{\n \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\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/qualify-company/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/qualify-company/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 \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\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": {
"score": 123,
"rationale": "<string>",
"product": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"service": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"solution": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"segment": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"playbook": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<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>"
}
]
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
},
"customTask": {
"content": "<unknown>",
"error": "<string>"
},
"disqualifierSummary": {
"triggered": true,
"firstQuestion": "<string>",
"firstRationale": "<string>",
"totalCount": 123
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Agents
Qualify Company Agent
Determine if a company is qualified for a given Product and/or Segment
POST
/
api
/
v2
/
agents
/
qualify-company
/
run
Qualify Company Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/qualify-company/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"includeFullAnnotation": true
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/qualify-company/run"
payload = {
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"includeFullAnnotation": True
}
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({
agentOId: 'agent_123',
companyDomain: 'example.com',
companyName: '<string>',
crmAccountId: '<string>',
runtimeContext: '<unknown>',
includeFullAnnotation: true
})
};
fetch('https://app.octavehq.com/api/v2/agents/qualify-company/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/qualify-company/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([
'agentOId' => 'agent_123',
'companyDomain' => 'example.com',
'companyName' => '<string>',
'crmAccountId' => '<string>',
'runtimeContext' => '<unknown>',
'includeFullAnnotation' => true
]),
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/qualify-company/run"
payload := strings.NewReader("{\n \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\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/qualify-company/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/qualify-company/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 \"agentOId\": \"agent_123\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"includeFullAnnotation\": true\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": {
"score": 123,
"rationale": "<string>",
"product": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"service": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"solution": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"segment": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<string>"
}
},
"playbook": {
"message": "<string>",
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"qualification": {
"answers": [
{
"answer": "<string>",
"rationale": "<string>",
"question": "<string>"
}
],
"score": 123,
"rationale": "<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>"
}
]
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
},
"customTask": {
"content": "<unknown>",
"error": "<string>"
},
"disqualifierSummary": {
"triggered": true,
"firstQuestion": "<string>",
"firstRationale": "<string>",
"totalCount": 123
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Qualify input
AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.
Example:
"agent_123"
Company domain to qualify
Example:
"example.com"
Company name to qualify
Runtime context for qualification
If true, returns full annotation data including metadata. If false or omitted (default), returns minimal annotations to reduce response size.
⌘I