{ "openapi": "3.0.1", "info": { "title": "Brand Kit: Logos, Colors & Fonts from Any Website", "description": "Get the brand kit of any website: logo variants, favicons and touch icons, colors with roles and contrast, fonts, design tokens and brand checks. Files as ZIP. Failed, blocked and duplicate domains are free.", "version": "1.1", "x-build-id": "CBrY4vqUCUxq9nZ7U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/urlwright~brand-kit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-urlwright-brand-kit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/urlwright~brand-kit/runs": { "post": { "operationId": "runs-sync-urlwright-brand-kit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/urlwright~brand-kit/run-sync": { "post": { "operationId": "run-sync-urlwright-brand-kit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Domains or URLs", "type": "array", "description": "Domains or any URL of the site (example.com, https://www.example.com/about). Each domain is analysed once, from its home page.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Domain or URL of the website." } }, "required": [ "url" ] } }, "datasetId": { "title": "Apify dataset ID", "type": "string", "description": "Read domains from a dataset, for example the output of Sitemap URL Extractor or Tech Stack Detector." }, "datasetField": { "title": "Dataset field", "type": "string", "description": "Field on the dataset rows that holds the domain or URL. Falls back to url, domain and finalUrl.", "default": "url" }, "csvUrl": { "title": "CSV or Google Sheets URL", "type": "string", "description": "Public CSV, TSV or Google Sheets link with one domain per row. Columns named domain, website or url are found automatically." }, "csvColumn": { "title": "CSV column", "type": "string", "description": "Column with the domains. Leave empty to detect it." }, "maxDomains": { "title": "Max domains", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many unique domains.", "default": 100 }, "renderJs": { "title": "Render JavaScript", "enum": [ "auto", "always", "never" ], "type": "string", "description": "auto renders a page in a browser only when the HTML is an app shell or has no logo or colors. Rendering is billed per page. never keeps every domain on plain HTTP.", "default": "auto" }, "downloadAssets": { "title": "Download files", "type": "boolean", "description": "Store the logo, favicons, touch icon, manifest icon and OG image as files and in a ZIP, plus PNG versions, a brand sheet and token files. Each stored image file is billed.", "default": false }, "assetTypes": { "title": "File types", "type": "array", "description": "Which files to store when Download files is on.", "items": { "type": "string", "enum": [ "logo", "favicons", "touchIcons", "manifestIcons", "ogImage" ], "enumTitles": [ "Logo", "Favicons", "Touch icons", "Manifest icons", "OG image" ] }, "default": [ "logo", "favicons", "touchIcons", "manifestIcons", "ogImage" ] }, "maxAssetsPerDomain": { "title": "Max files per domain", "minimum": 1, "maximum": 50, "type": "integer", "description": "Upper limit of billed image files per domain.", "default": 8 }, "normalize": { "title": "PNG versions", "type": "boolean", "description": "Add logo.png from SVG logos, a square icon-512.png and favicon PNGs in 32 and 180 px.", "default": true }, "storeFiles": { "title": "File output", "enum": [ "both", "zip", "files" ], "type": "string", "description": "Single files in the key-value store, one ZIP, or both.", "default": "both" }, "scanBrandPages": { "title": "Check brand and press pages", "type": "boolean", "description": "Open a linked brand, press or media kit page on the same site to find the official logo. Billed per page.", "default": true }, "maxExtraPages": { "title": "Max extra pages per domain", "minimum": 0, "maximum": 5, "type": "integer", "description": "Brand or press pages opened per domain.", "default": 1 }, "tokenFormats": { "title": "Token formats", "type": "array", "description": "Design token formats in the dataset and the kit: CSS variables, Tailwind v4 @theme and W3C design tokens (DTCG JSON).", "items": { "type": "string", "enum": [ "css", "tailwind", "dtcg" ], "enumTitles": [ "CSS variables", "Tailwind v4", "DTCG JSON" ] }, "default": [ "css", "tailwind", "dtcg" ] }, "monitor": { "title": "Monitor mode", "type": "boolean", "description": "Compare with the last run and list changes to logo, primary color, name, favicon and fonts. Unchanged files are not stored again and are free.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that keeps the state between runs.", "default": "brand-kit-monitor" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }