redeem_scribe_unlock_code
Consume a user-supplied single-use code to unlock one clean video.
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": {
"animation_id": "<animation_id>",
"access_token": "<access_token>",
"unlock_code": "<unlock_code>"
},
"name": "redeem_scribe_unlock_code"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unlock_code | Yes | ||
| access_token | Yes | ||
| animation_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | Yes | ||
| stage | Yes | Short user-facing description of current work. | |
| status | Yes | Current asynchronous job state. | |
| unlock | Yes | ||
| progress | Yes | Approximate percent complete. | |
| unlocked | Yes | ||
| clean_url | Yes | ||
| created_at | Yes | ||
| expires_at | Yes | ||
| manage_url | Yes | Private browser handoff URL for user review and unlock. | |
| status_url | Yes | ||
| preview_url | Yes | ||
| animation_id | Yes | Canonical UUID for this animation. | |
| purchase_url | Yes | ||
| terms_version | Yes | ||
| retention_hours | Yes | ||
| seconds_remaining | Yes | ||
| clean_download_available | Yes | ||
| preview_download_available | Yes |