Generate hero image
generate_hero_imageGenerates a new hero image for the article of one content calendar topic of a site with Image Studio, and replaces the article’s hero image with it. Keytomic uses the article, the site’s Image Studio settings and its default brand assets; creativeDirection and exclusions guide the image. Each image uses 1 Blog Hero Credit. Without confirm, returns the plan and starts nothing (status plan): the article title and the Blog Hero Credits left. Show the plan to the user, and call again with confirm: true only after the user agrees. With confirm: true, reads the plan again, generates the image and attaches it to the article (status attached). When Keytomic generates the image but cannot attach it, the result says so (status generated_not_attached): the image is in the Image Studio Media Library, the credit is used, and the user can attach it in Content Studio. If the call with confirm: true times out, read the article with get_draft (or the topic with list_calendar_topics with topicId) before you call this tool again: the image can still finish and attach on the server, and a second call uses a second Blog Hero Credit. When the site cannot generate an image now, both calls answer a tool error and use nothing: a topic without an article (draft_not_found), a topic the workspace cannot open (topic_not_in_plan), missing Image Studio settings, a Spend Lock, or no Blog Hero Credits left.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectId": "<projectId>",
"topicId": "<topicId>"
},
"name": "generate_hero_image"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | true starts the image generation. Send it only after the user saw the plan this tool returns without confirm and agreed. Without it, the tool returns the plan and starts nothing. | |
| topicId | Yes | Topic whose article gets the hero image, from list_calendar_topics. | |
| projectId | Yes | Site to act on, from list_sites. | |
| exclusions | No | What the image must not show, up to 2,000 characters, such as "no text, no people". | |
| creativeDirection | No | What the image shows or how it looks, up to 2,000 characters, such as "a baker shaping dough at sunrise". Without it, Keytomic takes the direction from the article and the site’s Image Studio settings. |