# API endpoint OG image template

HTTP method badge, the path in a monospace bar with its parameters highlighted, a description and the request fields.

- Slug: `api-endpoint`
- Preview (real render): https://shareglint.com/img/templates/api-endpoint.jpg
- Page: https://shareglint.com/en/templates/api-endpoint

For API references and developer docs: a card per endpoint that tells people what they are about to open. The method picks its own colour — GET green, POST blue, PUT and PATCH amber, DELETE red — and `{id}` or `:id` segments of the path are drawn in your accent colour. Light by default, like most docs.

## Fields

Every field is optional. Long text shrinks to fit instead of overflowing; an image field takes a public URL that we fetch on our side.

| Field | Type | Description | Example |
|---|---|---|---|
| `method` | text | HTTP method, e.g. GET or POST. (default: GET) | POST |
| `path` | text | Endpoint path, e.g. /v1/images/{id}. (default: /v1/resource) | /v1/projects/{project_id}/images |
| `description` | text | What the endpoint does, one or two sentences. | Render an image from a template and get back the URL of the finished file. |
| `params_label` | text | Label before the parameters, e.g. Params. (default: Params) | — |
| `params` | text | Parameter names separated by commas. | template, modifications, size, format |
| `product` | text | API or docs name next to the logo. | Northwind API |
| `version` | text | API version in the corner, e.g. v1. | v1 |
| `site` | text | Your domain or a short URL. | docs.northwind.dev |
| `logo` | image URL | Logo image. | https://example.com/images/logo-northwind.png |
| `accent` | colour | Brand colour as hex, e.g. #6366f1. Drives buttons, highlights and the background glow. (default: #7c3aed) | #7c3aed |
| `theme` | dark | light | Colour scheme: dark or light. (default: light) | — |

## Render it with one request

```bash
curl -X POST "https://shareglint.com/v1/images?wait=true" \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "api-endpoint",
    "modifications": {
        "method": "POST",
        "path": "/v1/projects/{project_id}/images",
        "description": "Render an image from a template and get back the URL of the finished file.",
        "params": "template, modifications, size, format",
        "product": "Northwind API",
        "version": "v1",
        "site": "docs.northwind.dev",
        "logo": "https://example.com/images/logo-northwind.png"
    }
}'
```

## Make it yours

accent and theme change per request. For anything more, copy the template into your account: you get an ordinary HTML template with the same fields that you can edit in the dashboard or through the API. If the slug is free on your account, the copy takes it — your integrations switch to your version without changing a line.

```bash
curl -X POST "https://shareglint.com/v1/templates/library/api-endpoint/copy" -H "Authorization: Bearer sk_live_YOUR_KEY"
```