Frame an image
apply_frame[writes flayr data · write scope] Draws a frame over an image and returns a new image URL (the original is untouched). Use the URL in create_content, or pass contentId + platform so that post publishes the framed image on that platform. Free by default; the same inputs again are free.
(Wraps POST /api/v2/frames/apply.)
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": {
"sourceUrl": "<sourceUrl>",
"frameRef": "<frameRef>"
},
"name": "apply_frame"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fit | No | ||
| zoom | No | ||
| texts | No | Texts some frames print (ribbon/tag label, lower-third title/subtitle). | |
| aspect | No | Default: nearest to the source image. | |
| offsetX | No | ||
| offsetY | No | ||
| frameRef | Yes | `default:<key>` or `brand:<id>` from GET /api/v2/frames. | |
| platform | No | Platform this framed image is for ("all" by default). | |
| contentId | No | A content id: its publish swaps this framed image in for `platform`. | |
| sourceUrl | Yes | https image URL (flayr/Convex storage or a stock host). | |
| slideIndex | No | Image position in the post. | |
| paletteOverride | No | Colors that win over the brand kit. |