Get an analysis
curl --request GET \
--url http://127.0.0.1:8900/v1/analyses/{job_id}import requests
url = "http://127.0.0.1:8900/v1/analyses/{job_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://127.0.0.1:8900/v1/analyses/{job_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8900",
CURLOPT_URL => "http://127.0.0.1:8900/v1/analyses/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://127.0.0.1:8900/v1/analyses/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://127.0.0.1:8900/v1/analyses/{job_id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8900/v1/analyses/{job_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "queued",
"request": {
"ticker": "NVDA",
"trade_date": "2024-05-10",
"asset_type": "stock",
"analysts": [
"market"
],
"max_debate_rounds": 5
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"result": {
"rating": "Buy",
"is_review": true,
"decision": "<string>",
"reports": {}
},
"error": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Analyses
Get an analysis
Poll for completion.
result is populated only on succeeded; error only on failed. A 404
means the id was never issued, or the job has aged out of retention.
GET
/
v1
/
analyses
/
{job_id}
Get an analysis
curl --request GET \
--url http://127.0.0.1:8900/v1/analyses/{job_id}import requests
url = "http://127.0.0.1:8900/v1/analyses/{job_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://127.0.0.1:8900/v1/analyses/{job_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8900",
CURLOPT_URL => "http://127.0.0.1:8900/v1/analyses/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://127.0.0.1:8900/v1/analyses/{job_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://127.0.0.1:8900/v1/analyses/{job_id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8900/v1/analyses/{job_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "queued",
"request": {
"ticker": "NVDA",
"trade_date": "2024-05-10",
"asset_type": "stock",
"analysts": [
"market"
],
"max_debate_rounds": 5
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"result": {
"rating": "Buy",
"is_review": true,
"decision": "<string>",
"reports": {}
},
"error": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Path Parameters
Response
Successful Response
Opaque job identifier.
Available options:
queued, running, succeeded, failed, cancelled Show child attributes
Show child attributes
Present only when status is succeeded.
Show child attributes
Show child attributes
Present only when status is failed.