Context Agent Run
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/context/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_abc123",
"runtimeContext": "How do you help with HIPAA compliance?",
"additionalContext": {
"person": {
"firstName": "John",
"lastName": "Doe",
"title": "CISO",
"email": "john.doe@healthcare.com"
},
"company": {
"name": "Healthcare Corp",
"domain": "healthcare.com"
},
"details": "Large healthcare provider in California"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/context/run"
payload = {
"agentOId": "agent_abc123",
"runtimeContext": "How do you help with HIPAA compliance?",
"additionalContext": {
"person": {
"firstName": "John",
"lastName": "Doe",
"title": "CISO",
"email": "john.doe@healthcare.com"
},
"company": {
"name": "Healthcare Corp",
"domain": "healthcare.com"
},
"details": "Large healthcare provider in California"
}
}
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_abc123',
runtimeContext: 'How do you help with HIPAA compliance?',
additionalContext: {
person: {
firstName: 'John',
lastName: 'Doe',
title: 'CISO',
email: 'john.doe@healthcare.com'
},
company: {name: 'Healthcare Corp', domain: 'healthcare.com'},
details: 'Large healthcare provider in California'
}
})
};
fetch('https://app.octavehq.com/api/v2/agents/context/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/context/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_abc123',
'runtimeContext' => 'How do you help with HIPAA compliance?',
'additionalContext' => [
'person' => [
'firstName' => 'John',
'lastName' => 'Doe',
'title' => 'CISO',
'email' => 'john.doe@healthcare.com'
],
'company' => [
'name' => 'Healthcare Corp',
'domain' => 'healthcare.com'
],
'details' => 'Large healthcare provider in California'
]
]),
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/context/run"
payload := strings.NewReader("{\n \"agentOId\": \"agent_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\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/context/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentOId\": \"agent_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/context/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_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\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,
"data": {
"documents": [
{
"id": "<string>",
"name": "<string>",
"data": {},
"score": 5,
"reasoning": "<string>"
}
],
"reasoning": "<string>"
},
"message": "Additional information"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Agents
Context Agent Run
Run a preset context agent by agentOId. The agent’s configuration (topK, rerank, sources, etc.) is loaded from the database. Runtime input only provides query and optional additionalContext.
POST
/
api
/
v2
/
agents
/
context
/
run
Context Agent Run
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/context/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_abc123",
"runtimeContext": "How do you help with HIPAA compliance?",
"additionalContext": {
"person": {
"firstName": "John",
"lastName": "Doe",
"title": "CISO",
"email": "john.doe@healthcare.com"
},
"company": {
"name": "Healthcare Corp",
"domain": "healthcare.com"
},
"details": "Large healthcare provider in California"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/agents/context/run"
payload = {
"agentOId": "agent_abc123",
"runtimeContext": "How do you help with HIPAA compliance?",
"additionalContext": {
"person": {
"firstName": "John",
"lastName": "Doe",
"title": "CISO",
"email": "john.doe@healthcare.com"
},
"company": {
"name": "Healthcare Corp",
"domain": "healthcare.com"
},
"details": "Large healthcare provider in California"
}
}
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_abc123',
runtimeContext: 'How do you help with HIPAA compliance?',
additionalContext: {
person: {
firstName: 'John',
lastName: 'Doe',
title: 'CISO',
email: 'john.doe@healthcare.com'
},
company: {name: 'Healthcare Corp', domain: 'healthcare.com'},
details: 'Large healthcare provider in California'
}
})
};
fetch('https://app.octavehq.com/api/v2/agents/context/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/context/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_abc123',
'runtimeContext' => 'How do you help with HIPAA compliance?',
'additionalContext' => [
'person' => [
'firstName' => 'John',
'lastName' => 'Doe',
'title' => 'CISO',
'email' => 'john.doe@healthcare.com'
],
'company' => [
'name' => 'Healthcare Corp',
'domain' => 'healthcare.com'
],
'details' => 'Large healthcare provider in California'
]
]),
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/context/run"
payload := strings.NewReader("{\n \"agentOId\": \"agent_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\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/context/run")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentOId\": \"agent_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/agents/context/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_abc123\",\n \"runtimeContext\": \"How do you help with HIPAA compliance?\",\n \"additionalContext\": {\n \"person\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"title\": \"CISO\",\n \"email\": \"john.doe@healthcare.com\"\n },\n \"company\": {\n \"name\": \"Healthcare Corp\",\n \"domain\": \"healthcare.com\"\n },\n \"details\": \"Large healthcare provider in California\"\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,
"data": {
"documents": [
{
"id": "<string>",
"name": "<string>",
"data": {},
"score": 5,
"reasoning": "<string>"
}
],
"reasoning": "<string>"
},
"message": "Additional information"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Context agent input (query + context)
Context agent input with query and optional context
Agent OId for preset context configuration
Example:
"agent_abc123"
Question or task to fetch context for
Minimum string length:
1Optional person/company/details to enhance search
Show child attributes
Show child attributes
Runtime context string — used as the query if 'query' is not provided. Consistent with other agent type APIs (email, content, enrich, etc.).
Minimum string length:
1⌘I