---
title: "Circle Image API — Dots, rings & round badges | Imejis"
description: "A perfect circle with fill, border and shadow control — dots, rings, badges and avatar frames — recolored on every API call. Start designing for free."
url: "https://www.imejis.io/components/circle"
---

# Circle Image API — Dots, rings & round badges | Imejis

A perfect circle with fill, border and shadow control — avatars frames, dots, badges and decorative accents.

## Use cases

- Status dots recolored by health or state
- Avatar frames and profile accents
- Notification-style count badges

## Authoring notes

- Set size width = height = diameter; radius defaults to half the smaller side of the box.

## Properties

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `fillColor` | `color` | `"#808080"` | Fill color. |
| `radius` | `number` (min 1) | — | Explicit radius in pixels (otherwise derived from the component size). |
| `opacity` | `number` | `1` | Overall component opacity from 0 (transparent) to 1 (opaque). |
| `borderWidth` | `number` | `0` | Border thickness in pixels around the component. |
| `borderColor` | `color` | `"transparent"` | Border color (any CSS color). |
| `borderStyle` | `'solid' \| 'dashed' \| 'dotted' \| 'double' \| 'none'` | `"solid"` | Border line style. |
| `borderRadius` | `number` | `0` | Corner radius in pixels. |
| `boxShadow` | `string` | — | CSS box-shadow applied to the component, e.g. "0 4px 6px rgba(0,0,0,0.1)". |

## Sample design JSON

```json
{
  "title": "Circle sample",
  "description": "A dynamic colored circle",
  "dimensions": {
    "width": 800,
    "height": 420
  },
  "background": {
    "color": "#ffffff"
  },
  "components": [
    {
      "id": "sample-circle",
      "key": "badge",
      "type": "circle",
      "position": {
        "x": 300,
        "y": 110
      },
      "rotation": 0,
      "size": {
        "width": 200,
        "height": 200
      },
      "dynamic": true,
      "properties": {
        "fillColor": "#F59E0B",
        "opacity": 1
      }
    }
  ]
}
```

## Examples

### Notification count badge

A red circle sized to carry an imagined unread-count number on an app screenshot.

API overrides that reproduce this example:

```json
{
  "badge.fillColor": "#EF4444",
  "badge.boxShadow": "0 4px 12px rgba(239,68,68,0.4)"
}
```

### Brand accent orb

A glowing indigo orb used as a decorative backdrop element on a dark OG image.

API overrides that reproduce this example:

```json
{
  "badge.fillColor": "#6366F1",
  "badge.boxShadow": "0 0 60px rgba(99,102,241,0.6)"
}
```

## API overrides

Recolor per render with '<key>.fillColor' (or just '<key>'); opacity and borderColor are overridable too.

Flat override payload (`key.property` addressing) with the sample design's current values — send only the keys you want to change:

```json
{
  "badge.fillColor": "#F59E0B",
  "badge.opacity": 1
}
```

```bash
curl --location 'https://render.imejis.io/v1/{{YOUR_DESIGN_ID}}' \
--header 'dma-api-key: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
    "badge.fillColor": "#F59E0B",
    "badge.opacity": 1
}'
```

`{{YOUR_DESIGN_ID}}` and `{{YOUR_API_KEY}}` are placeholders: first create
the design in your account (paste the sample design JSON above into the
editor at https://app.imejis.io, or create it programmatically via the
imejis MCP server's `create_design` + `update_design` tools), then render
it with the design's id and one of your API keys.

Agents: the MCP server at https://api.imejis.io/api/mcp exposes this same
catalog as structured data via the `list_component_types` tool (property
kinds, allowed values, bounds, ready-to-use sample designs).

## Frequently Asked Questions

### Can I recolor the circle per API call?

Yes — '<key>.fillColor' (or just the key) sets the color per render; opacity and border properties are overridable too.

### How is the circle sized?

It fills its component box by default, or set the radius property for an explicit pixel radius.

### How do I make a ring instead of a solid circle?

Use a transparent fillColor with a thick borderWidth and borderColor — the Ring variant shows exactly this setup.

## Variants

- [Ring](https://www.imejis.io/components/circle/ring.md) — Transparent fill with a thick border — avatar frames and focus accents.
- [Dot](https://www.imejis.io/components/circle/dot.md) — A small solid dot — status indicators and bullet accents.

All components: https://www.imejis.io/components.md