Skip to main content
POST
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
model
/
connections
/
{modelConnectionId}
/
generate-description
Generate Description
curl --request POST \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/connections/{modelConnectionId}/generate-description \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "caption"
}
'
{
  "description": "<string>",
  "message": "<string>"
}

Headers

​
Authorization
string
required

Path Parameters

​
landscapeId
string
required
​
versionId
string
required
​
modelConnectionId
string
required

Body

application/json
​
type
enum<string>
required

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

Available options:
caption,
detailed

Response

OK

​
description
string
required

AI-generated description of the model connection

​
message
string
required

Success message from the AI API