Get AI summary for a company.
curl --request GET \
--url https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary', 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://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-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://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entity_type": "<string>",
"entity_uuid": "<string>",
"bio": "<string>",
"generated_at": "<string>",
"sections": [
{
"content": "<string>",
"heading": "<string>"
}
],
"title": "<string>"
}AI Summary
AI summary for a company
Generates a live summary using the same pipeline as the web app. Returns 404 when the entity is not found.
GET
/
v1
/
companies
/
{company_uuid}
/
ai-summary
Get AI summary for a company.
curl --request GET \
--url https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary', 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://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-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://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/companies/{company_uuid}/ai-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entity_type": "<string>",
"entity_uuid": "<string>",
"bio": "<string>",
"generated_at": "<string>",
"sections": [
{
"content": "<string>",
"heading": "<string>"
}
],
"title": "<string>"
}Authorizations
Path Parameters
Response
200 - application/json
AI summary for a person or company.
title: summary title (e.g. "Jane Doe Summary" or "Acme Corp Brief")bio: person biography (person entities only, null for companies)sections: structured summary sections; empty list when no datagenerated_at: ISO-8601 timestamp of generation, or null