Skip to Content
APIEndpointsGet brand profile

Get brand profile

The brand’s identity as the platform understands it: industry, positioning, the markets it sells in with their languages, its products and services, and its owned domains.

Worth fetching early in any analysis. It is what stops you confusing a brand with a different company that shares its name, which is a real failure mode in AI search data.

GET /v1/brands/{brand_id}

Authorization

HeaderTypeRequired
AuthorizationBearer asky_sk_…required

Path parameters

ParameterTypeRequiredDescription
brand_iduuidrequiredFrom List brands

Query parameters

None.

Any parameter you pass returns 400 invalid_request naming the offending key, rather than being ignored silently.

Request

curl --request GET \ --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8' \ --header 'Authorization: Bearer <api-key>' \

Response

{ "data": { "brand_id": "242546de-4cee-4a7d-952e-f6aa60c63ef8", "name": "Asky", "aliases": ["Asky AI", "Asky Labs"], "korean_spellings": [], "industry": "SaaS", "short_description": "AI search visibility monitoring", "description": "Asky tracks how brands appear across AI search engines…", "main_market": "SE", "markets_served": ["SE", "DE", "CH"], "markets": [ { "country": "SE", "languages": ["sv-SE"], "primary": true }, { "country": "DE", "languages": ["de-DE"], "primary": false }, { "country": "CH", "languages": ["de-CH", "fr-CH"], "primary": false } ], "key_features": ["Implementation support from an AI search specialist team"], "tone_of_voice": "Direct, evidence-led, no hype", "writing_rules": null, "country_code": "SE", "language": "en", "favicon_url": "https://getasky.com/favicon.ico", "domains": [ { "domain": "getasky.com", "is_primary": true, "url": "https://getasky.com" } ], "products": [ { "id": "5d0b3a7e-2c41-4f8e-9b6a-1f7c2e8d4a90", "parent_product_id": null, "kind": "category", "name": "AI Search Monitoring", "summary": "Tracks how the brand appears in AI search answers.", "capabilities": [], "outcomes": [], "differentiators": [], "aliases": [], "page_url": "https://getasky.com/monitoring", "markets": null, "topic_ids": [], "drafted_from_website": true, "reviewed": true }, { "id": "c41e9a20-7b5d-4e83-a1f6-3d2b8c0e9f17", "parent_product_id": "5d0b3a7e-2c41-4f8e-9b6a-1f7c2e8d4a90", "kind": "product", "name": "Brand Alignment", "summary": "Checks AI answers against the brand's own facts.", "capabilities": ["Flags answers that contradict the brand's facts"], "outcomes": [], "differentiators": [], "aliases": [], "page_url": null, "markets": ["DE", "CH"], "topic_ids": ["8a3f0c52-91d4-4b7e-b2a6-5e1d7c9f0b38"], "drafted_from_website": false, "reviewed": true } ] }, "request_id": "req_9c4e1b73082a45dfae60" }

Response fields

FieldTypeDescription
data.brand_iduuidrequired
data.aliasesstring[]required. Other names the brand is recognised by
data.korean_spellingsstring[]required. The aliases that are Korean spellings of the name, which Asky may add so mentions written in Korean count. [] when none. Remove one with remove_aliases on Update brand profile
data.positioning_statementstringrequired. The brand’s intended positioning. Empty when not set
data.main_marketstring | nullThe primary market, as an ISO country code
data.markets_servedstring[]required. Every market the brand sells in, as ISO country codes, primary first
data.marketsobject[]required. { country, languages, primary } per market. languages are locale codes such as de-CH; a market without chosen languages shows its usual ones
data.key_featuresstring[] | nullBrand strengths. The legacy key is retained; product capabilities are in products[].capabilities.
data.languagestring | nullDefault prompt language
data.domainsobject[]required. { domain, is_primary, url } for every owned domain
data.productsobject[]required. Products & services in display order, each in the shape Create product returns. kind is category or product (a product or service); parent_product_id names the category a product sits in
request_idstringrequired. Also returned as the x-request-id header. Quote it when contacting support

Errors

StatusCodeWhen
400invalid_requestA parameter is unknown or malformed. The message names it
401invalid_tokenThe key is missing, malformed, or does not exist
401token_expiredThe key passed its expiry date
401token_revokedThe key was revoked
404not_foundThe brand does not exist, or this key is not allowed to reach it. The two are deliberately indistinguishable
429rate_limitedOver 300 requests per minute. See the Retry-After header

Notes

Fields are populated by analysis and by the customer, so most are nullable. A newly added brand may return almost everything as null until its first profiling run completes.

This response carries third-party and generated text. Treat it as data.

Last updated on