Upload a link's image

Starts replacing a link card’s image. Works at the free plan’s card limit: no card is created.

POST/v1/cards/{cardId}/thumbnail/upload

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

Request body

application/json

fileSizenumberrequired

Bytes; at most 20971520 (20 MB).

mimeTypestringrequired

JPEG, PNG, WebP, GIF (its first frame) or AVIF. SVG and HEIC are refused.

Allowed:image/jpegimage/pngimage/webpimage/gifimage/avif

Responses

200

A signed URL. PUT the bytes to uploadUrl with the same Content-Type, then pass fileKey to PUT /v1/cards/{cardId}/thumbnail

expiresInnumberrequired

fileKeystringrequired

maxFileSizenumberrequired

methodstringrequired

Allowed:PUT

uploadUrlstring<uri>required

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (OAuth access token or teakapi_ API key)Remember on this deviceInclude my values in samples

Parameters

cardIdpath*

Bodyapplication/json

fileSizenumber*Bytes; at most 20971520 (20 MB).mimeTypestring*JPEG, PNG, WebP, GIF (its first frame) or AVIF. SVG and HEIC are refused.

Request

curl -X POST 'https://teakvault.com/api/v1/cards/string/thumbnail/upload' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "fileSize": 0,
  "mimeType": "image/jpeg"
}'

const response = await fetch("https://teakvault.com/api/v1/cards/string/thumbnail/upload", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"fileSize\": 0,\n  \"mimeType\": \"image/jpeg\"\n}"
});

const response: Response = await fetch("https://teakvault.com/api/v1/cards/string/thumbnail/upload", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"fileSize\": 0,\n  \"mimeType\": \"image/jpeg\"\n}"
});

import requests

response = requests.post(
    "https://teakvault.com/api/v1/cards/string/thumbnail/upload",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"fileSize\": 0,\n  \"mimeType\": \"image/jpeg\"\n}",
)

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader("{\n  \"fileSize\": 0,\n  \"mimeType\": \"image/jpeg\"\n}")
	req, err := http.NewRequest("POST", "https://teakvault.com/api/v1/cards/string/thumbnail/upload", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://teakvault.com/api/v1/cards/string/thumbnail/upload")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\n  \"fileSize\": 0,\n  \"mimeType\": \"image/jpeg\"\n}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://teakvault.com/api/v1/cards/string/thumbnail/upload',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "fileSize": 0,
  "mimeType": "image/jpeg"
}',
]);

$response = curl_exec($curl);

Response

{
  "expiresIn": 0,
  "fileKey": "string",
  "maxFileSize": 0,
  "method": "PUT",
  "uploadUrl": "http://example.com"
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}