Skip to content

Reset a link's image

Goes back to the image Teak found for the link and deletes the uploaded one.

DELETE/v1/cards/{cardId}/thumbnail
Authorization
AuthorizationBearer token (OAuth access token or teakapi_ API key) · headerrequired

Bearer token. Accepts either an OAuth 2.0 access token (obtained via browser sign-in; expires after 1 hour and is refreshable) or a teakapi_ API key.

Path parameters
cardIdstringrequired
Responses
200

The card, back on the image Teak found (or its screenshot). Resetting a card without a chosen image changes nothing

aiSummarystring | null
aiTagsstring[]required
aiTranscriptstring | null
appUrlstring<uri>required
compactUrlstring | nullrequired

256px rendition URL for small cards; present for image uploads.

contentstringrequired
isDeletedboolean
metadataStatusstring | null
processingStatusobject | null

Per-stage processing state (classify, categorize, metadata, renderables, screenshot), or null once nothing is tracked.

linkPreviewDescriptionstring | null
linkFactsobject[]
Show properties
Array of object
labelstringrequired
valuestringrequired
linkPreviewTitlestring | null
linkPriceobject | null

A product link's price, read from the page: amount in the page's currency and currency as an ISO 4217 code, or null when the page didn't say which. Null for cards without a price. price: in q compares amount.

Show properties
amountnumberrequired
currencystring | nullrequired
linkFaviconUrlstring | null
fileWidthnumber | null
fileHeightnumber | null
audioWaveformobject | null

Audio bar heights from 0 to 100: 45 for a grid card and 200 for a player. Null for other cards and audio saved before waveforms.

Show properties
detailnumber[]required
gridnumber[]required
videoScrubobject | null

A horizontal JPEG strip of evenly spaced video frames for hover previews, frames * frameWidth wide. The URL is signed and expires. Null for other cards and videos saved before scrub strips.

Show properties
frameHeightnumberrequired
frameWidthnumberrequired
framesnumberrequired
urlstringrequired
colorsobject[]
Show properties
Array of object
hexstringrequired
namestring
createdAtnumberrequired
detailUrlstring | null
fileExtensionstring | null
fileKindstring | null
fileLanguagestring | null
fileNamestring | null
filePreviewobject | null
fileSizenumber | null
fileUrlstring | null
idstringrequired
archivedAtnumber | null

When the card was archived, or null when it isn't.

folderIdsstring[]

Ids of the folders the card is in (at most 50).

isArchivedbooleanrequired

Archived cards are hidden from the library and listings unless you ask for them with archived.

isFavoritedbooleanrequired
linkPreviewImageUrlstring | null
linkPreviewMediaobject[]
Show properties
Array of object
typestringrequired
Allowed:imagevideo
urlstringrequired
contentTypestring
widthnumber
heightnumber
posterUrlstring
posterContentTypestring
posterWidthnumber
posterHeightnumber
linkSiteNamestring | null
linkAuthorstring | null
linkPublisherstring | null
linkPublishedAtstring | null
metadataDescriptionstring | null
metadataTitlestring | null
mimeTypestring | null
notesstring | null
placeholderUrlstring | nullrequired

48px loading-placeholder rendition URL; present for image uploads.

screenshotUrlstring | null
tagsstring[]required
thumbnailOverriddenboolean

True when linkPreviewImageUrl is an image chosen for this link (PUT /v1/cards/{cardId}/thumbnail) rather than the one Teak found.

thumbnailUrlstring | null
typestringrequired
updatedAtnumberrequired
urlstring | null
400

TYPE_MISMATCH: not a link card. UNSUPPORTED_TYPE: not an accepted image type (JPEG, PNG, WebP, GIF (its first frame) or AVIF. SVG and HEIC are refused.). INVALID_INPUT: the image couldn't be read, or is over 10,000 pixels on a side

codestringrequired
errorstringrequired
retryAtnumber | null
404

The card, or the upload for it, was not found

codestringrequired
errorstringrequired
retryAtnumber | null
409

The card is in Trash

codestringrequired
errorstringrequired
retryAtnumber | null
413

FILE_TOO_LARGE: images must be under 20 MB

codestringrequired
errorstringrequired
retryAtnumber | null
429

RATE_LIMITED: 20 image changes a minute; retryAt and Retry-After say when to try again

codestringrequired
errorstringrequired
retryAtnumber | null
Try it
Server
Authorization
Parameters
Request
curl -X DELETE 'https://teakvault.com/api/v1/cards/string/thumbnail' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "aiSummary": "string",
  "aiTags": [
    "string"
  ],
  "aiTranscript": "string",
  "appUrl": "http://example.com",
  "compactUrl": "string",
  "content": "string",
  "isDeleted": true,
  "metadataStatus": "string",
  "processingStatus": {},
  "linkPreviewDescription": "string",
  "linkFacts": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "linkPreviewTitle": "string",
  "linkPrice": {
    "amount": 0,
    "currency": "string"
  },
  "linkFaviconUrl": "string",
  "fileWidth": 0,
  "fileHeight": 0,
  "audioWaveform": {
    "detail": [
      0
    ],
    "grid": [
      0
    ]
  },
  "videoScrub": {
    "frameHeight": 0,
    "frameWidth": 0,
    "frames": 0,
    "url": "string"
  },
  "colors": [
    {
      "hex": "string",
      "name": "string"
    }
  ],
  "createdAt": 0,
  "detailUrl": "string",
  "fileExtension": "string",
  "fileKind": "string",
  "fileLanguage": "string",
  "fileName": "string",
  "filePreview": {},
  "fileSize": 0,
  "fileUrl": "string",
  "id": "string",
  "archivedAt": 0,
  "folderIds": [
    "string"
  ],
  "isArchived": true,
  "isFavorited": true,
  "linkPreviewImageUrl": "string",
  "linkPreviewMedia": [
    {
      "type": "image",
      "url": "string",
      "contentType": "string",
      "width": 0,
      "height": 0,
      "posterUrl": "string",
      "posterContentType": "string",
      "posterWidth": 0,
      "posterHeight": 0
    }
  ],
  "linkSiteName": "string",
  "linkAuthor": "string",
  "linkPublisher": "string",
  "linkPublishedAt": "string",
  "metadataDescription": "string",
  "metadataTitle": "string",
  "mimeType": "string",
  "notes": "string",
  "placeholderUrl": "string",
  "screenshotUrl": "string",
  "tags": [
    "string"
  ],
  "thumbnailOverridden": true,
  "thumbnailUrl": "string",
  "type": "string",
  "updatedAt": 0,
  "url": "string"
}

Was this page helpful?