GET/brand/retrieve-simplified

Retrieve simplified brand data by domain

Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops. This endpoint is optimized for faster responses and reduced data transfer.

Context.dev·$0.03 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "context-dev",
  path: "/brand/retrieve-simplified",
  query: {
    "domain": "example"
  }
});

console.log(output);

Query parameters

domainrequired

string

Domain name to retrieve simplified brand data for

timeoutMS

integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Response

code

number

brand.logos.0.url

string

brand.logos.0.mode

string

brand.logos.0.type

string

brand.logos.0.colors.0.hex

string

brand.logos.0.colors.0.name

string

brand.logos.0.resolution.width

number

brand.logos.0.resolution.height

number

brand.logos.0.resolution.aspect_ratio

number

brand.title

string

brand.colors.0.hex

string

brand.colors.0.name

string

brand.domain

string

brand.backdrops.0.url

string

brand.backdrops.0.colors.0.hex

string

brand.backdrops.0.colors.0.name

string

brand.backdrops.0.resolution.width

number

brand.backdrops.0.resolution.height

number

brand.backdrops.0.resolution.aspect_ratio

number

status

string

key_metadata.credits_consumed

number

key_metadata.credits_remaining

number