Get the image upload page
design_get_image_upload_pageReturn a browser page for uploading the user's own logo or photo.
Call when the user wants to add an image and this client cannot receive its bytes;
never ask for a local file path or claim images cannot be accepted.
Pass design_id for an existing design. Otherwise pass order_id for an order
already created in this session, before design_generate_candidates, and
item_id when that order has several items. On an
order with several items, an item whose design is already attached fails with
DesignAttachedError, because that design is final. An item whose uploaded file
has a submitted page mapping fails with UploadMappingSubmittedError.
Compass reuses a design for that order or creates an upload-only target;
a newly created target must not be used with design_chat.
The page attaches the image to the session for the next design_chat or
design_generate_candidates call.
Put the returned url in your reply as a markdown hyperlink (never the raw URL) and
tell the customer to open it and drop their image. When the upload card is displayed,
it shows an "Open upload page" button wired to the url, so just tell the customer to
open it and share the url again only if the customer asks for it.
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": {
"session_id": "<session_id>"
},
"name": "design_get_image_upload_page"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | No | ||
| order_id | No | ||
| design_id | No | ||
| session_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |