Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.diagrams.export.create("landscapeId", "versionId", "diagramId", {
        body: {},
    });
}
main();

{
  "diagramExportImage": {
    "createdAt": "2024-01-15T09:30:00Z",
    "deleteAt": "2024-01-15T09:30:00Z",
    "diagramId": "string",
    "error": "string",
    "fileUrls": {
      "png": "string",
      "svg": "string"
    },
    "id": "string",
    "landscapeId": "string",
    "options": {
      "draftId": "string",
      "flowId": "string",
      "flowPathIds": [
        "string"
      ],
      "focusIds": [
        "string"
      ],
      "groupId": "string",
      "hideIds": [
        "string"
      ],
      "maxWidth": 1,
      "pinIds": [
        "string"
      ],
      "tab": "tags",
      "theme": "light"
    },
    "versionId": "string",
    "completedAt": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramIdstringRequired

Request

This endpoint expects an object.

draftIdstringOptional

Fetch and apply draft tasks before producing the export

flowIdstringOptional

flowPathIdslist of stringsOptional

focusIdslist of stringsOptional

groupIdstringOptional

hideIdslist of stringsOptional

maxWidthintegerOptional100-10240

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).

pinIdslist of stringsOptional

tabenumOptional

themeenumOptional

Response

diagramExportImageobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error