Create Research Job
curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/research \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-selected-account-id: <api-key>' \
--data '
{
"advanced": {
"decomposition": {
"model": "openai/gpt-5.4",
"prompt": "PROMPT_DECOMPOSITION",
"reasoning": {
"effort": "high"
},
"temperature": 0
},
"spreadsheet": {
"max_hops": 12,
"model": "openai/gpt-5.3-codex",
"rules": "For sheets over 10k rows, summarise instead of printing."
},
"subtasks": {
"model": "openai/gpt-5.3-codex",
"prompt": "PROMPT_SUBTASKS",
"temperature": 0
}
},
"inputs": {
"parse_results": [
"pres_9f86d081884c7d659a2feaa0c55ad015"
],
"vector_stores": [
"vector_store_9f86d081884c7d659a2feaa0c55ad015"
]
},
"model": "openai/gpt-5.4",
"task": {
"description": "What is the Commencement Date of the document?",
"output_schema": {
"properties": {
"commencement_date": {
"description": "The Commencement Date",
"type": "string"
}
},
"type": "object"
},
"plan": "1. Find the Start Date\n2. Search for Commencement Date"
},
"tools": {
"lexical_search": {
"config": {},
"enabled": false
},
"similarity_search": {
"config": {
"filters": {
"file_id": {
"$eq": "file_9f86d081884c7d659a2feaa0c55ad015"
}
},
"top_k": 5
},
"enabled": true
}
}
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/research"
payload = {
"advanced": {
"decomposition": {
"model": "openai/gpt-5.4",
"prompt": "PROMPT_DECOMPOSITION",
"reasoning": { "effort": "high" },
"temperature": 0
},
"spreadsheet": {
"max_hops": 12,
"model": "openai/gpt-5.3-codex",
"rules": "For sheets over 10k rows, summarise instead of printing."
},
"subtasks": {
"model": "openai/gpt-5.3-codex",
"prompt": "PROMPT_SUBTASKS",
"temperature": 0
}
},
"inputs": {
"parse_results": ["pres_9f86d081884c7d659a2feaa0c55ad015"],
"vector_stores": ["vector_store_9f86d081884c7d659a2feaa0c55ad015"]
},
"model": "openai/gpt-5.4",
"task": {
"description": "What is the Commencement Date of the document?",
"output_schema": {
"properties": { "commencement_date": {
"description": "The Commencement Date",
"type": "string"
} },
"type": "object"
},
"plan": "1. Find the Start Date
2. Search for Commencement Date"
},
"tools": {
"lexical_search": {
"config": {},
"enabled": False
},
"similarity_search": {
"config": {
"filters": { "file_id": { "$eq": "file_9f86d081884c7d659a2feaa0c55ad015" } },
"top_k": 5
},
"enabled": True
}
}
}
headers = {
"x-api-key": "<api-key>",
"x-selected-account-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-selected-account-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
advanced: {
decomposition: {
model: 'openai/gpt-5.4',
prompt: 'PROMPT_DECOMPOSITION',
reasoning: {effort: 'high'},
temperature: 0
},
spreadsheet: {
max_hops: 12,
model: 'openai/gpt-5.3-codex',
rules: 'For sheets over 10k rows, summarise instead of printing.'
},
subtasks: {model: 'openai/gpt-5.3-codex', prompt: 'PROMPT_SUBTASKS', temperature: 0}
},
inputs: {
parse_results: ['pres_9f86d081884c7d659a2feaa0c55ad015'],
vector_stores: ['vector_store_9f86d081884c7d659a2feaa0c55ad015']
},
model: 'openai/gpt-5.4',
task: {
description: 'What is the Commencement Date of the document?',
output_schema: {
properties: {commencement_date: {description: 'The Commencement Date', type: 'string'}},
type: 'object'
},
plan: '1. Find the Start Date\n2. Search for Commencement Date'
},
tools: {
lexical_search: {config: {}, enabled: false},
similarity_search: {
config: {filters: {file_id: {$eq: 'file_9f86d081884c7d659a2feaa0c55ad015'}}, top_k: 5},
enabled: true
}
}
})
};
fetch('https://api.example.com/v1/projects/{project_id}/research', 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://api.example.com/v1/projects/{project_id}/research",
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([
'advanced' => [
'decomposition' => [
'model' => 'openai/gpt-5.4',
'prompt' => 'PROMPT_DECOMPOSITION',
'reasoning' => [
'effort' => 'high'
],
'temperature' => 0
],
'spreadsheet' => [
'max_hops' => 12,
'model' => 'openai/gpt-5.3-codex',
'rules' => 'For sheets over 10k rows, summarise instead of printing.'
],
'subtasks' => [
'model' => 'openai/gpt-5.3-codex',
'prompt' => 'PROMPT_SUBTASKS',
'temperature' => 0
]
],
'inputs' => [
'parse_results' => [
'pres_9f86d081884c7d659a2feaa0c55ad015'
],
'vector_stores' => [
'vector_store_9f86d081884c7d659a2feaa0c55ad015'
]
],
'model' => 'openai/gpt-5.4',
'task' => [
'description' => 'What is the Commencement Date of the document?',
'output_schema' => [
'properties' => [
'commencement_date' => [
'description' => 'The Commencement Date',
'type' => 'string'
]
],
'type' => 'object'
],
'plan' => '1. Find the Start Date
2. Search for Commencement Date'
],
'tools' => [
'lexical_search' => [
'config' => [
],
'enabled' => false
],
'similarity_search' => [
'config' => [
'filters' => [
'file_id' => [
'$eq' => 'file_9f86d081884c7d659a2feaa0c55ad015'
]
],
'top_k' => 5
],
'enabled' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-selected-account-id: <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://api.example.com/v1/projects/{project_id}/research"
payload := strings.NewReader("{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-selected-account-id", "<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://api.example.com/v1/projects/{project_id}/research")
.header("x-api-key", "<api-key>")
.header("x-selected-account-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/research")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"project_id": "<string>",
"operation": "parse",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"object": "job",
"source_id": "<string>",
"correlation_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"result": {},
"progress": {
"total": 123,
"succeeded": 123,
"failed": 123,
"cancelled": 123,
"pending": 123,
"child_jobs": [
{
"source_document_id": "<string>",
"job_id": "<string>",
"status": "pending",
"parse_result_id": "<string>",
"error": "<string>"
}
]
},
"error": "<string>",
"history": [
{
"step": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"status": "<string>",
"details": {}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Research
Create Research Job
Kick off a Dex Research job.
Persists a research job and starts :class:~dex_api.temporal.research.workflows.research_workflow.ResearchWorkflow
on the research task queue.
Scope: one inputs.vector_stores id, or one or more inputs.parse_results ids
(no mixing with vector stores). Empty inputs: if the project has exactly one vector store,
that store is used automatically (empty-input shortcut).
POST
/
v1
/
projects
/
{project_id}
/
research
Create Research Job
curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/research \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-selected-account-id: <api-key>' \
--data '
{
"advanced": {
"decomposition": {
"model": "openai/gpt-5.4",
"prompt": "PROMPT_DECOMPOSITION",
"reasoning": {
"effort": "high"
},
"temperature": 0
},
"spreadsheet": {
"max_hops": 12,
"model": "openai/gpt-5.3-codex",
"rules": "For sheets over 10k rows, summarise instead of printing."
},
"subtasks": {
"model": "openai/gpt-5.3-codex",
"prompt": "PROMPT_SUBTASKS",
"temperature": 0
}
},
"inputs": {
"parse_results": [
"pres_9f86d081884c7d659a2feaa0c55ad015"
],
"vector_stores": [
"vector_store_9f86d081884c7d659a2feaa0c55ad015"
]
},
"model": "openai/gpt-5.4",
"task": {
"description": "What is the Commencement Date of the document?",
"output_schema": {
"properties": {
"commencement_date": {
"description": "The Commencement Date",
"type": "string"
}
},
"type": "object"
},
"plan": "1. Find the Start Date\n2. Search for Commencement Date"
},
"tools": {
"lexical_search": {
"config": {},
"enabled": false
},
"similarity_search": {
"config": {
"filters": {
"file_id": {
"$eq": "file_9f86d081884c7d659a2feaa0c55ad015"
}
},
"top_k": 5
},
"enabled": true
}
}
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/research"
payload = {
"advanced": {
"decomposition": {
"model": "openai/gpt-5.4",
"prompt": "PROMPT_DECOMPOSITION",
"reasoning": { "effort": "high" },
"temperature": 0
},
"spreadsheet": {
"max_hops": 12,
"model": "openai/gpt-5.3-codex",
"rules": "For sheets over 10k rows, summarise instead of printing."
},
"subtasks": {
"model": "openai/gpt-5.3-codex",
"prompt": "PROMPT_SUBTASKS",
"temperature": 0
}
},
"inputs": {
"parse_results": ["pres_9f86d081884c7d659a2feaa0c55ad015"],
"vector_stores": ["vector_store_9f86d081884c7d659a2feaa0c55ad015"]
},
"model": "openai/gpt-5.4",
"task": {
"description": "What is the Commencement Date of the document?",
"output_schema": {
"properties": { "commencement_date": {
"description": "The Commencement Date",
"type": "string"
} },
"type": "object"
},
"plan": "1. Find the Start Date
2. Search for Commencement Date"
},
"tools": {
"lexical_search": {
"config": {},
"enabled": False
},
"similarity_search": {
"config": {
"filters": { "file_id": { "$eq": "file_9f86d081884c7d659a2feaa0c55ad015" } },
"top_k": 5
},
"enabled": True
}
}
}
headers = {
"x-api-key": "<api-key>",
"x-selected-account-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-selected-account-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
advanced: {
decomposition: {
model: 'openai/gpt-5.4',
prompt: 'PROMPT_DECOMPOSITION',
reasoning: {effort: 'high'},
temperature: 0
},
spreadsheet: {
max_hops: 12,
model: 'openai/gpt-5.3-codex',
rules: 'For sheets over 10k rows, summarise instead of printing.'
},
subtasks: {model: 'openai/gpt-5.3-codex', prompt: 'PROMPT_SUBTASKS', temperature: 0}
},
inputs: {
parse_results: ['pres_9f86d081884c7d659a2feaa0c55ad015'],
vector_stores: ['vector_store_9f86d081884c7d659a2feaa0c55ad015']
},
model: 'openai/gpt-5.4',
task: {
description: 'What is the Commencement Date of the document?',
output_schema: {
properties: {commencement_date: {description: 'The Commencement Date', type: 'string'}},
type: 'object'
},
plan: '1. Find the Start Date\n2. Search for Commencement Date'
},
tools: {
lexical_search: {config: {}, enabled: false},
similarity_search: {
config: {filters: {file_id: {$eq: 'file_9f86d081884c7d659a2feaa0c55ad015'}}, top_k: 5},
enabled: true
}
}
})
};
fetch('https://api.example.com/v1/projects/{project_id}/research', 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://api.example.com/v1/projects/{project_id}/research",
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([
'advanced' => [
'decomposition' => [
'model' => 'openai/gpt-5.4',
'prompt' => 'PROMPT_DECOMPOSITION',
'reasoning' => [
'effort' => 'high'
],
'temperature' => 0
],
'spreadsheet' => [
'max_hops' => 12,
'model' => 'openai/gpt-5.3-codex',
'rules' => 'For sheets over 10k rows, summarise instead of printing.'
],
'subtasks' => [
'model' => 'openai/gpt-5.3-codex',
'prompt' => 'PROMPT_SUBTASKS',
'temperature' => 0
]
],
'inputs' => [
'parse_results' => [
'pres_9f86d081884c7d659a2feaa0c55ad015'
],
'vector_stores' => [
'vector_store_9f86d081884c7d659a2feaa0c55ad015'
]
],
'model' => 'openai/gpt-5.4',
'task' => [
'description' => 'What is the Commencement Date of the document?',
'output_schema' => [
'properties' => [
'commencement_date' => [
'description' => 'The Commencement Date',
'type' => 'string'
]
],
'type' => 'object'
],
'plan' => '1. Find the Start Date
2. Search for Commencement Date'
],
'tools' => [
'lexical_search' => [
'config' => [
],
'enabled' => false
],
'similarity_search' => [
'config' => [
'filters' => [
'file_id' => [
'$eq' => 'file_9f86d081884c7d659a2feaa0c55ad015'
]
],
'top_k' => 5
],
'enabled' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-selected-account-id: <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://api.example.com/v1/projects/{project_id}/research"
payload := strings.NewReader("{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-selected-account-id", "<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://api.example.com/v1/projects/{project_id}/research")
.header("x-api-key", "<api-key>")
.header("x-selected-account-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/research")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"advanced\": {\n \"decomposition\": {\n \"model\": \"openai/gpt-5.4\",\n \"prompt\": \"PROMPT_DECOMPOSITION\",\n \"reasoning\": {\n \"effort\": \"high\"\n },\n \"temperature\": 0\n },\n \"spreadsheet\": {\n \"max_hops\": 12,\n \"model\": \"openai/gpt-5.3-codex\",\n \"rules\": \"For sheets over 10k rows, summarise instead of printing.\"\n },\n \"subtasks\": {\n \"model\": \"openai/gpt-5.3-codex\",\n \"prompt\": \"PROMPT_SUBTASKS\",\n \"temperature\": 0\n }\n },\n \"inputs\": {\n \"parse_results\": [\n \"pres_9f86d081884c7d659a2feaa0c55ad015\"\n ],\n \"vector_stores\": [\n \"vector_store_9f86d081884c7d659a2feaa0c55ad015\"\n ]\n },\n \"model\": \"openai/gpt-5.4\",\n \"task\": {\n \"description\": \"What is the Commencement Date of the document?\",\n \"output_schema\": {\n \"properties\": {\n \"commencement_date\": {\n \"description\": \"The Commencement Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"plan\": \"1. Find the Start Date\\n2. Search for Commencement Date\"\n },\n \"tools\": {\n \"lexical_search\": {\n \"config\": {},\n \"enabled\": false\n },\n \"similarity_search\": {\n \"config\": {\n \"filters\": {\n \"file_id\": {\n \"$eq\": \"file_9f86d081884c7d659a2feaa0c55ad015\"\n }\n },\n \"top_k\": 5\n },\n \"enabled\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"project_id": "<string>",
"operation": "parse",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"object": "job",
"source_id": "<string>",
"correlation_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"result": {},
"progress": {
"total": 123,
"succeeded": 123,
"failed": 123,
"cancelled": 123,
"pending": 123,
"child_jobs": [
{
"source_document_id": "<string>",
"job_id": "<string>",
"status": "pending",
"parse_result_id": "<string>",
"error": "<string>"
}
]
},
"error": "<string>",
"history": [
{
"step": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"status": "<string>",
"details": {}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key for authentication
Selected Account ID
Path Parameters
Body
application/json
Kickoff body for POST /v1/projects/{project_id}/research.
Use tools for per-tool enablement and configuration (same map shape as
:class:~dex_core.models.extraction.ExtractionParameters.agentic_tools on extract jobs).
User task: goal, optional plan, and structured or report-shaped output.
Show child attributes
Show child attributes
Default model for all agent steps unless overridden in advanced
Explicit scope. Empty lists: the API resolves to the project's sole vector store when exactly one exists; otherwise set vector_stores or parse_results explicitly.
Show child attributes
Show child attributes
Map tool name → enablement + config
Show child attributes
Show child attributes
Per-stage model/prompt/temperature/reasoning overrides
Show child attributes
Show child attributes
When True, DECOMPOSE tool hints for dependent subtasks are executed as warm-start searches (same semantics as extract execute_dependent_subtask_tool_hints). Default False (intent-only hints for dependents).
When True, the agent may cite specific table cells/rows/ranges (block_ref#loc), resolved to sub-bboxes when the table was parsed with substructure recognition. Default False — whole-table citations only (previous behavior).
Whether the document file tree is embedded in the extraction prompt. 'auto' (default) keeps existing behavior: omitted when a file-system index is configured (index tools browse the tree instead), else the full tree ('all'). 'all' = every file path; 'folders' = folder structure only; 'none' = omit the tree entirely. Set 'none' to avoid spending tokens on hundreds of unhelpful file names.
Available options:
auto, all, folders, none Response
Successful Response
Job response model representing an asynchronous operation.
ID of the entity
ID of the project
Operation type (e.g., 'parse')
Available options:
parse, batch_parse, extract, research, vector_store, chunk, summarization, create_index, update_index Current job status
Available options:
pending, running, succeeded, partially_succeeded, failed, cancelled When the job was created
Allowed value:
"job"Source document/file ID
Request correlation ID for tracing
When the job started processing
When the job completed
Job result payload when completed
Live progress payload (used by batch jobs)
Show child attributes
Show child attributes
Error message if job failed
Timeline of job execution events
Show child attributes
Show child attributes