Content Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/generate-content/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"email": "john.doe@example.com",
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"linkedInProfile": "<string>",
"crmContactId": "<string>",
"crmLeadId": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"persona": {
"oId": "pe_xxxxxxxxxxxxxxxxxxxxx"
},
"segment": {
"oId": "sg_xxxxxxxxxxxxxxxxxxxxx"
}
},
"agentOId": "ca_123",
"experimentOId": "ae_123",
"includeFullAnnotation": true
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/generate-content/run"
payload = {
"email": "john.doe@example.com",
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"linkedInProfile": "<string>",
"crmContactId": "<string>",
"crmLeadId": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"persona": { "oId": "pe_xxxxxxxxxxxxxxxxxxxxx" },
"segment": { "oId": "sg_xxxxxxxxxxxxxxxxxxxxx" }
},
"agentOId": "ca_123",
"experimentOId": "ae_123",
"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({
email: 'john.doe@example.com',
firstName: '<string>',
lastName: '<string>',
jobTitle: '<string>',
companyDomain: 'example.com',
companyName: '<string>',
linkedInProfile: '<string>',
crmContactId: '<string>',
crmLeadId: '<string>',
crmAccountId: '<string>',
runtimeContext: '<unknown>',
url: '<string>',
customContext: {
persona: {oId: 'pe_xxxxxxxxxxxxxxxxxxxxx'},
segment: {oId: 'sg_xxxxxxxxxxxxxxxxxxxxx'}
},
agentOId: 'ca_123',
experimentOId: 'ae_123',
includeFullAnnotation: true
})
};
fetch('https://app.octavehq.com/api/v2/agents/generate-content/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/generate-content/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([
'email' => 'john.doe@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'jobTitle' => '<string>',
'companyDomain' => 'example.com',
'companyName' => '<string>',
'linkedInProfile' => '<string>',
'crmContactId' => '<string>',
'crmLeadId' => '<string>',
'crmAccountId' => '<string>',
'runtimeContext' => '<unknown>',
'url' => '<string>',
'customContext' => [
'persona' => [
'oId' => 'pe_xxxxxxxxxxxxxxxxxxxxx'
],
'segment' => [
'oId' => 'sg_xxxxxxxxxxxxxxxxxxxxx'
]
],
'agentOId' => 'ca_123',
'experimentOId' => 'ae_123',
'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/generate-content/run"
payload := strings.NewReader("{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\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/generate-content/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\n \"includeFullAnnotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/generate-content/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 \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\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": {
"content": "<string>",
"jsonContent": {},
"product": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"solution": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"competitors": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"alternatives": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"buyingTriggers": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"coreFeatures": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"objections": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"evidence": [
"<string>"
]
}
],
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Agents
Content Agent
Provide either agentOId or experimentOId depending on what you want to run.
-
Use
agentOIdto run a specific agent. -
Use
experimentOIdto run a specific experiment.
Only one of them should be set at a time.
POST
/
api
/
v2
/
agents
/
generate-content
/
run
Content Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/generate-content/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"email": "john.doe@example.com",
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"linkedInProfile": "<string>",
"crmContactId": "<string>",
"crmLeadId": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"persona": {
"oId": "pe_xxxxxxxxxxxxxxxxxxxxx"
},
"segment": {
"oId": "sg_xxxxxxxxxxxxxxxxxxxxx"
}
},
"agentOId": "ca_123",
"experimentOId": "ae_123",
"includeFullAnnotation": true
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/generate-content/run"
payload = {
"email": "john.doe@example.com",
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"linkedInProfile": "<string>",
"crmContactId": "<string>",
"crmLeadId": "<string>",
"crmAccountId": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"persona": { "oId": "pe_xxxxxxxxxxxxxxxxxxxxx" },
"segment": { "oId": "sg_xxxxxxxxxxxxxxxxxxxxx" }
},
"agentOId": "ca_123",
"experimentOId": "ae_123",
"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({
email: 'john.doe@example.com',
firstName: '<string>',
lastName: '<string>',
jobTitle: '<string>',
companyDomain: 'example.com',
companyName: '<string>',
linkedInProfile: '<string>',
crmContactId: '<string>',
crmLeadId: '<string>',
crmAccountId: '<string>',
runtimeContext: '<unknown>',
url: '<string>',
customContext: {
persona: {oId: 'pe_xxxxxxxxxxxxxxxxxxxxx'},
segment: {oId: 'sg_xxxxxxxxxxxxxxxxxxxxx'}
},
agentOId: 'ca_123',
experimentOId: 'ae_123',
includeFullAnnotation: true
})
};
fetch('https://app.octavehq.com/api/v2/agents/generate-content/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/generate-content/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([
'email' => 'john.doe@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'jobTitle' => '<string>',
'companyDomain' => 'example.com',
'companyName' => '<string>',
'linkedInProfile' => '<string>',
'crmContactId' => '<string>',
'crmLeadId' => '<string>',
'crmAccountId' => '<string>',
'runtimeContext' => '<unknown>',
'url' => '<string>',
'customContext' => [
'persona' => [
'oId' => 'pe_xxxxxxxxxxxxxxxxxxxxx'
],
'segment' => [
'oId' => 'sg_xxxxxxxxxxxxxxxxxxxxx'
]
],
'agentOId' => 'ca_123',
'experimentOId' => 'ae_123',
'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/generate-content/run"
payload := strings.NewReader("{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\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/generate-content/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\n \"includeFullAnnotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/generate-content/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 \"email\": \"john.doe@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"companyDomain\": \"example.com\",\n \"companyName\": \"<string>\",\n \"linkedInProfile\": \"<string>\",\n \"crmContactId\": \"<string>\",\n \"crmLeadId\": \"<string>\",\n \"crmAccountId\": \"<string>\",\n \"runtimeContext\": \"<unknown>\",\n \"url\": \"<string>\",\n \"customContext\": {\n \"persona\": {\n \"oId\": \"pe_xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"segment\": {\n \"oId\": \"sg_xxxxxxxxxxxxxxxxxxxxx\"\n }\n },\n \"agentOId\": \"ca_123\",\n \"experimentOId\": \"ae_123\",\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": {
"content": "<string>",
"jsonContent": {},
"product": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"solution": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"competitors": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"alternatives": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"buyingTriggers": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"coreFeatures": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"objections": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"evidence": [
"<string>"
]
}
],
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Generate content input
Email of the person to generate content for
Example:
"john.doe@example.com"
First name of the person to generate content for
Job title of the person to generate content for
Company domain to generate content for
Example:
"example.com"
Company name to generate content for
LinkedIn profile of the person to generate content for
Runtime context
URL to generate content for
Pins specific library entities for this run, overriding the agent's configured selection. Each field takes the oId of an entity in your workspace, and that exact entity is used with no re-matching. On motion agents, playbook.oId must be an active motion playbook; if the agent is configured with a specific motion, the playbook must belong to that motion or the request fails with a 400. product/service pin the offering unless the resolved motion playbook supplies its own (reported as a run warning).
Show child attributes
Show child attributes
Example:
{
"persona": { "oId": "pe_xxxxxxxxxxxxxxxxxxxxx" },
"segment": { "oId": "sg_xxxxxxxxxxxxxxxxxxxxx" }
}
Available options:
JSON, TEXT, HTML, MARKDOWN, null AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.
Example:
"ca_123"
ExperimentOId is required when running an experiment
Example:
"ae_123"
If true, returns full annotation data including metadata. If false or omitted (default), returns minimal annotations to reduce response size.