brand-intel-branddev

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Brand.dev - Brand Intelligence API

Brand.dev - 品牌情报API

Setup

配置

Read your credentials from ~/.gooseworks/credentials.json:

bash

export GOOSEWORKS_API_KEY=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json'))['api_key'])")
export GOOSEWORKS_API_BASE=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json')).get('api_base','https://api.gooseworks.ai'))")

If ~/.gooseworks/credentials.json does not exist, tell the user to run:

npx gooseworks login

All endpoints use Bearer auth:

-H "Authorization: Bearer $GOOSEWORKS_API_KEY"

Extract comprehensive brand information from any domain - logos, colors, fonts, and more.

从~/.gooseworks/credentials.json读取您的凭证：

bash

export GOOSEWORKS_API_KEY=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json'))['api_key'])")
export GOOSEWORKS_API_BASE=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json')).get('api_base','https://api.gooseworks.ai'))")

如果~/.gooseworks/credentials.json不存在，请告知用户运行：

npx gooseworks login

所有端点均使用Bearer认证：

-H "Authorization: Bearer $GOOSEWORKS_API_KEY"

从任意域名提取全面的品牌信息 - 包括Logo、颜色、字体等。

Capabilities

功能特性

Extract fonts from website: Extract font information from a brand’s website including font families, usage statistics, fallbacks, and element/word counts
Identify brand from transaction data: Endpoint specially designed for platforms that want to identify transaction data by the transaction title
Retrieve NAICS code for any brand: Endpoint to classify any brand into a 2022 NAICS code
Retrieve brand data by email address: Retrieve brand information using an email address while detecting disposable and free email addresses
Retrieve simplified brand data by domain: Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops
Retrieve brand data by ISIN: Retrieve brand information using an ISIN (International Securities Identification Number)
Extract products from a brand's website: Beta feature: Extract product information from a brand’s website
Retrieve brand data by domain: Retrieve logos, backdrops, colors, industry, description, and more from any domain
Retrieve brand data by company name: Retrieve brand information using a company name
Retrieve brand data by stock ticker: Retrieve brand information using a stock ticker symbol
Extract design system and styleguide from website: Automatically extract comprehensive design system information from a brand’s website including colors, typography, spacing, shadows, and UI components
Take screenshot of website: Capture a screenshot of a website
Query website data using AI: Use AI to extract specific data points from a brand’s website

从网站提取字体：从品牌网站提取字体信息，包括字体家族、使用统计、备选字体以及元素/单词计数
从交易数据识别品牌：专为希望通过交易标题识别交易数据的平台设计的端点
获取任意品牌的NAICS代码：将任意品牌分类到2022版NAICS代码的端点
通过邮箱地址获取品牌数据：使用邮箱地址获取品牌信息，同时检测一次性邮箱和免费邮箱
通过域名获取简化版品牌数据：返回仅包含核心信息的简化版品牌数据：域名、标题、颜色、Logo和背景图
通过ISIN获取品牌数据：使用ISIN（国际证券识别号码）获取品牌信息
从品牌网站提取产品信息：Beta功能：从品牌网站提取产品信息
通过域名获取品牌数据：从任意域名获取Logo、背景图、颜色、行业、描述等信息
通过公司名称获取品牌数据：使用公司名称获取品牌信息
通过股票代码获取品牌数据：使用股票代码获取品牌信息
从网站提取设计系统和风格指南：自动从品牌网站提取全面的设计系统信息，包括颜色、排版、间距、阴影和UI组件
网站截图：捕获网站的截图
使用AI查询网站数据：使用AI从品牌网站提取特定数据点

Usage

使用方法

Extract fonts from website

从网站提取字体

Extract font information from a brand’s website including font families, usage statistics, fallbacks, and element/word counts.

Parameters:

domain* (string) - Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/fonts","query":{"domain":"vercel.com"}}'

从品牌网站提取字体信息，包括字体家族、使用统计、备选字体以及元素/单词计数。

参数：

domain* (string) - 要提取字体的域名（例如：'example.com'、'google.com'）。域名会自动规范化和验证。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/fonts","query":{"domain":"vercel.com"}}'

Identify brand from transaction data

从交易数据识别品牌

