Download an artifact
download_artifactMints a fresh download URL (valid 10 minutes) for any artifact on the board: mascot, prop, pose (PNG) or animation (MP4). Use the ids from get_board, and fetch the URL promptly, for example with curl, to save the file into the repository. Pass background:"none" for a transparent PNG, which is usually what you want when placing a mascot onto an app screen. The first transparent request for an artifact takes a few seconds while the cutout is made; every request after it is instant, so wait rather than retry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The artifact id from get_board. | |
| kind | Yes | What the id refers to: mascot, prop, pose or animation. Use the same kind the id came from in get_board. | |
| background | No | Which copy to download. "original" keeps the backdrop the artwork was drawn on. "none" returns a transparent PNG with the subject cut out, which is what you want for placing a mascot onto a screen. Not available for animations, since MP4 cannot carry an alpha channel. | original |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| ok | Yes | ||
| kind | No | ||
| filename | Yes | ||
| background | Yes | ||
| content_type | No | ||
| download_url | Yes | ||
| download_hint | No | ||
| expires_in_seconds | No |