List Custom Extractors
curl --request GET \
--url https://app.octavehq.com/api/v2/custom-extractor/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/list"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/custom-extractor/list', 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/custom-extractor/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/custom-extractor/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/custom-extractor/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"data": [
{
"name": "<string>",
"prompt": "<string>",
"eventTypes": [
"EMAIL_SENT"
],
"modelTier": "NOTE",
"status": "DRAFT",
"oId": "<string>",
"promptVersion": 123,
"source": "WORKSPACE",
"mappingStatus": "PENDING",
"associatedLibraryTables": [
"persona"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"executionScope": {
"phase": "EXTRACTION",
"extractionKeys": [
"<string>"
],
"deferredKeys": [
"<string>"
],
"unsupportedKeys": [
"<string>"
]
},
"description": "<string>",
"authoringInput": "<string>",
"eventFilters": {
"match": {
"entityMatchAll": true,
"eventOIds": [
"<string>"
],
"opportunityIds": [
"<string>"
],
"eventCategories": [
"EMAIL"
],
"eventTypes": [
"EMAIL_SENT"
],
"sentiments": [
"POSITIVE"
],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [
"OPEN"
],
"opportunityStatuses": [
"OPEN"
],
"dealMotions": [
"NET_NEW"
],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"dealStagesAtEvent": [
"<string>"
],
"pipelinePhases": [
"prospecting"
],
"crmPipelines": [
"<string>"
],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [
"NET_NEW"
],
"customerScope": "ALL",
"callPurposes": [
"DISCOVERY"
],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [
"EMAIL"
],
"eventTypes": [
"EMAIL_SENT"
],
"sentiments": [
"POSITIVE"
],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [
"OPEN"
],
"opportunityStatuses": [
"OPEN"
],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [
"NET_NEW"
],
"callPurposes": [
"DISCOVERY"
],
"dealMotions": [
"NET_NEW"
],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"pipelinePhases": [
"prospecting"
]
}
},
"outputMode": "freeform",
"classes": [
{
"value": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"numberConfig": {
"unit": "<string>",
"min": 123,
"max": 123
},
"jsonSchema": {},
"resultCardinality": "single",
"perspective": "EXTERNAL",
"fieldTargets": [],
"mappingProposal": {
"libraryTables": [
{
"table": "persona",
"rationale": "<string>"
}
]
},
"mappingModel": "<string>",
"user": {
"oId": "<string>",
"email": "<string>"
}
}
],
"total": 123
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Custom Extractors
List Custom Extractors
List the workspace’s custom finding extractors with full definitions (prompt, filters, anchors, status, mapping proposal). Requires the custom-extractors entitlement.
GET
/
api
/
v2
/
custom-extractor
/
list
List Custom Extractors
curl --request GET \
--url https://app.octavehq.com/api/v2/custom-extractor/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/list"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/custom-extractor/list', 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/custom-extractor/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/custom-extractor/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/custom-extractor/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"data": [
{
"name": "<string>",
"prompt": "<string>",
"eventTypes": [
"EMAIL_SENT"
],
"modelTier": "NOTE",
"status": "DRAFT",
"oId": "<string>",
"promptVersion": 123,
"source": "WORKSPACE",
"mappingStatus": "PENDING",
"associatedLibraryTables": [
"persona"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"executionScope": {
"phase": "EXTRACTION",
"extractionKeys": [
"<string>"
],
"deferredKeys": [
"<string>"
],
"unsupportedKeys": [
"<string>"
]
},
"description": "<string>",
"authoringInput": "<string>",
"eventFilters": {
"match": {
"entityMatchAll": true,
"eventOIds": [
"<string>"
],
"opportunityIds": [
"<string>"
],
"eventCategories": [
"EMAIL"
],
"eventTypes": [
"EMAIL_SENT"
],
"sentiments": [
"POSITIVE"
],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [
"OPEN"
],
"opportunityStatuses": [
"OPEN"
],
"dealMotions": [
"NET_NEW"
],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"dealStagesAtEvent": [
"<string>"
],
"pipelinePhases": [
"prospecting"
],
"crmPipelines": [
"<string>"
],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [
"NET_NEW"
],
"customerScope": "ALL",
"callPurposes": [
"DISCOVERY"
],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [
"EMAIL"
],
"eventTypes": [
"EMAIL_SENT"
],
"sentiments": [
"POSITIVE"
],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [
"OPEN"
],
"opportunityStatuses": [
"OPEN"
],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [
"NET_NEW"
],
"callPurposes": [
"DISCOVERY"
],
"dealMotions": [
"NET_NEW"
],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"pipelinePhases": [
"prospecting"
]
}
},
"outputMode": "freeform",
"classes": [
{
"value": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"numberConfig": {
"unit": "<string>",
"min": 123,
"max": 123
},
"jsonSchema": {},
"resultCardinality": "single",
"perspective": "EXTERNAL",
"fieldTargets": [],
"mappingProposal": {
"libraryTables": [
{
"table": "persona",
"rationale": "<string>"
}
]
},
"mappingModel": "<string>",
"user": {
"oId": "<string>",
"email": "<string>"
}
}
],
"total": 123
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Query Parameters
Maximum number of results to return (default: 25, max: 100)
Required range:
1 <= x <= 100Number of results to skip
Required range:
x >= 0Optional lifecycle-status filter (DRAFT/ACTIVE/PAUSED/ARCHIVED)
Available options:
DRAFT, ACTIVE, PAUSED, ARCHIVED