Skip to main content
POST
/
v1
/
brand
/
research
Brand Details
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"
}
'
{
  "brand": {
    "name": "<string>",
    "url": "<string>",
    "identity": {
      "mission": "<string>",
      "mission_reason": "<string>",
      "values": [
        "<string>"
      ],
      "values_reason": "<string>",
      "tagline": "<string>",
      "tagline_reason": "<string>",
      "language": {
        "tone": "<string>",
        "tone_reason": "<string>",
        "key_phrases": [
          "<string>"
        ],
        "key_phrases_reason": "<string>"
      }
    },
    "colors": {},
    "name_reason": "<string>",
    "url_reason": "<string>",
    "note": "<string>"
  },
  "industries": [
    "<string>"
  ],
  "audience": {
    "description": "<string>",
    "reason": "<string>"
  },
  "metadata": {},
  "effort": "auto"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Input model for brand research endpoint.

​
auto
string | null

Raw text containing brand information for auto-detection. When provided, brand name and URL will be extracted automatically.

Example:

"Check out Nike's latest collection at nike.com"

​
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

Target audience summary

​
metadata
Metadata · object

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