Skip to main content
POST
/
v1
/
brand
/
research
Brand Research
curl --request POST \
  --url https://api.upriver.ai/v1/brand/research \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "brand_url": "https://www.bose.com"
}
'
import requests

url = "https://api.upriver.ai/v1/brand/research"

payload = { "brand_url": "https://www.bose.com" }
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({brand_url: 'https://www.bose.com'})
};

fetch('https://api.upriver.ai/v1/brand/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.upriver.ai/v1/brand/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([
    'brand_url' => 'https://www.bose.com'
  ]),
  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://api.upriver.ai/v1/brand/research"

	payload := strings.NewReader("{\n  \"brand_url\": \"https://www.bose.com\"\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://api.upriver.ai/v1/brand/research")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand_url\": \"https://www.bose.com\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/brand/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["Content-Type"] = 'application/json'
request.body = "{\n  \"brand_url\": \"https://www.bose.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "brand": {
    "name": "<string>",
    "url": "<string>",
    "description": "<string>",
    "identity": {
      "mission": "<string>",
      "values": [
        "<string>"
      ],
      "tagline": "<string>",
      "language": {
        "tone": "<string>",
        "key_phrases": [
          "<string>"
        ]
      }
    },
    "colors": {},
    "note": "<string>"
  },
  "industries": [
    "<string>"
  ],
  "audience": {
    "description": "<string>"
  },
  "metadata": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Input model for brand research endpoint.

​
brand_url
string | null

The brand website URL to research

Example:

"https://example.com"

​
brand_name
string | null

The brand name to research

Example:

"Example Brand"

​
response_format
enum<string>
default:json

Format for the response: 'json' for structured data, 'text' for natural language

Available options:
json,
text
Example:

"json"

​
effort
enum<string>
default:auto

Effort level for brand research. 'auto' selects the appropriate level (currently defaults to 'low').

Available options:
auto,
low,
mid,
high
Example:

"auto"

​
include
string[]

Optional list of extra data to include in the response. Supported values: 'colors'. When 'colors' is included, brand colors are extracted from the website CSS and logos.

Example:
["colors"]

Response

Successful Response

Response model for the v2 brand research endpoint.

​
brand
BrandV2Brand · object
required

Brand information

​
industries
string[] | null

Industry labels

​
audience
BrandV2Audience · object | null

Target audience summary

​
metadata
Metadata · object | null

Provenance and supporting evidence

​
effort
enum<string> | null

Effort level used to generate this result. 'auto' is resolved to the actual level applied.

Available options:
auto,
low,
mid,
high