Yapper API
Api reference
PATCH
/assets/{assetId}

Sets an asset's favorite flag, or restores it from the trash with trashed: false (trashed: true trashes it, like DELETE). Send only the fields to change; unknown fields are rejected. A trashed asset returns not_found unless the request sets trashed. Free.

Authorization

bearerAuth assets:write
AuthorizationBearer <token>

In: header

Scope: assets:write

Path Parameters

assetId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/assets/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "type": "image",  "name": "string",  "url": "http://example.com",  "thumbnailUrl": "http://example.com",  "preview": {    "url": "http://example.com",    "width": 0,    "height": 0,    "mimeType": "string"  },  "width": 0,  "height": 0,  "duration": 0,  "mimeType": "string",  "source": "string",  "sourceProcessId": "string",  "trainingId": "string",  "draft": {    "finishableUntil": "2019-08-24T14:15:22Z"  },  "favorite": true,  "sessionId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "links": {    "self": "string"  },  "trashed": true,  "purgeAfter": "2019-08-24T14:15:22Z"}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}

Move an asset to the trash DELETE

Moves an asset to the trash, as deleting it in the web app does: it leaves the library and every session, and GET /assets/{assetId} returns not_found. It is permanently deleted 30 days later (purgeAfter); until then PATCH with trashed: false restores it. A session whose chosen image was this asset goes back to following its newest generation. Trashing an already-trashed asset is a no-op. To take an asset out of one session only, use DELETE /sessions/{sessionId}/assets. Free.

Update a canvas card PATCH

Changes one card. Send only the fields to change: label, position, size and lock on any card, plus the settings of its kind (the same fields as when adding it). Changing a generation card's model drops its customSettings and resets an aspect ratio or resolution the new model does not support to the model's default. selectedOutput picks which version wired cards downstream receive; null goes back to the newest. Returns the card with every version. Shows up live on the canvas in the Yapper web app. Free. Uses the processes:write scope.