Generate Description | IcePanel Developer Docs

Generate a description for a model connection

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

landscapeIdstringRequired

versionIdstringRequired

modelConnectionIdstringRequired

This endpoint expects an object.

typeenumRequired

Type of description to generate: “caption” for a short caption(50-70 characters), or “detailed” for a detailed description (max 2000 characters)

Allowed values:

descriptionstring

AI-generated description of the model connection

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error

1	import { IcePanelClient } from "@icepanel/sdk";
2
3	async function main() {
4	const client = new IcePanelClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.model.connections.generateDescription("landscapeId", "versionId", "modelConnectionId", {
8	type: "caption",
9	});
10	}
11	main();