> 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. # Update widget configuration PATCH https://api.smallest.ai/atoms/v1/agent/{id}/widget-config Content-Type: application/json Updates the web widget configuration for the agent. Only provided fields are updated (partial update). When `avatarUrl` is changed, the old CDN avatar is automatically deleted from S3. The `avatarUrl` must be a URL from the platform's CDN domain — use `POST /agent/{id}/avatar/presigned-url` to upload first. Reference: https://docs.smallest.ai/voice-agents/api-reference/agents/update-agent-widget-config ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: atoms version: 1.0.0 paths: /agent/{id}/widget-config: patch: operationId: update-agent-widget-config summary: Update widget configuration description: > Updates the web widget configuration for the agent. Only provided fields are updated (partial update). When `avatarUrl` is changed, the old CDN avatar is automatically deleted from S3. The `avatarUrl` must be a URL from the platform's CDN domain — use `POST /agent/{id}/avatar/presigned-url` to upload first. 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: Updated widget configuration content: application/json: schema: $ref: >- #/components/schemas/Agents_updateAgentWidgetConfig_Response_200 '400': description: Invalid agent ID or `avatarUrl` is not a valid CDN URL 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: widgetConfig: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfig description: All fields are optional — only provided fields are updated servers: - url: https://api.smallest.ai/atoms/v1 description: Production server components: schemas: AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigPosition: type: string enum: - bottom-right - bottom-left - top-right - top-left title: >- AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigPosition AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigSize: type: string enum: - tiny - compact - full title: >- AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigSize AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigMode: type: string enum: - chat - voice title: >- AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigMode AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigTheme: type: string enum: - light - dark title: >- AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigTheme AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfig: type: object properties: position: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigPosition size: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigSize borderRadius: type: number format: double mode: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigMode theme: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfigTheme baseColor: type: string accentColor: type: string agentBubbleColor: type: string textOnAccentColor: type: string secondaryTextColor: type: string primaryTextColor: type: string title: type: string startButtonText: type: string endButtonText: type: string ctaTitle: type: - string - 'null' ctaSubtitle: type: - string - 'null' ctaName: type: - string - 'null' widgetName: type: - string - 'null' avatarUrl: type: - string - 'null' description: >- Must be a platform CDN URL. Use `POST /agent/{id}/avatar/presigned-url` to obtain one. voiceEmptyMessage: type: - string - 'null' voiceActiveEmptyMessage: type: - string - 'null' chatEmptyMessage: type: - string - 'null' chatFirstMessage: type: - string - 'null' chatPlaceholder: type: string voiceShowTranscript: type: boolean consentRequired: type: boolean consentTitle: type: string consentContent: type: string consentStorageKey: type: - string - 'null' publicKey: type: string allowlist: type: array items: type: string description: All fields are optional — only provided fields are updated title: >- AgentIdWidgetConfigPatchRequestBodyContentApplicationJsonSchemaWidgetConfig AgentIdWidgetConfigPatchResponsesContentApplicationJsonSchemaData: type: object properties: {} description: The updated widgetConfig object title: AgentIdWidgetConfigPatchResponsesContentApplicationJsonSchemaData Agents_updateAgentWidgetConfig_Response_200: type: object properties: success: type: boolean data: $ref: >- #/components/schemas/AgentIdWidgetConfigPatchResponsesContentApplicationJsonSchemaData description: The updated widgetConfig object title: Agents_updateAgentWidgetConfig_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 {} ``` **Response** ```json { "success": true, "data": {} } ``` **SDK Code** ```python import requests url = "https://api.smallest.ai/atoms/v1/agent/id/widget-config" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.smallest.ai/atoms/v1/agent/id/widget-config'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; 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/widget-config" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", 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/widget-config") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.smallest.ai/atoms/v1/agent/id/widget-config") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.smallest.ai/atoms/v1/agent/id/widget-config', [ 'body' => '{}', '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/widget-config"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/agent/id/widget-config")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" 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() ```