---
title: "Ring Shape API — Circle outlines & avatar frames | Imejis"
description: "A transparent circle with a thick border — avatar frames and focus accents — with the ring color set on every API call. Create ring visuals for free."
url: "https://www.imejis.io/components/circle/ring"
---

# Ring Shape API — Circle outlines & avatar frames | Imejis

Transparent fill with a thick border — avatar frames and focus accents.

## Use cases

- Avatar frames on profile cards
- Highlight rings around key content
- Decorative brand accents

## 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)". |

## Design JSON (this variant)

```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": "transparent",
        "opacity": 1,
        "borderWidth": 10,
        "borderColor": "#4F46E5",
        "borderStyle": "solid"
      }
    }
  ]
}
```

## Examples

### Gold avatar frame

An amber ring sized to frame an imagined profile photo on a speaker announcement card.

API overrides that reproduce this example:

```json
{
  "badge.fillColor": "transparent",
  "badge.borderWidth": 8,
  "badge.borderColor": "#F59E0B",
  "badge.borderStyle": "solid"
}
```

### Focus ring on dark

A cyan highlight ring drawing the eye to an imagined feature screenshot on a dark canvas.

API overrides that reproduce this example:

```json
{
  "badge.fillColor": "transparent",
  "badge.borderWidth": 6,
  "badge.borderColor": "#22D3EE",
  "badge.borderStyle": "solid"
}
```

## 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).

## Related

- [Circle component](https://www.imejis.io/components/circle.md) — full reference and FAQs
- [Dot](https://www.imejis.io/components/circle/dot.md) — A small solid dot — status indicators and bullet accents.