> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/canvas/getcanvasdecklayer.md).

# Get one layer of a deck slide

Get one layer of a deck slide with the FLORA API: GET /workspaces/{workspaceId}/projects/{projectId}/nodes/{nodeId}/document/slides/{slideId}/layers/{layerId}.

Returns a single layer of one slide on a deck node's authored document — its transform, blend and content — plus the document revision. Deck nodes only; an unknown node, slide or layer id returns not\_found.

```http
GET https://app.flora.ai/api/v1/workspaces/{workspaceId}/projects/{projectId}/nodes/{nodeId}/document/slides/{slideId}/layers/{layerId}
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](https://docs.flora.ai/api/platform/authentication.md).
* **TypeScript SDK:** `client.projects.canvas.getDeckLayer()`.
* **Operation ID:** `getCanvasDeckLayer`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET 'https://app.flora.ai/api/v1/workspaces/ws_abc123/projects/prj_abc123/nodes/n7/document/slides/sl_abc123/layers/ly_abc123' \
  -H "Authorization: Bearer $FLORA_API_KEY"
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const canvas = await client.projects.canvas.getDeckLayer({
  workspaceId: 'ws_abc123',
  projectId: 'prj_abc123',
  nodeId: 'n7',
  slideId: 'sl_abc123',
  layerId: 'ly_abc123',
});
console.log(canvas);
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name          | Type   | Required | Description                                                                                                   |
| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------- |
| `workspaceId` | string | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`.                                              |
| `projectId`   | string | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`.                                              |
| `nodeId`      | string | Yes      | The node's short id or UUID, as the project graph endpoint reports them. At least 1 character. Example: `n7`. |
| `slideId`     | string | Yes      | Slide id on the deck. At least 1 character. Example: `sl_abc123`.                                             |
| `layerId`     | string | Yes      | Layer id on the slide. At least 1 character. Example: `ly_abc123`.                                            |

## Responses

### 200: Layer returned.

| Field        | Type    | Required | Description                                                                              |
| ------------ | ------- | -------- | ---------------------------------------------------------------------------------------- |
| `project_id` | string  | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`.                         |
| `id`         | string  | Yes      | Short node identifier. At least 1 character. Example: `n7`.                              |
| `node_id`    | string  | Yes      | Canvas node UUID. At least 1 character. Example: `7f6ae6da-4a0e-4a2f-9c6a-2c1c6b8d1f21`. |
| `revision`   | integer | Yes      | Current document revision; pass as base\_revision on a changeset update.                 |
| `slide_id`   | string  | Yes      | Slide the layer belongs to. At least 1 character.                                        |
| `layer`      | object  | Yes      | See the `layer` shapes below.                                                            |

<details>

<summary>layer shapes</summary>

Field paths in this block are relative to `layer`.

`layer` takes one of 3 shapes, set by `content_type`.

Fields every shape has:

