API Reference/Image Tools

Image Tools

Upload and manage reference images for use in thumbnail generation. Images can include logos, products, and other assets.

Upload and manage reference images for use in thumbnail generation. Images can include logos, products, and other assets.

upload_image

Upload a reference image (logo, object, product) for thumbnail generation. Guide: https://thumbfa.st/docs/images-guide

Endpoint: POST /api/v1/tools/upload_image

Cost: 0.05 thumbnails

Parameters

ParameterTypeRequiredDescription
imageUrlstringYesURL of the image to upload
namestringNoOptional name for the image

Example

curl -X POST https://thumbfa.st/api/v1/tools/upload_image \
  -H "Authorization: Bearer tf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/image.jpg"
  }'

list_images

List all uploaded images in your organization. Use this to find image IDs and names before calling generate_thumbnail or generate_variation with imageIds. Returns the image name, description, and URL for each image.

Endpoint: POST /api/v1/tools/list_images

This tool takes no parameters.

Example

curl -X POST https://thumbfa.st/api/v1/tools/list_images \
  -H "Authorization: Bearer tf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'

get_image

Get details of a specific uploaded image by its ID. Returns the image name, description, and URL. Use this to verify an image before adding it to a generation.

Endpoint: POST /api/v1/tools/get_image

Parameters

ParameterTypeRequiredDescription
imageIdstringYesID of the image to retrieve

Example

curl -X POST https://thumbfa.st/api/v1/tools/get_image \
  -H "Authorization: Bearer tf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "imageId": "example_imageId"
  }'

search_images

Search for uploaded images by name or description.

Endpoint: POST /api/v1/tools/search_images

This tool takes no parameters.

Example

curl -X POST https://thumbfa.st/api/v1/tools/search_images \
  -H "Authorization: Bearer tf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'

delete_image

Delete an uploaded image.

Endpoint: POST /api/v1/tools/delete_image

Parameters

ParameterTypeRequiredDescription
imageIdstringYesID of the image to delete

Example

curl -X POST https://thumbfa.st/api/v1/tools/delete_image \
  -H "Authorization: Bearer tf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "imageId": "example_imageId"
  }'