Tool ID:
contextdev_get_brand_retrieve_by_nameRun this action
Use the TypeScript SDK for a single call. Putctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'contextdev_get_brand_retrieve_by_name',
{
"name": "Example"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute contextdev_get_brand_retrieve_by_name --input '{
"name": "Example"
}' --json
Example response
The SDK exposes this shape atresult.toolResponse.raw. Values below are representative.
{
"data": {
"status": "example",
"brand": {
"domain": "example.com",
"title": "VP of Engineering",
"description": "Example description"
},
"code": 123
}
}
deepline tools get contextdev_get_brand_retrieve_by_name --json for the latest machine-readable contract.
Input reference
Retrieve brand information using a company name.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.name | string | Yes | — | Company name to retrieve brand data for (e.g., ‘Apple Inc’, ‘Microsoft Corporation’). Must be 3-30 characters. Minimum length: 3. Maximum length: 30. |
payload.force_language | "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" | No | — | Language to force for the retrieved brand data. Allowed: 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, See the live schema for the complete constraint. |
payload.maxSpeed | boolean | No | false | Optional parameter to optimize the API call for maximum speed. |
payload.country_gl | "af" | "al" | "dz" | "as" | "ad" | "ao" | "ai" | "aq" | "ag" | "ar" | "am" | "aw" | "au" | "at" | "az" | "bs" | "bh" | "bd" | "bb" | "by" | "be" | "bz" | "bj" | "bm" | "bt" | "bo" | "ba" | "bw" | "bv" | "br" | "io" | "bn" | "bg" | "bf" | "bi" | "kh" | "cm" | "ca" | "cv" | "ky" | "cf" | "td" | "cl" | "cn" | "cx" | "cc" | "co" | "km" | "cg" | "cd" | "ck" | "cr" | "ci" | "hr" | "cu" | "cy" | "cz" | "dk" | "dj" | "dm" | "do" | "ec" | "eg" | "sv" | "gq" | "er" | "ee" | "et" | "fk" | "fo" | "fj" | "fi" | "fr" | "gf" | "pf" | "tf" | "ga" | "gm" | "ge" | "de" | "gh" | "gi" | "gr" | "gl" | "gd" | "gp" | "gu" | "gt" | "gn" | "gw" | "gy" | "ht" | "hm" | "va" | "hn" | "hk" | "hu" | "is" | "in" | "id" | "ir" | "iq" | "ie" | "il" | "it" | "jm" | "jp" | "jo" | "kz" | "ke" | "ki" | "kp" | "kr" | "kw" | "kg" | "la" | "lv" | "lb" | "ls" | "lr" | "ly" | "li" | "lt" | "lu" | "mo" | "mk" | "mg" | "mw" | "my" | "mv" | "ml" | "mt" | "mh" | "mq" | "mr" | "mu" | "yt" | "mx" | "fm" | "md" | "mc" | "mn" | "ms" | "ma" | "mz" | "mm" | "na" | "nr" | "np" | "nl" | "an" | "nc" | "nz" | "ni" | "ne" | "ng" | "nu" | "nf" | "mp" | "no" | "om" | "pk" | "pw" | "ps" | "pa" | "pg" | "py" | "pe" | "ph" | "pn" | "pl" | "pt" | "pr" | "qa" | "re" | "ro" | "ru" | "rw" | "sh" | "kn" | "lc" | "pm" | "vc" | "ws" | "sm" | "st" | "sa" | "sn" | "rs" | "sc" | "sl" | "sg" | "sk" | "si" | "sb" | "so" | "za" | "gs" | "es" | "lk" | "sd" | "sr" | "sj" | "sz" | "se" | "ch" | "sy" | "tw" | "tj" | "tz" | "th" | "tl" | "tg" | "tk" | "to" | "tt" | "tn" | "tr" | "tm" | "tc" | "tv" | "ug" | "ua" | "ae" | "gb" | "us" | "um" | "uy" | "uz" | "vu" | "ve" | "vn" | "vg" | "vi" | "wf" | "eh" | "ye" | "zm" | "zw" | No | — | Two-letter ISO 3166-1 alpha-2 country code (GL parameter) used to localize search. Allowed: af, al, dz, as, ad, ao, ai, aq, ag, ar, am, aw, au, at, az, bs, bh, bd, bb, by, be, bz, bj, bm, bt, bo, ba, bw, bv, br, io, bn, bg, bf, bi, kh, cm, ca, cv, ky, cf, td, cl, cn, cx, cc, co, km, cg, cd, ck, cr, ci, hr, cu, cy, cz, dk, dj, dm, do, ec, eg, sv, gq, er, ee, et, See the live schema for the complete constraint. |
payload.maxAgeMs | integer | No | 7776000000 | Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year. |
payload.timeoutMS | integer | No | — | 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). Minimum: 1000. Maximum: 300000. |
payload.tags | array | No | — | Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request’s usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters. Maximum items: 20. |
Output reference
| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.data | object | Yes | — | — |
result.data.status | string | No | — | — |
result.data.brand | object | No | — | — |
result.data.brand.domain | string | No | — | — |
result.data.brand.title | string | No | — | — |
result.data.brand.description | string | No | — | — |
result.data.brand.slogan | string | No | — | — |
result.data.brand.colors | array | No | — | — |
result.data.brand.colors[].hex | string | No | — | — |
result.data.brand.colors[].name | string | No | — | — |
result.data.brand.logos | array | No | — | — |
result.data.brand.logos[].url | string | No | — | — |
result.data.brand.logos[].mode | "light" | "dark" | "has_opaque_background" | No | — | Allowed: light, dark, has_opaque_background. |
result.data.brand.logos[].colors | array | No | — | — |
result.data.brand.logos[].colors[].hex | string | No | — | — |
result.data.brand.logos[].colors[].name | string | No | — | — |
result.data.brand.logos[].resolution | object | No | — | — |
result.data.brand.logos[].resolution.width | integer | No | — | — |
result.data.brand.logos[].resolution.height | integer | No | — | — |
result.data.brand.logos[].resolution.aspect_ratio | number | No | — | — |
result.data.brand.logos[].type | "icon" | "logo" | No | — | Allowed: icon, logo. |
result.data.brand.backdrops | array | No | — | — |
result.data.brand.backdrops[].url | string | No | — | — |
result.data.brand.backdrops[].colors | array | No | — | — |
result.data.brand.backdrops[].colors[].hex | string | No | — | — |
result.data.brand.backdrops[].colors[].name | string | No | — | — |
result.data.brand.backdrops[].resolution | object | No | — | — |
result.data.brand.backdrops[].resolution.width | integer | No | — | — |
result.data.brand.backdrops[].resolution.height | integer | No | — | — |
result.data.brand.backdrops[].resolution.aspect_ratio | number | No | — | — |
result.data.brand.socials | array | No | — | — |
result.data.brand.socials[].type | "x" | "facebook" | "instagram" | "linkedin" | "youtube" | "pinterest" | "tiktok" | "dribbble" | "github" | "behance" | "snapchat" | "whatsapp" | "telegram" | "line" | "discord" | "twitch" | "vimeo" | "imdb" | "tumblr" | "flickr" | "giphy" | "medium" | "spotify" | "soundcloud" | "tripadvisor" | "yelp" | "producthunt" | "reddit" | "crunchbase" | "appstore" | "playstore" | No | — | Allowed: x, facebook, instagram, linkedin, youtube, pinterest, tiktok, dribbble, github, behance, snapchat, whatsapp, telegram, line, discord, twitch, vimeo, imdb, tumblr, flickr, giphy, medium, spotify, soundcloud, tripadvisor, yelp, producthunt, reddit, crunchbase, appstore, playstore. |
result.data.brand.socials[].url | string | No | — | — |
result.data.brand.address | object | No | — | — |
result.data.brand.address.street | string | No | — | — |
result.data.brand.address.city | string | No | — | — |
result.data.brand.address.country | string | No | — | — |
result.data.brand.address.country_code | string | No | — | — |
result.data.brand.address.state_province | string | No | — | — |
result.data.brand.address.state_code | string | No | — | — |
result.data.brand.address.postal_code | string | No | — | — |
result.data.brand.stock | object | No | — | — |
result.data.brand.stock.ticker | string | No | — | — |
result.data.brand.stock.exchange | string | No | — | — |
result.data.brand.employees | object | No | — | — |
result.data.brand.employees.range | "1 to 10" | "11 to 50" | "51 to 200" | "201 to 500" | "501 to 1000" | "1001 to 5000" | "5001 to 10000" | "10001+" | No | — | Allowed: 1 to 10, 11 to 50, 51 to 200, 201 to 500, 501 to 1000, 1001 to 5000, 5001 to 10000, 10001+. |
result.data.brand.employees.exact | integer | No | — | — |
result.data.brand.is_nsfw | boolean | No | — | — |
result.data.brand.email | string | No | — | — |
result.data.brand.phone | string | No | — | — |
This output schema is too large to embed without slowing the page. Get the complete live contract with
deepline tools get contextdev_get_brand_retrieve_by_name --json.Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.