Set item images
set_item_imagesPut one specific image, chosen by its id, on texts of the activity, without touching the text or its audio. Only for an image the user pointed at: one of their own files (list_my_media) or a candidate they chose from search_image_library. When the user simply wants images on their texts, use illustrate_items, which finds them by itself. Call it ONLY when the user asked for images in their own words. Which texts can hold an image depends on the type: "media_targets.image" in the activity state lists them (for example question and choice, or word, hint, definition, card). Send the text of that exact element copied from get_activity_content: to illustrate a choice send the choice, to illustrate a question send the question. A text that already has an image keeps it unless existing is "replace"; one with a video or a youtube link is always left untouched. The result says, for every image, which element and which item it went to.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| images | Yes | One entry per text that must get an image. | |
| existing | Yes | What happens to a text that already has an image. "keep": it is left untouched; the value for every request to ADD an image. "replace": its image is replaced by this one and the old one is discarded, and texts without an image are left as they are; ONLY when the user asked to change or replace the image of those very texts. | |
| activity_id | Yes | Id of the activity. |