Endpoint specially designed for platforms that want to identify transaction data by the transaction title.

Parameters:

transaction_info* (string) - Transaction information to identify the brand
force_language (string) - Optional parameter to force the language of the retrieved brand data.
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.
country_gl (string) - Optional country code (GL parameter) to specify the country. This affects the geographic location used for search queries.
city (string) - Optional city name to prioritize when searching for the brand.
mcc (string) - Optional Merchant Category Code (MCC) to help identify the business category/industry.
phone (number) - Optional phone number from the transaction to help verify brand match.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/transaction_identifier","query":{"transaction_title":"STRIPE%20PAYMENT"}}'

专为希望通过交易标题识别交易数据的平台设计的端点。

参数：

transaction_info* (string) - 用于识别品牌的交易信息
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。
country_gl (string) - 可选国家代码（GL参数），用于指定国家。这会影响搜索查询使用的地理位置。
city (string) - 可选城市名称，搜索品牌时优先考虑该城市。
mcc (string) - 可选商户类别代码（MCC），帮助识别业务类别/行业。
phone (number) - 可选交易中的电话号码，帮助验证品牌匹配度。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/transaction_identifier","query":{"transaction_title":"STRIPE%20PAYMENT"}}'

Retrieve NAICS code for any brand

获取任意品牌的NAICS代码

Endpoint to classify any brand into a 2022 NAICS code.

Parameters:

input* (string) - Brand domain or title to retrieve NAICS code for. If a valid domain is provided in input, it will be used for classification, otherwise, we will search for the brand using the provided title.
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).
minResults (integer) - Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
maxResults (integer) - Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5.

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/naics","query":{"input":"openai.com"}}'

将任意品牌分类到2022版NAICS代码的端点。

参数：

input* (string) - 要获取NAICS代码的品牌域名或标题。如果input中提供了有效的域名，将使用该域名进行分类；否则，将根据提供的标题搜索品牌。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。
minResults (integer) - 返回的NAICS代码的最小数量。至少为1，默认值为1。
maxResults (integer) - 返回的NAICS代码的最大数量。范围在1到10之间，默认值为5。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/naics","query":{"input":"openai.com"}}'

Retrieve brand data by email address

通过邮箱地址获取品牌数据

Retrieve brand information using an email address while detecting disposable and free email addresses. This endpoint extracts the domain from the email address and returns brand data for that domain. Disposable and free email addresses (like gmail.com, yahoo.com) will throw a 422 error.

Parameters:

email* (string<email>) - Email address to retrieve brand data for (e.g., 'contact@example.com'). The domain will be extracted from the email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email addresses are not allowed.
force_language (string) - Optional parameter to force the language of the retrieved brand data.
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.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-email","query":{"email":"john@stripe.com"}}'

使用邮箱地址获取品牌信息，同时检测一次性邮箱和免费邮箱。该端点会从邮箱地址中提取域名，并返回该域名的品牌数据。一次性邮箱和免费邮箱（如gmail.com、yahoo.com）会返回422错误。

参数：

email* (string<email>) - 要获取品牌数据的邮箱地址（例如：'contact@example.com'）。域名将从邮箱中提取。不允许使用免费邮箱提供商（gmail.com、yahoo.com等）和一次性邮箱地址。
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-email","query":{"email":"john@stripe.com"}}'

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.

Parameters:

