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

# Generate Logo

> Generate brand logos using AI for genies and branding

The `generate-logo` resource provides a dedicated endpoint for generating brand logo images. Logo generation is also available via the `branding` resource's `generate-logo` action.

***

## Generate logo

Generates a brand logo image using AI based on a name, description, and optional style preferences.

<ParamField body="resource" type="string" required>
  Must be `"generate-logo"`
</ParamField>

<ParamField body="action" type="string" required>
  Must be `"generate"`
</ParamField>

<ParamField body="data" type="object" required>
  <Expandable title="properties">
    <ParamField body="name" type="string" required>
      Brand or genie name used as the basis for the logo.
    </ParamField>

    <ParamField body="description" type="string">
      A short description of the brand or product to guide the visual style.
    </ParamField>

    <ParamField body="style" type="string">
      Visual style preference (e.g. `"minimalist"`, `"bold"`, `"playful"`).
    </ParamField>

    <ParamField body="industry" type="string">
      Industry or category to inform the design (e.g. `"technology"`, `"healthcare"`, `"retail"`).
    </ParamField>
  </Expandable>
</ParamField>

<ResponseField name="success" type="boolean" />

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="url" type="string">
      URL of the generated logo image.
    </ResponseField>
  </Expandable>
</ResponseField>

<CodeGroup>
  ```typescript Request theme={null}
  const response = await ApiService.invoke({
    resource: "generate-logo",
    action: "generate",
    data: {
      name: "Acme Corp",
      description: "A friendly customer support company",
      style: "minimalist",
      industry: "technology",
    },
  });
  const logoUrl = response?.url;
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.helpgenie.ai/v1/generate-logo \
    -H "Authorization: Bearer hg_live_YOUR_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "resource": "generate-logo",
      "action": "generate",
      "data": {
        "name": "Acme Corp",
        "description": "A friendly customer support company",
        "style": "minimalist",
        "industry": "technology"
      }
    }'
  ```

  ```json Response theme={null}
  {
    "success": true,
    "data": {
      "url": "https://storage.helpgenie.ai/logos/generated-logo-abc123.png"
    }
  }
  ```
</CodeGroup>

***

## Error codes

| Code               | Meaning                |
| ------------------ | ---------------------- |
| `VALIDATION_ERROR` | `name` is required     |
| `INTERNAL_ERROR`   | Logo generation failed |
