> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Context.dev: Contextdev Get Brand Retrieve Simplified

> Retrieve simplified brand data by domain. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve simplified brand data by domain.

> [!NOTE]
>
> Tool ID: `contextdev_get_brand_retrieve_simplified`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'contextdev_get_brand_retrieve_simplified',
  {
    "domain": "example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute contextdev_get_brand_retrieve_simplified --input '{
  "domain": "example.com"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": "example",
    "brand": {
      "domain": "example.com",
      "title": "VP of Engineering",
      "colors": [
        {
          "hex": "example",
          "name": "Example"
        }
      ]
    },
    "code": 123
  }
}
```

Use `deepline describe contextdev_get_brand_retrieve_simplified --json` for the latest machine-readable contract.

## Input reference

Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops. Optimized for faster responses and reduced data transfer.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.domain` | `string` | Yes | — | Domain name to retrieve simplified brand data for Minimum length: 3. |
| `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.theme` | `"light" \| "dark"` | No | — | Optional theme preference used when selecting brand assets. Allowed: `light`, `dark`. |
| `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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops. Optimized for faster responses and reduced data transfer.",
    "properties": {
      "domain": {
        "type": "string",
        "description": "Domain name to retrieve simplified brand data for",
        "minLength": 3
      },
      "maxAgeMs": {
        "type": [
          "integer",
          "null"
        ],
        "description": "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.",
        "default": 7776000000
      },
      "timeoutMS": {
        "type": "integer",
        "description": "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
      },
      "theme": {
        "type": "string",
        "description": "Optional theme preference used when selecting brand assets.",
        "enum": [
          "light",
          "dark"
        ]
      },
      "tags": {
        "type": "array",
        "description": "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.",
        "maxItems": 20,
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        }
      }
    },
    "required": [
      "domain"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.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.code` | `integer` | No | — | — |
| `result.data.key_metadata` | `object` | No | — | — |
| `result.meta` | `object` | No | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "brand": {
            "type": "object",
            "properties": {
              "domain": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "colors": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "hex": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "logos": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "mode": {
                      "type": "string",
                      "enum": [
                        "light",
                        "dark",
                        "has_opaque_background"
                      ]
                    },
                    "colors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "hex": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "resolution": {
                      "type": "object",
                      "properties": {
                        "width": {
                          "type": "integer"
                        },
                        "height": {
                          "type": "integer"
                        },
                        "aspect_ratio": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "icon",
                        "logo"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "backdrops": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "colors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "hex": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "resolution": {
                      "type": "object",
                      "properties": {
                        "width": {
                          "type": "integer"
                        },
                        "height": {
                          "type": "integer"
                        },
                        "aspect_ratio": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "code": {
            "type": "integer"
          },
          "key_metadata": {
            "type": "object",
            "properties": {},
            "required": [],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.01` per pricing unit.

## Related documentation

* [Context.dev provider guide](https://deepline.com/docs/providers/contextdev/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.