domain* (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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-simplified","query":{"domain":"notion.so"}}'

返回仅包含核心信息的简化版品牌数据：域名、标题、颜色、Logo和背景图。该端点经过优化，响应速度更快，数据传输量更少。

参数：

domain* (string) - 要获取简化版品牌数据的域名
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-simplified","query":{"domain":"notion.so"}}'

Retrieve brand data by ISIN

通过ISIN获取品牌数据

Retrieve brand information using an ISIN (International Securities Identification Number). This endpoint looks up the company associated with the ISIN and returns its brand data.

Parameters:

isin* (string) - ISIN (International Securities Identification Number) to retrieve brand data for (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters followed by 9 alphanumeric characters and ending with a digit.
force_language (string) - Optional parameter to force the language of the retrieved brand data.
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.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-isin","query":{"isin":"US0378331005"}}'

使用ISIN（国际证券识别号码）获取品牌信息。该端点会查找与ISIN关联的公司，并返回其品牌数据。

参数：

isin* (string) - 要获取品牌数据的ISIN（国际证券识别号码）（例如：'AU000000IMD5'、'US0378331005'）。必须为12个字符：2个字母，后跟9个字母数字字符，最后以一个数字结尾。
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-isin","query":{"isin":"US0378331005"}}'

Extract products from a brand's website

从品牌网站提取产品信息

Beta feature: Extract product information from a brand’s website. Brand.dev will analyze the website and return a list of products with details such as name, description, image, pricing, features, and more.

Parameters:

domain* (string) - The domain name to analyze
maxProducts (integer) - Maximum number of products to extract.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/ai/products","body":{"domain":"stripe.com"}}'

Beta功能：从品牌网站提取产品信息。Brand.dev会分析网站并返回产品列表，包含名称、描述、图片、定价、功能等详情。

参数：

domain* (string) - 要分析的域名
maxProducts (integer) - 要提取的产品最大数量。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/ai/products","body":{"domain":"stripe.com"}}'

Retrieve brand data by domain

通过域名获取品牌数据

Retrieve logos, backdrops, colors, industry, description, and more from any domain

Parameters:

domain* (string) - Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be used with name or ticker parameters.
force_language (string) - Optional parameter to force the language of the retrieved brand data. Works with all three lookup methods.
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. Works with all three lookup methods.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve","query":{"domain":"stripe.com"}}'

从任意域名获取Logo、背景图、颜色、行业、描述等信息

参数：

domain* (string) - 要获取品牌数据的域名（例如：'example.com'、'google.com'）。不能与name或ticker参数同时使用。
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。适用于所有三种查询方式。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。适用于所有三种查询方式。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve","query":{"domain":"stripe.com"}}'

Retrieve brand data by company name

通过公司名称获取品牌数据

Retrieve brand information using a company name. This endpoint searches for the company by name and returns its brand data.

Parameters:

name* (string) - Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporation'). Must be 3-30 characters.
force_language (string) - Optional parameter to force the language of the retrieved brand data.
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.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-name","query":{"name":"Stripe"}}'

使用公司名称获取品牌信息。该端点会根据名称搜索公司并返回其品牌数据。

参数：

name* (string) - 要获取品牌数据的公司名称（例如：'Apple Inc'、'Microsoft Corporation'）。长度必须为3-30个字符。
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-name","query":{"name":"Stripe"}}'

Retrieve brand data by stock ticker

通过股票代码获取品牌数据

Retrieve brand information using a stock ticker symbol. This endpoint looks up the company associated with the ticker and returns its brand data.

Parameters:

ticker* (string) - Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A'). Must be 1-15 characters, letters/numbers/dots only.
ticker_exchange (string) - Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
force_language (string) - Optional parameter to force the language of the retrieved brand data.
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.
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).

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-ticker","query":{"ticker":"AAPL"}}'

使用股票代码获取品牌信息。该端点会查找与代码关联的公司并返回其品牌数据。

参数：

ticker* (string) - 要获取品牌数据的股票代码（例如：'AAPL'、'GOOGL'、'BRK.A'）。长度必须为1-15个字符，仅允许字母/数字/点。
ticker_exchange (string) - 可选股票交易所，用于指定代码所属交易所。未指定时默认NASDAQ。
force_language (string) - 可选参数，强制指定获取的品牌数据的语言。
maxSpeed (boolean) - 可选参数，优化API调用以追求最快速度。设置为true时，API将跳过耗时操作以获得更快响应，但数据的全面性会有所降低。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-ticker","query":{"ticker":"AAPL"}}'

Extract design system and styleguide from website

从网站提取设计系统和风格指南

Automatically extract comprehensive design system information from a brand’s website including colors, typography, spacing, shadows, and UI components.

Parameters:

domain* (string) - Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.
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).
prioritize (string) - Optional parameter to prioritize screenshot capture for styleguide extraction. If 'speed', optimizes for faster capture with basic quality. If 'quality', optimizes for higher quality with longer wait times. Defaults to 'quality' if not provided.

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/styleguide","query":{"domain":"linear.app"}}'

自动从品牌网站提取全面的设计系统信息，包括颜色、排版、间距、阴影和UI组件。

