---
title: "Create"
method: POST
path: "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image"
tags: ["Diagrams"]
---

# Create

`POST /landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image`

## Request

- Base URL: `https://api.icepanel.io/v1`
- URL: `https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

## Path parameters

- `landscapeId` string, required
- `versionId` string, required
- `diagramId` string, required

## Request body

- DiagramExportImageOptions
  - `draftId` string: Fetch and apply draft tasks before producing the export
  - `flowId` string
  - `flowPathIds` string[]
  - `focusIds` string[]
  - `groupId` string
  - `hideIds` string[]
  - `maxWidth` integer: Maximum pixel width for the exported PNG. The image will be scaled down if the diagram exceeds this width. Defaults to no limit (up to 10240px).
  - `pinIds` string[]
  - `tab` 'tags' | 'technology' | 'status' | 'teams'
  - `theme` 'light' | 'dark'

## Response `200`

OK

- object
  - `diagramExportImage` DiagramExportImage, required
    - `completedAt` string, date-time
    - `createdAt` string, date-time, required
    - `deleteAt` string, date-time, required
    - `diagramId` string, required
    - `error` string, nullable, required
    - `fileUrls` DiagramExportImageFileUrls, required
      - `png` string, uri, required
      - `svg` string, uri, required
    - `id` string, required
    - `landscapeId` string, required
    - `options` DiagramExportImageOptions, required
      - `draftId` string: Fetch and apply draft tasks before producing the export
      - `flowId` string
      - `flowPathIds` string[]
      - `focusIds` string[]
      - `groupId` string
      - `hideIds` string[]
      - `maxWidth` integer: Maximum pixel width for the exported PNG. The image will be scaled down if the diagram exceeds this width. Defaults to no limit (up to 10240px).
      - `pinIds` string[]
      - `tab` 'tags' | 'technology' | 'status' | 'teams'
      - `theme` 'light' | 'dark'
    - `versionId` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Resource Exhausted
- `500`: Internal Server

## Changes

- **2026-07-22** `0fe4f00b60cf`: 1 info
  - added the non-success response with the status `429`
- **2026-06-03** `181c90adca5e`: 4 info
  - added the new optional request property `maxWidth`
  - added the non-success response with the status `400`
  - added the non-success response with the status `403`
  - added the optional property `diagramExportImage/options/maxWidth` to the response with the `200` status

[Operation history](https://skmtc.dev/icepanel/apis/icepanel-api/changes/landscapes/:landscapeId/versions/:versionId/diagrams/:diagramId/export/image/post.md)

---

[API](https://skmtc.dev/icepanel/apis/icepanel-api.md) - [All operations](https://skmtc.dev/icepanel/apis/icepanel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/icepanel/apis/icepanel-api/revisions/7d1119835bbb?raw)
