curl --request POST \
--url https://tako.com/api/v1/agent/company/runs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_indexes": [
"data"
],
"cards": true,
"locale": "en-US",
"timezone": "<string>",
"output_settings": {
"image_dark_mode": true
}
}
'import requests
url = "https://tako.com/api/v1/agent/company/runs"
payload = {
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_indexes": ["data"],
"cards": True,
"locale": "en-US",
"timezone": "<string>",
"output_settings": { "image_dark_mode": True }
}
headers = {
"X-API-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'Directors of publicly traded US banks',
thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_indexes: ['data'],
cards: true,
locale: 'en-US',
timezone: '<string>',
output_settings: {image_dark_mode: true}
})
};
fetch('https://tako.com/api/v1/agent/company/runs', 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://tako.com/api/v1/agent/company/runs",
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([
'query' => 'Directors of publicly traded US banks',
'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_indexes' => [
'data'
],
'cards' => true,
'locale' => 'en-US',
'timezone' => '<string>',
'output_settings' => [
'image_dark_mode' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://tako.com/api/v1/agent/company/runs"
payload := strings.NewReader("{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://tako.com/api/v1/agent/company/runs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tako.com/api/v1/agent/company/runs")
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["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"run_id": "<string>",
"status": "queued",
"created_at": "<string>",
"object": "agent.company.run",
"thread_id": "<string>",
"completed_at": "<string>",
"result": {
"answer": "<string>",
"cards": [
{
"card_id": "<string>",
"title": "<string>",
"description": "<string>",
"semantic_description": "<string>",
"webpage_url": "<string>",
"image_url": "<string>",
"embed_url": "<string>",
"sources": [
{
"source_index": "data",
"source_name": "S&P Global",
"source_description": "<string>",
"url": "https://xignite.com",
"source_text": "<string>"
}
],
"methodologies": [
{
"methodology_name": "Where the Data Comes From - S&P Global",
"methodology_description": "Financial metrics standardized by S&P Global from company regulatory filings, press releases, and restatements."
}
],
"source_indexes": [
"data"
],
"card_type": "<string>",
"relevance": "High",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
},
"exportable": false,
"relevance_score": 123,
"nodes": [
{
"id": "<string>",
"type": "metric",
"name": "<string>",
"description": "<string>"
}
],
"metric_definitions": [
{
"name": "Gross Domestic Product (current US$)",
"definition": "<string>"
}
],
"data_freshness": {
"coverage_end": "2026",
"data_as_of": "2026-10-01",
"last_updated": "2026-07-14"
},
"placeholder": {
"withheld_source": "<string>"
}
}
],
"citations": [
{
"index": 123,
"title": "<string>",
"url": "<string>",
"source_name": "<string>",
"source_index": "data",
"excerpt": "<string>",
"publish_date": "<string>",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
}
}
],
"metadata": {
"citations": [
{
"index": 123,
"title": "<string>",
"url": "<string>",
"source_name": "<string>",
"source_index": "data",
"excerpt": "<string>",
"publish_date": "<string>",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
}
}
],
"definitions": [
{
"term": "<string>",
"definition": "<string>",
"source_ref": 123
}
],
"assumptions": [
{
"title": "<string>",
"description": "<string>",
"category": "<string>",
"source_ref": 123
}
],
"methodology": [
{
"title": "<string>",
"description": "<string>"
}
]
},
"structured_output": {},
"structured_output_status": "complete",
"structured_output_citations": {},
"unfilled_fields": [
"<string>"
],
"structured_output_error": {
"code": "<string>",
"message": "<string>"
},
"refusal_code": "<string>",
"request_id": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
},
"usage": {
"total_cost_usd": 123,
"compute": {
"cost_usd": 123
},
"data": {
"cost_usd": 123,
"datasets": 123,
"data_points": 123
},
"variable_cost": {
"cost_usd": 123
}
},
"request": {
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effort": "low",
"source_indexes": [
"data"
],
"cards": true,
"locale": "en-US",
"timezone": "<string>",
"output_settings": {
"image_dark_mode": true
}
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"error_message": "<string>",
"error_type": "RATE_LIMIT_EXCEEDED"
}{
"code": "<string>",
"message": "<string>"
}Dispatch a Company Agent run
Dispatch a Company Agent run, which builds lists of companies and the people at them
curl --request POST \
--url https://tako.com/api/v1/agent/company/runs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_indexes": [
"data"
],
"cards": true,
"locale": "en-US",
"timezone": "<string>",
"output_settings": {
"image_dark_mode": true
}
}
'import requests
url = "https://tako.com/api/v1/agent/company/runs"
payload = {
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_indexes": ["data"],
"cards": True,
"locale": "en-US",
"timezone": "<string>",
"output_settings": { "image_dark_mode": True }
}
headers = {
"X-API-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'Directors of publicly traded US banks',
thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_indexes: ['data'],
cards: true,
locale: 'en-US',
timezone: '<string>',
output_settings: {image_dark_mode: true}
})
};
fetch('https://tako.com/api/v1/agent/company/runs', 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://tako.com/api/v1/agent/company/runs",
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([
'query' => 'Directors of publicly traded US banks',
'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_indexes' => [
'data'
],
'cards' => true,
'locale' => 'en-US',
'timezone' => '<string>',
'output_settings' => [
'image_dark_mode' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://tako.com/api/v1/agent/company/runs"
payload := strings.NewReader("{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://tako.com/api/v1/agent/company/runs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tako.com/api/v1/agent/company/runs")
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["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"Directors of publicly traded US banks\",\n \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_indexes\": [\n \"data\"\n ],\n \"cards\": true,\n \"locale\": \"en-US\",\n \"timezone\": \"<string>\",\n \"output_settings\": {\n \"image_dark_mode\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"run_id": "<string>",
"status": "queued",
"created_at": "<string>",
"object": "agent.company.run",
"thread_id": "<string>",
"completed_at": "<string>",
"result": {
"answer": "<string>",
"cards": [
{
"card_id": "<string>",
"title": "<string>",
"description": "<string>",
"semantic_description": "<string>",
"webpage_url": "<string>",
"image_url": "<string>",
"embed_url": "<string>",
"sources": [
{
"source_index": "data",
"source_name": "S&P Global",
"source_description": "<string>",
"url": "https://xignite.com",
"source_text": "<string>"
}
],
"methodologies": [
{
"methodology_name": "Where the Data Comes From - S&P Global",
"methodology_description": "Financial metrics standardized by S&P Global from company regulatory filings, press releases, and restatements."
}
],
"source_indexes": [
"data"
],
"card_type": "<string>",
"relevance": "High",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
},
"exportable": false,
"relevance_score": 123,
"nodes": [
{
"id": "<string>",
"type": "metric",
"name": "<string>",
"description": "<string>"
}
],
"metric_definitions": [
{
"name": "Gross Domestic Product (current US$)",
"definition": "<string>"
}
],
"data_freshness": {
"coverage_end": "2026",
"data_as_of": "2026-10-01",
"last_updated": "2026-07-14"
},
"placeholder": {
"withheld_source": "<string>"
}
}
],
"citations": [
{
"index": 123,
"title": "<string>",
"url": "<string>",
"source_name": "<string>",
"source_index": "data",
"excerpt": "<string>",
"publish_date": "<string>",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
}
}
],
"metadata": {
"citations": [
{
"index": 123,
"title": "<string>",
"url": "<string>",
"source_name": "<string>",
"source_index": "data",
"excerpt": "<string>",
"publish_date": "<string>",
"content": {
"content_format": "csv",
"cost": 0,
"data": "<string>",
"records": [
{}
],
"dataset": {
"columns": [
{
"name": "<string>",
"type": "string",
"unit": "<string>"
}
],
"rows": [
[
"<string>"
]
],
"total_rows": 123,
"truncated": true,
"ref": "<string>",
"sources": [
{
"name": "<string>",
"index": "data"
}
],
"provenance": "query",
"redacted_cells": {}
},
"card_data": {},
"card_data_schema": {},
"url": "<string>",
"expires_at": "<string>",
"total_rows": 123,
"total_matching": 123,
"truncated": false,
"export_pricing": {
"baseline_usd": 123,
"row_cpm_usd": 123,
"max_rows_ceiling": 123,
"premium_row_cpm_usd": {},
"free_rows": 0,
"variable_cost_max_usd": 123
},
"manifest": [
{
"name": "<string>",
"metric": "<string>",
"entity": "<string>",
"unit": "<string>",
"dtype": "string",
"premium_class": "person_contact"
}
],
"premium": false,
"premium_rows": {},
"redacted_cells": {}
}
}
],
"definitions": [
{
"term": "<string>",
"definition": "<string>",
"source_ref": 123
}
],
"assumptions": [
{
"title": "<string>",
"description": "<string>",
"category": "<string>",
"source_ref": 123
}
],
"methodology": [
{
"title": "<string>",
"description": "<string>"
}
]
},
"structured_output": {},
"structured_output_status": "complete",
"structured_output_citations": {},
"unfilled_fields": [
"<string>"
],
"structured_output_error": {
"code": "<string>",
"message": "<string>"
},
"refusal_code": "<string>",
"request_id": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
},
"usage": {
"total_cost_usd": 123,
"compute": {
"cost_usd": 123
},
"data": {
"cost_usd": 123,
"datasets": 123,
"data_points": 123
},
"variable_cost": {
"cost_usd": 123
}
},
"request": {
"query": "Directors of publicly traded US banks",
"thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effort": "low",
"source_indexes": [
"data"
],
"cards": true,
"locale": "en-US",
"timezone": "<string>",
"output_settings": {
"image_dark_mode": true
}
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"error_message": "<string>",
"error_type": "RATE_LIMIT_EXCEEDED"
}{
"code": "<string>",
"message": "<string>"
}answer.
See the Company Agent guide for examples, effort tiers, contacts and threads.
Notes
- To authenticate, send your Tako API key in the
X-API-Keyheader. Store it as an environment variable rather than hardcoding it. - The agent is asynchronous: this endpoint returns
202with aCompanyAgentRunwhosestatusisqueued. Poll Poll a Company Agent run untilstatusiscompletedorfailed. - To stream progress live instead of polling, send
Accept: text/event-stream. The response is then a Server-Sent Events stream ofRetrievalAgentStreamEnvelopeevents. - The Company Agent doesn’t take an
output_schema. A request that sends one returns400. To get a list’s rows, export its card through Contents.
Effort
effort is low, medium (the default) or high. low answers from company registries and the web only. It screens companies by status, incorporation date, location and industry, and it can’t rank or filter by financial metrics. medium and high can, and high takes longer. A thread keeps its effort: a follow-up with a different effort returns 409 effort_mismatch.
Contacts
People lists carry work emails and phone numbers as locked columns. Export the card through Contents withpremium set to true to reveal them. That export bills each revealed record at its premium rate.
Continuing a thread
Pass thethread_id from a prior run to ask a follow-up in the same conversation. Omit it to start a new thread. A thread is pinned to the Company Agent, one set of source_indexes and one effort.Authorizations
Body
Request body for POST /v1/agent/company/runs.
Natural-language company or people research request for the company agent.
"Directors of publicly traded US banks"
Existing thread to continue (follow-up). Omit to start a new thread.
Company-research effort tier: low, medium, or high. Omit it on a new thread and Tako uses medium; omit it on a follow-up and the run keeps the thread's tier.
low, medium, high Which sources the agent may use: 'data' (curated knowledge), 'web' (open-web search), or both. Omit it on a new thread and the agent uses both; omit it on a follow-up and the run keeps the thread's sources. Tako accepts the legacy value 'tako' as a synonym for 'data'.
data, web ["data"]
Whether the agent may build visualization cards. True is permissive: the agent may build cards, but it does not have to (a completed run with no cards is legitimate). Set false to suppress card building entirely.
BCP-47 locale. Drives the language of the agent's answer and the locale used when rendering card preview images.
IANA timezone (for example, 'America/New_York'). The agent uses it to render dates and times in card preview images. It does not affect the returned data.
Settings that control the response and rendering.
Show child attributes
Show child attributes
Response
Run dispatched. With Accept: application/json, poll GET /v1/agent/company/runs/{run_id} for the run status. With Accept: text/event-stream, the response is an SSE stream of RetrievalAgentStreamEnvelope events. The stream ends at stream_done. If the stream ends without an agent_result event, poll GET /v1/agent/company/runs/{run_id} for the terminal status.
The company-agent run resource returned by dispatch (202) and poll (GET): the retrieval run's shape, with its own object type and the company request echoed.
queued, running, completed, failed "agent.company.run"Final retrieval-agent output. answer is markdown prose with [n] citation markers. cards reuse the sibling TakoCard. citations is the unified top-level registry for data and web sources — there is no web_results field. metadata carries definitions, assumptions, and methodology. The structured_output_* fields carry the caller-shaped output_schema result; they are present only if the request supplied output_schema. See each field's description for the exact presence rules.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Usage for one metered request. total_cost_usd is always present (the
total quoted charge). compute and data are the additive breakdown;
each appears only where it applies. total_cost_usd always equals the sum
of the components that appear.
Show child attributes
Show child attributes
Request body for POST /v1/agent/company/runs.
Show child attributes
Show child attributes