Compose a private card
compose_private_cardCreate a new immutable card face from this scope’s artwork, logo or QR URL. Requires at least one of those inputs; a QR-only face needs no upload. Returns design_key and design_version for prepare_order or revise_order. Personal message, recipient and mailing details are supplied in the order’s cards array. Reuse an existing composition when no new face is needed.
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": {
"scope_id": "<scope_id>",
"order_access_token": "<order_access_token>",
"composition_id": "<composition_id>",
"title": "<title>"
},
"name": "compose_private_card"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Short private name for this card, shown to the buyer only. | |
| qr_url | No | Full HTTP(S) destination printed as a QR code; Paddock does not fetch it. A QR-only card needs no uploaded asset. | |
| scope_id | Yes | Exact scope_id returned by open_private_content. All supplied asset IDs must belong to this scope. | |
| logo_asset_id | No | asset_id with kind logo from read_private_content in this scope. Optional when artwork_asset_id or qr_url is supplied. | |
| composition_id | Yes | Caller-generated UUID for this composition. Retrying with the same ID and identical fields returns the same card (reused: true); the same ID with different fields is CONFLICT, so use a new UUID for a different card. | |
| artwork_asset_id | No | asset_id with kind artwork from read_private_content in this scope. Supply at least one artwork asset, logo asset or QR URL. | |
| order_access_token | Yes | Exact private order_access_token returned by open_private_content for this scope. Keep it private and never invent one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | Yes |