| Field                  | Type          | Required | Description                                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                   | string        | Yes      | 1 to 128 characters.                                                                                                                                                                                                                                                                                                                                                                        |
| `name`                 | string        | No       | Default: `""`.                                                                                                                                                                                                                                                                                                                                                                              |
| `visible`              | boolean       | No       | Default: `true`.                                                                                                                                                                                                                                                                                                                                                                            |
| `locked`               | boolean       | No       |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform`            | object        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.position`   | object        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.position.x` | number        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.position.y` | number        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.scale`      | object        | Yes      | Dimensionless size multipliers. Text uses frame.pixel\_width by round(font\_size \* 7.5) as its reference box (font\_size defaults to 144); shapes use 512 by 512; media uses its resolved source dimensions. Divide the desired pixel width and height by the reference dimensions. For a 1200 by 240 text box at font\_size 96 on a 1920-wide frame, use x: 0.625, y: 0.3333333333333333. |
| `transform.scale.x`    | number        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.scale.y`    | number        | Yes      |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.rotation`   | number        | No       |                                                                                                                                                                                                                                                                                                                                                                                             |
| `transform.opacity`    | number        | No       | 0 to 1.                                                                                                                                                                                                                                                                                                                                                                                     |
| `blend_mode`           | string        | No       | One of: `normal`, `dissolve`, `darken`, `multiply`, `color-burn`, `linear-burn`, `darker-color`, `lighten`, `screen`, `color-dodge`, `linear-dodge`, `lighter-color`, `overlay`, `soft-light`, `hard-light`, `vivid-light`, `linear-light`, `pin-light`, `hard-mix`, `difference`, `exclusion`, `subtract`, `divide`, `hue`, `saturation`, `color`, `luminosity`.                           |
| `fill`                 | string        | No       |                                                                                                                                                                                                                                                                                                                                                                                             |
| `adjustments`          | map of number | No       |                                                                                                                                                                                                                                                                                                                                                                                             |

Fields that depend on the shape:

**Shape 1: `content_type` is `text`.**

| Field                           | Type           | Required | Description                                                                           |
| ------------------------------- | -------------- | -------- | ------------------------------------------------------------------------------------- |
| `content_type`                  | string         | Yes      | Always `text`.                                                                        |
| `content`                       | object         | Yes      | See the `layer.content` shapes below.                                                 |
| `text_data`                     | object         | No       | Typography only; the rendered text or live binding belongs in content. Default: `{}`. |
| `text_data.font_family`         | string         | No       |                                                                                       |
| `text_data.font_size`           | number         | No       | At least 0.                                                                           |
| `text_data.text_color`          | string         | No       |                                                                                       |
| `text_data.font_weight`         | number         | No       | 1 to 1000.                                                                            |
| `text_data.font_style`          | string         | No       | One of: `normal`, `italic`.                                                           |
| `text_data.text_align`          | string         | No       | One of: `left`, `center`, `right`.                                                    |
| `text_data.text_vertical_align` | string         | No       | One of: `top`, `middle`, `bottom`.                                                    |
| `text_data.line_height`         | number or null | No       | At least 0.                                                                           |
| `text_data.letter_spacing`      | number         | No       |                                                                                       |
| `text_data.kerning`             | map of number  | No       |                                                                                       |
| `text_data.custom_font_id`      | string         | No       |                                                                                       |
| `text_data.auto_width`          | boolean        | No       |                                                                                       |

**Shape 2: `content_type` is `shape`.**

| Field           | Type   | Required | Description                             |
| --------------- | ------ | -------- | --------------------------------------- |
| `content_type`  | string | Yes      | Always `shape`.                         |
| `primitive`     | string | Yes      | One of: `square`, `circle`, `triangle`. |
| `shape_color`   | string | Yes      |                                         |
| `line`          | object | No       |                                         |
| `line.cap`      | string | No       | Always `round`.                         |
| `corner_radius` | number | No       | At least 0.                             |

**Shape 3: `content_type` is `image`.**

| Field                      | Type              | Required | Description                            |
| -------------------------- | ----------------- | -------- | -------------------------------------- |
| `content_type`             | string            | Yes      | Always `image`.                        |
| `source`                   | object            | Yes      | See the `layer.source` shapes below.   |
| `source_dimensions`        | object            | No       |                                        |
| `source_dimensions.width`  | number            | Yes      | At least 0.                            |
| `source_dimensions.height` | number            | Yes      | At least 0.                            |
| `fit`                      | string            | No       | One of: `contain`, `cover`, `stretch`. |
| `video`                    | object            | No       |                                        |
| `video.autoplay`           | boolean           | No       |                                        |
| `model3d`                  | object            | No       |                                        |
| `model3d.view_state`       | map of JSON value | No       |                                        |
| `model3d.auto_rotate`      | boolean           | No       |                                        |

`layer.content` takes one of 2 shapes, set by `kind`.

**Shape 1: `kind` is `node_output`.**

| Field                | Type   | Required | Description                                                                                                                              |
| -------------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `content.kind`       | string | Yes      | Always `node_output`.                                                                                                                    |
| `content.node_id`    | string | Yes      | Source node UUID or short id in this project, or a node ref declared in the same request. Read responses use UUIDs. 1 to 128 characters. |
| `content.output_key` | string | No       |                                                                                                                                          |

**Shape 2: `kind` is `inline`.**

| Field          | Type   | Required | Description      |
| -------------- | ------ | -------- | ---------------- |
| `content.kind` | string | Yes      | Always `inline`. |
| `content.text` | string | Yes      |                  |

`layer.source` takes one of 2 shapes, set by `kind`.

**Shape 1: `kind` is `node_output`.**

| Field               | Type   | Required | Description                                                                                                                              |
| ------------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `source.kind`       | string | Yes      | Always `node_output`.                                                                                                                    |
| `source.node_id`    | string | Yes      | Source node UUID or short id in this project, or a node ref declared in the same request. Read responses use UUIDs. 1 to 128 characters. |
| `source.output_key` | string | No       |                                                                                                                                          |

**Shape 2: `kind` is `asset`.**

| Field             | Type   | Required | Description                                     |
| ----------------- | ------ | -------- | ----------------------------------------------- |
| `source.kind`     | string | Yes      | Always `asset`.                                 |
| `source.asset_id` | string | Yes      | Flora asset id (asset\_…). 1 to 128 characters. |

</details>

## Errors

Every error has the same body: `error.code`, `error.message`, and `error.fields` on validation errors. See [Errors](https://docs.flora.ai/api/platform/errors.md) for how to recover from each code.

| Status | Code                                         | Meaning                                                                             |
| ------ | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| 400    | `invalid_json`, `input_validation_error`     | The body isn't valid JSON, or an input failed validation (`fields` lists each one). |
| 401    | `unauthorized`, `invalid_api_key`            | The API key is missing, invalid or revoked.                                         |
| 402    | `insufficient_credits`                       | The workspace balance is too low for this request.                                  |
| 403    | `forbidden`, `paid_plan_required`            | The key can't do this, or the workspace plan doesn't include it.                    |
| 404    | `not_found`                                  | The resource doesn't exist or isn't visible to this key.                            |
| 409    | `idempotency_duplicate`, `revision_conflict` | Duplicate `Idempotency-Key` or a stale `base_revision`.                             |
| 429    | `rate_limited`                               | Too many requests. Back off and retry.                                              |
| 500    | `unknown_error`, `internal_error`            | Something failed on FLORA's side. Retry with backoff.                               |
| 503    | `temporarily_unavailable`                    | Authorization is temporarily unavailable. Retry later.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/canvas/getcanvasdecklayer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