参数：

domain* (string) - 要提取风格指南的域名（例如：'example.com'、'google.com'）。域名会自动规范化和验证。
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。
prioritize (string) - 可选参数，指定风格指南提取时截图的优先级。如果为'speed'，则优化为更快的截图速度但基础质量；如果为'quality'，则优化为更高质量但等待时间更长。未提供时默认'quality'。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/styleguide","query":{"domain":"linear.app"}}'

Take screenshot of website

网站截图

Capture a screenshot of a website. Supports both viewport (standard browser view) and full-page screenshots. Can also screenshot specific page types (login, pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to the uploaded screenshot image hosted on our CDN.

Parameters:

domain* (string) - Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.
fullScreenshot (string) - Optional parameter to determine screenshot type. If 'true', takes a full page screenshot capturing all content. If 'false' or not provided, takes a viewport screenshot (standard browser view).
page (string) - Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain's links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page.
prioritize (string) - Optional parameter to prioritize screenshot capture. If 'speed', optimizes for faster capture with basic quality. If 'quality', optimizes for higher quality with longer wait times. Defaults to 'quality' if not provided.

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/screenshot","query":{"domain":"github.com"}}'

捕获网站的截图。支持视口（标准浏览器视图）和全屏截图。还可以通过启发式方法查找合适的URL，对特定页面类型（登录页、定价页等）进行截图。返回托管在我们CDN上的截图图片URL。

参数：

domain* (string) - 要截图的域名（例如：'example.com'、'google.com'）。域名会自动规范化和验证。
fullScreenshot (string) - 可选参数，指定截图类型。如果为'true'，则截取全屏截图以捕获所有内容；如果为'false'或未提供，则截取视口截图（标准浏览器视图）。
page (string) - 可选参数，指定要截图的页面类型。如果提供，系统将抓取域名的链接并使用启发式方法找到指定页面类型的最适合URL（支持30种语言）。未提供时，将对主域名着陆页进行截图。
prioritize (string) - 可选参数，指定截图的优先级。如果为'speed'，则优化为更快的截图速度但基础质量；如果为'quality'，则优化为更高质量但等待时间更长。未提供时默认'quality'。

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/screenshot","query":{"domain":"github.com"}}'

Query website data using AI

使用AI查询网站数据

Use AI to extract specific data points from a brand’s website. The AI will crawl the website and extract the requested information based on the provided data points.

Parameters:

domain* (string) - The domain name to analyze
data_to_extract* (object[]) - Array of data points to extract from the website
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).
specific_pages (object) - Optional object specifying which pages to analyze

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/ai/query"}'
  "domain": "anthropic.com",
  "data_to_extract": [{"name": "products", "description": "What products does this company offer?"}]
}'

使用AI从品牌网站提取特定数据点。AI将爬取网站并根据提供的数据点提取所需信息。

参数：

domain* (string) - 要分析的域名
data_to_extract* (object[]) - 要从网站提取的数据点数组
timeoutMS (integer) - 请求的可选超时时间（毫秒）。如果请求耗时超过该值，将返回408状态码中止请求。最大允许值为300000ms（5分钟）。
specific_pages (object) - 可选对象，指定要分析的页面

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/ai/query"}'
  "domain": "anthropic.com",
  "data_to_extract": [{"name": "products", "description": "What products does this company offer?"}]
}'

Use Cases

应用场景

Design Systems: Extract brand colors, fonts, and styles
Competitive Analysis: Understand competitor branding
Lead Enrichment: Get company info from domains or emails
Transaction Identification: Identify companies from transaction data
Market Research: Classify and categorize companies

设计系统：提取品牌颜色、字体和样式
竞品分析：了解竞争对手的品牌策略
线索丰富：从域名或邮箱获取企业信息
交易识别：从交易数据中识别企业
市场调研：对企业进行分类和归类

Discover More

了解更多

For full endpoint details and parameters:

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/search \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"brand-dev API endpoints"}' List all endpoints
curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/details \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/fonts"}'   # Get endpoint details

如需完整的端点详情和参数：

bash

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/search \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"brand-dev API endpoints"}' List all endpoints
curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/details \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/fonts"}'   # Get endpoint details