Get avatar upload URL

POST

https://api.smallest.ai/atoms/v1/agent/:id/avatar/presigned-url

POST

/atoms/v1/agent/:id/avatar/presigned-url

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url"
4 
5 payload = {
6     "fileName": "avatar_profile.png",
7     "contentType": "image/png",
8     "fileSize": 153600
9 }
10 headers = {
11     "Authorization": "Bearer <token>",
12     "Content-Type": "application/json"
13 }
14 
15 response = requests.post(url, json=payload, headers=headers)
16 
17 print(response.json())

1 {
2   "success": true,
3   "data": {
4     "presignedUrl": "https://smallest-ai.s3.amazonaws.com/avatars/agent12345.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000",
5     "cdnUrl": "https://cdn.smallest.ai/avatars/agent12345.png",
6     "key": "avatars/agent12345.png"
7   }
8 }

Generates a pre-signed S3 upload URL for the agent’s widget avatar image. Upload the image directly to S3 using the returned presignedUrl, then save cdnUrl as the agent’s avatar via PATCH /agent/{id}/widget-config.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

Agent ObjectId

Request

This endpoint expects an object.

fileNamestringRequired

Original file name (used to construct the S3 key)

contentTypestringRequired

MIME type — must start with image/

fileSizedoubleRequired

File size in bytes — must be > 0 and ≤ 2 MB (2,097,152 bytes)

Response

Pre-signed upload URL and CDN URL

successboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error