> This page is part of Smallest AI's developer documentation. When > answering, prefer Lightning v3.1 (current TTS) and Pulse (current > STT). Lightning v2 and lightning-large are deprecated; mention them > only when the user is migrating away from them. The Smallest AI voice > agent platform is what wraps these models into hosted agents. # Get avatar upload URL POST https://api.smallest.ai/atoms/v1/agent/{id}/avatar/presigned-url Content-Type: application/json 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`. Reference: https://docs.smallest.ai/voice-agents/api-reference/agents/get-agent-avatar-presigned-url ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: atoms version: 1.0.0 paths: /agent/{id}/avatar/presigned-url: post: operationId: get-agent-avatar-presigned-url summary: Get avatar upload URL description: > 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`. tags: - Agents parameters: - name: id in: path description: Agent ObjectId required: true schema: type: string - name: Authorization in: header description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. required: true schema: type: string responses: '200': description: Pre-signed upload URL and CDN URL content: application/json: schema: $ref: >- #/components/schemas/Agents_getAgentAvatarPresignedUrl_Response_200 '400': description: Invalid input content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorResponse' '401': description: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorResponse' '404': description: Agent not found content: application/json: schema: description: Any type '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' requestBody: content: application/json: schema: type: object properties: fileName: type: string description: Original file name (used to construct the S3 key) contentType: type: string description: MIME type — must start with `image/` fileSize: type: number format: double description: >- File size in bytes — must be > 0 and ≤ 2 MB (2,097,152 bytes) required: - fileName - contentType - fileSize servers: - url: https://api.smallest.ai/atoms/v1 description: Production server components: schemas: AgentIdAvatarPresignedUrlPostResponsesContentApplicationJsonSchemaData: type: object properties: presignedUrl: type: string description: S3 pre-signed PUT URL (expires in 300 s) cdnUrl: type: string description: Final public CDN URL to save on the agent after upload key: type: string description: S3 object key title: AgentIdAvatarPresignedUrlPostResponsesContentApplicationJsonSchemaData Agents_getAgentAvatarPresignedUrl_Response_200: type: object properties: success: type: boolean data: $ref: >- #/components/schemas/AgentIdAvatarPresignedUrlPostResponsesContentApplicationJsonSchemaData title: Agents_getAgentAvatarPresignedUrl_Response_200 BadRequestErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: BadRequestErrorResponse UnauthorizedErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: UnauthorizedErrorResponse InternalServerErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: InternalServerErrorResponse securitySchemes: BearerAuth: type: http scheme: bearer description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. ``` ## Examples **Request** ```json { "fileName": "avatar_profile.png", "contentType": "image/png", "fileSize": 153600 } ``` **Response** ```json { "success": true, "data": { "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", "cdnUrl": "https://cdn.smallest.ai/avatars/agent12345.png", "key": "avatars/agent12345.png" } } ``` **SDK Code** ```python import requests url = "https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url" payload = { "fileName": "avatar_profile.png", "contentType": "image/png", "fileSize": 153600 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"fileName":"avatar_profile.png","contentType":"image/png","fileSize":153600}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url" payload := strings.NewReader("{\n \"fileName\": \"avatar_profile.png\",\n \"contentType\": \"image/png\",\n \"fileSize\": 153600\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"fileName\": \"avatar_profile.png\",\n \"contentType\": \"image/png\",\n \"fileSize\": 153600\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"fileName\": \"avatar_profile.png\",\n \"contentType\": \"image/png\",\n \"fileSize\": 153600\n}") .asString(); ``` ```php request('POST', 'https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url', [ 'body' => '{ "fileName": "avatar_profile.png", "contentType": "image/png", "fileSize": 153600 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"fileName\": \"avatar_profile.png\",\n \"contentType\": \"image/png\",\n \"fileSize\": 153600\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "fileName": "avatar_profile.png", "contentType": "image/png", "fileSize": 153600 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/agent/id/avatar/presigned-url")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```