Generate Emails
curl --request POST \
--url https://app.octavehq.com/api/v2/async/headless/generate-emails \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"sequence": {
"steps": 4,
"length": "MIXED",
"type": "COLD_OUTBOUND",
"primaryGoal": "INITIATE_CONVERSATION",
"generateUniqueSubjectLines": true,
"additionalInstructions": "Additional instructions for the sequence",
"exampleForIntroEmail": "Example email for the first email in the sequence",
"exampleForFinalEmail": "Example email for the final email in the sequence",
"lang": "es",
"outputFormat": "text"
},
"offering": {
"url": "https://www.example.com",
"name": "Example product/service",
"coreValueProposition": "Example core value proposition",
"keyDifferentiator": "Example key differentiator",
"customerOutcomes": "Example customer outcomes",
"additionalOfferingInfo": "Example additional offer info"
},
"recipient": {
"firstName": "John",
"companyName": "Example company name",
"companyDomain": "example.com",
"jobTitle": "Example title",
"linkedInProfile": "https://www.linkedin.com/in/example",
"additionalRecipientInfo": "Example additional recipient info"
},
"callbackUrl": "https://example.com/api/callbacks/unique-id"
}
'import requests
url = "https://app.octavehq.com/api/v2/async/headless/generate-emails"
payload = {
"sequence": {
"steps": 4,
"length": "MIXED",
"type": "COLD_OUTBOUND",
"primaryGoal": "INITIATE_CONVERSATION",
"generateUniqueSubjectLines": True,
"additionalInstructions": "Additional instructions for the sequence",
"exampleForIntroEmail": "Example email for the first email in the sequence",
"exampleForFinalEmail": "Example email for the final email in the sequence",
"lang": "es",
"outputFormat": "text"
},
"offering": {
"url": "https://www.example.com",
"name": "Example product/service",
"coreValueProposition": "Example core value proposition",
"keyDifferentiator": "Example key differentiator",
"customerOutcomes": "Example customer outcomes",
"additionalOfferingInfo": "Example additional offer info"
},
"recipient": {
"firstName": "John",
"companyName": "Example company name",
"companyDomain": "example.com",
"jobTitle": "Example title",
"linkedInProfile": "https://www.linkedin.com/in/example",
"additionalRecipientInfo": "Example additional recipient info"
},
"callbackUrl": "https://example.com/api/callbacks/unique-id"
}
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({
sequence: {
steps: 4,
length: 'MIXED',
type: 'COLD_OUTBOUND',
primaryGoal: 'INITIATE_CONVERSATION',
generateUniqueSubjectLines: true,
additionalInstructions: 'Additional instructions for the sequence',
exampleForIntroEmail: 'Example email for the first email in the sequence',
exampleForFinalEmail: 'Example email for the final email in the sequence',
lang: 'es',
outputFormat: 'text'
},
offering: {
url: 'https://www.example.com',
name: 'Example product/service',
coreValueProposition: 'Example core value proposition',
keyDifferentiator: 'Example key differentiator',
customerOutcomes: 'Example customer outcomes',
additionalOfferingInfo: 'Example additional offer info'
},
recipient: {
firstName: 'John',
companyName: 'Example company name',
companyDomain: 'example.com',
jobTitle: 'Example title',
linkedInProfile: 'https://www.linkedin.com/in/example',
additionalRecipientInfo: 'Example additional recipient info'
},
callbackUrl: 'https://example.com/api/callbacks/unique-id'
})
};
fetch('https://app.octavehq.com/api/v2/async/headless/generate-emails', 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/async/headless/generate-emails",
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([
'sequence' => [
'steps' => 4,
'length' => 'MIXED',
'type' => 'COLD_OUTBOUND',
'primaryGoal' => 'INITIATE_CONVERSATION',
'generateUniqueSubjectLines' => true,
'additionalInstructions' => 'Additional instructions for the sequence',
'exampleForIntroEmail' => 'Example email for the first email in the sequence',
'exampleForFinalEmail' => 'Example email for the final email in the sequence',
'lang' => 'es',
'outputFormat' => 'text'
],
'offering' => [
'url' => 'https://www.example.com',
'name' => 'Example product/service',
'coreValueProposition' => 'Example core value proposition',
'keyDifferentiator' => 'Example key differentiator',
'customerOutcomes' => 'Example customer outcomes',
'additionalOfferingInfo' => 'Example additional offer info'
],
'recipient' => [
'firstName' => 'John',
'companyName' => 'Example company name',
'companyDomain' => 'example.com',
'jobTitle' => 'Example title',
'linkedInProfile' => 'https://www.linkedin.com/in/example',
'additionalRecipientInfo' => 'Example additional recipient info'
],
'callbackUrl' => 'https://example.com/api/callbacks/unique-id'
]),
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/async/headless/generate-emails"
payload := strings.NewReader("{\n \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\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/async/headless/generate-emails")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/async/headless/generate-emails")
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 \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\n}"
response = http.request(request)
puts response.read_body{
"status": "pending",
"requestId": "requestId",
"message": "Additional information"
}{
"status": "failed",
"message": "Invalid callback URL",
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}Async
Generate Emails
Generate Emails asynchronously - Headless
POST
/
api
/
v2
/
async
/
headless
/
generate-emails
Generate Emails
curl --request POST \
--url https://app.octavehq.com/api/v2/async/headless/generate-emails \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"sequence": {
"steps": 4,
"length": "MIXED",
"type": "COLD_OUTBOUND",
"primaryGoal": "INITIATE_CONVERSATION",
"generateUniqueSubjectLines": true,
"additionalInstructions": "Additional instructions for the sequence",
"exampleForIntroEmail": "Example email for the first email in the sequence",
"exampleForFinalEmail": "Example email for the final email in the sequence",
"lang": "es",
"outputFormat": "text"
},
"offering": {
"url": "https://www.example.com",
"name": "Example product/service",
"coreValueProposition": "Example core value proposition",
"keyDifferentiator": "Example key differentiator",
"customerOutcomes": "Example customer outcomes",
"additionalOfferingInfo": "Example additional offer info"
},
"recipient": {
"firstName": "John",
"companyName": "Example company name",
"companyDomain": "example.com",
"jobTitle": "Example title",
"linkedInProfile": "https://www.linkedin.com/in/example",
"additionalRecipientInfo": "Example additional recipient info"
},
"callbackUrl": "https://example.com/api/callbacks/unique-id"
}
'import requests
url = "https://app.octavehq.com/api/v2/async/headless/generate-emails"
payload = {
"sequence": {
"steps": 4,
"length": "MIXED",
"type": "COLD_OUTBOUND",
"primaryGoal": "INITIATE_CONVERSATION",
"generateUniqueSubjectLines": True,
"additionalInstructions": "Additional instructions for the sequence",
"exampleForIntroEmail": "Example email for the first email in the sequence",
"exampleForFinalEmail": "Example email for the final email in the sequence",
"lang": "es",
"outputFormat": "text"
},
"offering": {
"url": "https://www.example.com",
"name": "Example product/service",
"coreValueProposition": "Example core value proposition",
"keyDifferentiator": "Example key differentiator",
"customerOutcomes": "Example customer outcomes",
"additionalOfferingInfo": "Example additional offer info"
},
"recipient": {
"firstName": "John",
"companyName": "Example company name",
"companyDomain": "example.com",
"jobTitle": "Example title",
"linkedInProfile": "https://www.linkedin.com/in/example",
"additionalRecipientInfo": "Example additional recipient info"
},
"callbackUrl": "https://example.com/api/callbacks/unique-id"
}
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({
sequence: {
steps: 4,
length: 'MIXED',
type: 'COLD_OUTBOUND',
primaryGoal: 'INITIATE_CONVERSATION',
generateUniqueSubjectLines: true,
additionalInstructions: 'Additional instructions for the sequence',
exampleForIntroEmail: 'Example email for the first email in the sequence',
exampleForFinalEmail: 'Example email for the final email in the sequence',
lang: 'es',
outputFormat: 'text'
},
offering: {
url: 'https://www.example.com',
name: 'Example product/service',
coreValueProposition: 'Example core value proposition',
keyDifferentiator: 'Example key differentiator',
customerOutcomes: 'Example customer outcomes',
additionalOfferingInfo: 'Example additional offer info'
},
recipient: {
firstName: 'John',
companyName: 'Example company name',
companyDomain: 'example.com',
jobTitle: 'Example title',
linkedInProfile: 'https://www.linkedin.com/in/example',
additionalRecipientInfo: 'Example additional recipient info'
},
callbackUrl: 'https://example.com/api/callbacks/unique-id'
})
};
fetch('https://app.octavehq.com/api/v2/async/headless/generate-emails', 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/async/headless/generate-emails",
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([
'sequence' => [
'steps' => 4,
'length' => 'MIXED',
'type' => 'COLD_OUTBOUND',
'primaryGoal' => 'INITIATE_CONVERSATION',
'generateUniqueSubjectLines' => true,
'additionalInstructions' => 'Additional instructions for the sequence',
'exampleForIntroEmail' => 'Example email for the first email in the sequence',
'exampleForFinalEmail' => 'Example email for the final email in the sequence',
'lang' => 'es',
'outputFormat' => 'text'
],
'offering' => [
'url' => 'https://www.example.com',
'name' => 'Example product/service',
'coreValueProposition' => 'Example core value proposition',
'keyDifferentiator' => 'Example key differentiator',
'customerOutcomes' => 'Example customer outcomes',
'additionalOfferingInfo' => 'Example additional offer info'
],
'recipient' => [
'firstName' => 'John',
'companyName' => 'Example company name',
'companyDomain' => 'example.com',
'jobTitle' => 'Example title',
'linkedInProfile' => 'https://www.linkedin.com/in/example',
'additionalRecipientInfo' => 'Example additional recipient info'
],
'callbackUrl' => 'https://example.com/api/callbacks/unique-id'
]),
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/async/headless/generate-emails"
payload := strings.NewReader("{\n \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\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/async/headless/generate-emails")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/async/headless/generate-emails")
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 \"sequence\": {\n \"steps\": 4,\n \"length\": \"MIXED\",\n \"type\": \"COLD_OUTBOUND\",\n \"primaryGoal\": \"INITIATE_CONVERSATION\",\n \"generateUniqueSubjectLines\": true,\n \"additionalInstructions\": \"Additional instructions for the sequence\",\n \"exampleForIntroEmail\": \"Example email for the first email in the sequence\",\n \"exampleForFinalEmail\": \"Example email for the final email in the sequence\",\n \"lang\": \"es\",\n \"outputFormat\": \"text\"\n },\n \"offering\": {\n \"url\": \"https://www.example.com\",\n \"name\": \"Example product/service\",\n \"coreValueProposition\": \"Example core value proposition\",\n \"keyDifferentiator\": \"Example key differentiator\",\n \"customerOutcomes\": \"Example customer outcomes\",\n \"additionalOfferingInfo\": \"Example additional offer info\"\n },\n \"recipient\": {\n \"firstName\": \"John\",\n \"companyName\": \"Example company name\",\n \"companyDomain\": \"example.com\",\n \"jobTitle\": \"Example title\",\n \"linkedInProfile\": \"https://www.linkedin.com/in/example\",\n \"additionalRecipientInfo\": \"Example additional recipient info\"\n },\n \"callbackUrl\": \"https://example.com/api/callbacks/unique-id\"\n}"
response = http.request(request)
puts response.read_body{
"status": "pending",
"requestId": "requestId",
"message": "Additional information"
}{
"status": "failed",
"message": "Invalid callback URL",
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}Authorizations
Headers
Optional header used to identify the source of the request. Helps us apply appropriate rate limiting or disable it when necessary.
Example:
"some-source"
External Request ID. Add this header to identify the request from the client for better tracking and debugging.
Example:
"external-request-id"
Body
application/json