# Get template builder capabilities

> Tells you what the organization can use before you call the other builder routes: builder (visual builder, Scale plan), ai_available and the monthly AI quota (ai.used, ai.remaining), the saved…

Source: https://docs.pidgely.com/api-reference/template-builder/capabilities/

`GET https://api.pidgely.com/template-builder`

Tells you what the organization can use before you call the other builder routes: `builder` (visual builder, Scale plan), `ai_available` and the monthly AI quota (`ai.used`, `ai.remaining`), the saved theme and brand profile, and whether [brand import](https://docs.pidgely.com/api-reference/templates/import-brand/) is available. Works on every plan.

Available on every plan, so a client can check `builder` and `ai_available` before calling the builder or AI routes. Full access API keys.

**Authorization:** `Bearer pdg_…`. An API key with `full_access`. A `sending_access` key gets `401 restricted_api_key`.

## Request

This endpoint is in the Node.js SDK; the other [SDKs](https://docs.pidgely.com/sdks/) don't cover it yet, so call it over HTTP from them.

```js tab="Node.js"
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.templateBuilder.capabilities();
console.log(data ?? error);
```

```bash tab="cURL"
curl -X GET 'https://api.pidgely.com/template-builder' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"
```

## Response

`200 OK`

```json
{
  "object": "template_builder",
  "plan": "plan",
  "required_plan": "required_plan",
  "builder": false,
  "ai_available": false,
  "ai": {
    "enabled": false,
    "model": "model",
    "monthly_quota": 1,
    "used": 1,
    "remaining": 1,
    "per_minute": 1
  },
  "theme": {
    "brand_color": "brand_color",
    "text_color": "text_color",
    "background_color": "background_color",
    "content_color": "content_color",
    "link_color": "link_color",
    "font": "system",
    "content_width": 480,
    "radius": 0,
    "logo_url": "logo_url",
    "logo_width": 1,
    "logo_alt": "logo_alt",
    "logo_align": "left",
    "logo_dark_url": "logo_dark_url",
    "button_text_color": "button_text_color",
    "web_font": "web_font",
    "heading_font": "system",
    "heading_web_font": "heading_web_font"
  },
  "theme_saved": false,
  "brand": {
    "name": "Example",
    "website": "website",
    "address": "address",
    "socials": [
      {
        "network": "x",
        "url": "https://acme.com/webhooks/pidgely"
      }
    ],
    "imported_from": "imported_from"
  },
  "brand_saved": false,
  "brand_import": false,
  "suggested_website": "suggested_website"
}
```

### Response fields

| Name | Type | Required | Description |
|---|---|---|---|
| `object` | string | Yes | Object type. One of `template_builder`. |
| `plan` | string | Yes | — |
| `required_plan` | string | Yes | — |
| `builder` | boolean | Yes | The organization's plan includes the visual builder. |
| `ai_available` | boolean | Yes | AI assist is configured on the server and included in the plan. |
| `ai` | object | Yes | — |
| `ai.enabled` | boolean | Yes | — |
| `ai.model` | string | No | — |
| `ai.monthly_quota` | integer | Yes | — |
| `ai.used` | integer | Yes | — |
| `ai.remaining` | integer | Yes | — |
| `ai.per_minute` | integer | Yes | — |
| `theme` | object | Yes | Global look of a builder e-mail. Colors are hex (`#rrggbb`). |
| `theme.brand_color` | string | No | — |
| `theme.text_color` | string | No | — |
| `theme.background_color` | string | No | — |
| `theme.content_color` | string | No | Background of the content card. |
| `theme.link_color` | string | No | — |
| `theme.font` | string | No | One of `system`, `inter`, `helvetica`, `georgia`, `verdana`, `trebuchet`. |
| `theme.content_width` | integer | No | Between 480 and 800. |
| `theme.radius` | integer | No | Between 0 and 32. |
| `theme.logo_url` | string | No | — |
| `theme.logo_width` | integer | No | — |
| `theme.logo_alt` | string | No | — |
| `theme.logo_align` | string | No | One of `left`, `center`, `right`. |
| `theme.logo_dark_url` | string | No | Logo variant shown in dark mode by clients that support it (Apple Mail, iOS); others keep `logo_url`. |
| `theme.button_text_color` | string | No | Label color of buttons on the brand color; empty picks white or near-black automatically. |
| `theme.web_font` | string | No | Google Fonts family loaded where e-mail clients support web fonts; `font` is the fallback stack. |
| `theme.heading_font` | string | No | Heading stack (empty = `font`). One of `system`, `inter`, `helvetica`, `georgia`, `verdana`, `trebuchet`. |
| `theme.heading_web_font` | string | No | Google Fonts family for headings (empty = `web_font`). |
| `theme_saved` | boolean | Yes | — |
| `brand` | object | Yes | The organization's identity used by AI assist (sender name, links, footer) and the brand import. |
| `brand.name` | string | No | Display name. |
| `brand.website` | string | No | — |
| `brand.address` | string | No | Postal address shown in footers. |
| `brand.socials` | object[] | No | — |
| `brand.socials[].network` | string | Yes | One of `x`, `linkedin`, `instagram`, `facebook`, `youtube`, `github`, `tiktok`, `discord`, `website`. |
| `brand.socials[].url` | string | Yes | Public `https` URL that receives the events. |
| `brand.imported_from` | string | No | Page the brand was imported from. |
| `brand_saved` | boolean | Yes | — |
| `brand_import` | boolean | Yes | Brand import is available (builder plan). |
| `suggested_website` | string | Yes | Root site of the first verified sending domain ("" when none). |

## Errors

Errors have the shape `{"statusCode", "name", "message"}`. See [Errors](https://docs.pidgely.com/errors/) for the full list.

| Status | Name | When |
|---|---|---|
| 401 | `missing_api_key`, `restricted_api_key` | No `Authorization: Bearer` header, or a `sending_access` key called an endpoint that needs `full_access`. |
| 429 | `rate_limit_exceeded` | Too many requests per second. Wait for `Retry-After` seconds. |