Retrieve a brand

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'by_domain', domain: 'stripe.com'})
};

fetch('https://api.context.dev/v1/brand/retrieve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "<string>",
  "brand": {
    "domain": "<string>",
    "title": "<string>",
    "description": "<string>",
    "slogan": "<string>",
    "colors": [
      {
        "hex": "<string>",
        "name": "<string>",
        "source": "site"
      }
    ],
    "logos": [
      {
        "url": "<string>",
        "mode": "light",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "<string>",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        }
      }
    ],
    "socials": [
      {
        "type": "x",
        "url": "<string>"
      }
    ],
    "address": {
      "street": "<string>",
      "city": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "state_province": "<string>",
      "state_code": "<string>",
      "postal_code": "<string>"
    },
    "stock": {
      "ticker": "<string>",
      "exchange": "<string>"
    },
    "employees": {
      "range": "1 to 10",
      "exact": 123
    },
    "is_nsfw": true,
    "email": "<string>",
    "phone": "<string>",
    "industries": {
      "eic": [
        {
          "industry": "Aerospace & Defense",
          "subindustry": "Defense Systems & Military Hardware"
        }
      ]
    },
    "links": {
      "careers": "<string>",
      "privacy": "<string>",
      "terms": "<string>",
      "contact": "<string>",
      "blog": "<string>",
      "pricing": "<string>"
    },
    "primary_language": "afrikaans"
  },
  "code": 123,
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "partial": true,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "error_data": {
    "is_authenticated": true,
    "limit_type": "concurrency",
    "limit": 1,
    "remaining": 1,
    "retry_after_seconds": 1,
    "credits_charged": 0,
    "should_retry": false,
    "retry_condition": "available_concurrency",
    "recovery_options": [
      "wait_for_in_flight_requests"
    ],
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

POST

brand

retrieve

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'by_domain', domain: 'stripe.com'})
};

fetch('https://api.context.dev/v1/brand/retrieve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "<string>",
  "brand": {
    "domain": "<string>",
    "title": "<string>",
    "description": "<string>",
    "slogan": "<string>",
    "colors": [
      {
        "hex": "<string>",
        "name": "<string>",
        "source": "site"
      }
    ],
    "logos": [
      {
        "url": "<string>",
        "mode": "light",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "<string>",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        }
      }
    ],
    "socials": [
      {
        "type": "x",
        "url": "<string>"
      }
    ],
    "address": {
      "street": "<string>",
      "city": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "state_province": "<string>",
      "state_code": "<string>",
      "postal_code": "<string>"
    },
    "stock": {
      "ticker": "<string>",
      "exchange": "<string>"
    },
    "employees": {
      "range": "1 to 10",
      "exact": 123
    },
    "is_nsfw": true,
    "email": "<string>",
    "phone": "<string>",
    "industries": {
      "eic": [
        {
          "industry": "Aerospace & Defense",
          "subindustry": "Defense Systems & Military Hardware"
        }
      ]
    },
    "links": {
      "careers": "<string>",
      "privacy": "<string>",
      "terms": "<string>",
      "contact": "<string>",
      "blog": "<string>",
      "pricing": "<string>"
    },
    "primary_language": "afrikaans"
  },
  "code": 123,
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "partial": true,
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "error_code": "RATE_LIMITED",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "error_data": {
    "is_authenticated": true,
    "limit_type": "concurrency",
    "limit": 1,
    "remaining": 1,
    "retry_after_seconds": 1,
    "credits_charged": 0,
    "should_retry": false,
    "retry_condition": "available_concurrency",
    "recovery_options": [
      "wait_for_in_flight_requests"
    ],
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1
  },
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

10 credits See the guide for examples and usage.

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json

One lookup, chosen by type.

type

enum<string>

required

Discriminator for domain-based brand retrieval.

Available options:

by_domain

domain

string

required

Domain name to retrieve brand data for (e.g., 'stripe.com').

Minimum string length: 3

force_language

enum<string>

Language, e.g. english.

Available options:

afrikaans,

albanian,

amharic,

arabic,

armenian,

assamese,

aymara,

azeri,

basque,

belarusian,

bengali,

bosnian,

bulgarian,

burmese,

cantonese,

catalan,

cebuano,

chinese,

corsican,

croatian,

czech,

danish,

dutch,

english,

esperanto,

estonian,

farsi,

fijian,

finnish,

french,

galician,

georgian,

german,

greek,

guarani,

gujarati,

haitian-creole,

hausa,

hawaiian,

hebrew,

hindi,

hmong,

hungarian,

icelandic,

igbo,

indonesian,

irish,

italian,

japanese,

javanese,

kannada,

kazakh,

khmer,

kinyarwanda,

korean,

kurdish,

kyrgyz,

lao,

latin,

latvian,

lingala,

lithuanian,

luxembourgish,

macedonian,

malagasy,

malay,

malayalam,

maltese,

maori,

marathi,

mongolian,

nepali,

norwegian,

odia,

oromo,

pashto,

pidgin,

polish,

portuguese,

punjabi,

quechua,

romanian,

russian,

samoan,

scottish-gaelic,

serbian,

sesotho,

shona,

sindhi,

sinhala,

slovak,

slovene,

somali,

spanish,

sundanese,

swahili,

swedish,

tagalog,

tajik,

tamil,

tatar,

telugu,

thai,

tibetan,

tigrinya,

tongan,

tswana,

turkish,

turkmen,

ukrainian,

urdu,

uyghur,

uzbek,

vietnamese,

welsh,

wolof,

xhosa,

yiddish,

yoruba,

zulu

maxSpeed

boolean

Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data.

maxAgeMs

integer

Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 year. 0 refreshes.

timeoutOpts

object

Request deadline and what to return when it passes.

Show child attributes

zdr

enum<string>

enabled disables request logs and traces and omits request and response content from usage logs. Brand data and hosted assets may still be stored. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

Available options:

enabled,

disabled

Response

Successful response

status

string

required

Always ok on success.

brand

object

required

Detailed brand information

Show child attributes

code

integer

required

HTTP status code

cache_metadata

object

required

Whether this response came from cache.

Show child attributes

request_id

string<uuid>

required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

partial

boolean

True when the timeout ended processing and this response contains the usable data completed so far. Unfinished fields are omitted.

key_metadata

object

Credits this request used and your remaining balance.

Show child attributes

Web Data

Brand Data

Entity Enrichment

Batches

Monitors

Webhook Deliveries

Access Policies

Account

Agent Feedback

Authorizations

Body

Response