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

# Configuration

> Configure Apiary Embed for Confluence

There's no site-wide settings screen. Each macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## Apiary Embed (raw code) macro

Renders an Apiary API Project from the exact embed script Apiary generates for it.

| Field          | Required | Notes                                                                                                                                                                                            |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Height**     | Yes      | Fixed iframe height for the embed, e.g. `1048px`. Default: `1048px`                                                                                                                              |
| **Embed code** | Yes      | The full snippet from Apiary's embed generator, pasted as-is — for example `var embed = new Apiary.Embed({"subdomain": "pollsapi"});`. Not validated — invalid code fails silently in the viewer |

<Frame>
  <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/apiary-confluence/images/macro-config-raw.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=ffb7873d7e4e89e467e3f6ffe84f8d61" alt="Apiary Embed (raw code) macro configuration form" width="1170" height="676" data-path="apiary-confluence/images/macro-config-raw.png" />
</Frame>

## Apiary Embed (generate code) macro

Builds the embed for you from a subdomain and a set of display toggles, instead of requiring the raw script.

| Field                                      | Required | Notes                                                                          |
| ------------------------------------------ | -------- | ------------------------------------------------------------------------------ |
| **Height**                                 | Yes      | Fixed iframe height for the embed. Default: `1048px`                           |
| **Subdomain**                              | Yes      | The API Project's subdomain, set in the Apiary project's settings              |
| **Show Console** (Basics)                  | No       | Default: on. Shows the request console in the machine column                   |
| **Display HTTP Methods** (Basics)          | No       | Default: off. Shows HTTP method names in the human column's action buttons     |
| **Collapse the Machine Column** (Advanced) | No       | Default: off. Hides the machine column by default when the documentation opens |
| **Display URI Parameters** (Advanced)      | No       | Default: off. Shows URI parameters in the human column                         |

<Frame>
  <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/apiary-confluence/images/macro-config-generate.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=7291ea105bfb7d99a16300613e5fb78f" alt="Apiary Embed (generate code) macro configuration form" width="1170" height="914" data-path="apiary-confluence/images/macro-config-generate.png" />
</Frame>

## Permissions

Anyone with edit access to a Confluence page can insert either macro and change its configuration. Page viewers without edit access only see the rendered output.