Start shoot
start_shootStarts a shoot: one new frame of the product in the scene's style, on the scene's model, or the product alone for a placement scene (kind lifestyle). Each call uses one frame (two on a ghost mannequin) from the store's plan, so ask the person before starting shoots they did not ask for, and pass a request_id so a retry does not shoot twice. Pass notes to say how the product is worn or presented; notes never change the model or the scene. Returns at once with the frame queued; call get_shoot with its id to wait for the result.
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": {
"product_id": "<product_id>",
"source_image_id": "<source_image_id>",
"scene_id": "<scene_id>"
},
"name": "start_shoot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | A short styling note: how to wear the product on a model, or how to present it in a product shot. | |
| scene_id | Yes | A ready scene id from list_scenes, of a kind the product's shoot_routes allow. | |
| product_id | Yes | The product id from list_products. | |
| request_id | No | Any unique string for this shoot. Repeating a call with the same request_id within 24 hours returns the first result instead of starting and charging a second shoot. | |
| regenerate_of | No | A frame id, to shoot that frame again. | |
| source_image_id | Yes | The id of one of the product's photos (get_product). | |
| garment_photo_type | No | flat-lay (the default) when the photo shows the product alone, model when someone is wearing it. Ignored for a placement scene. |