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"
      ],
      "pinIds": [
        "string"
      ],
      "tab": "tags",
      "theme": "light"
    },
    "versionId": "string",
    "completedAt": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-API-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

pinIdslist of stringsOptional

tabenumOptional

Allowed values:

themeenumOptional

Allowed values:

Response

diagramExportImageobject

Authentication

Path parameters

Request

Response

Errors