Documentation
Home / Windows Automation / Element Set Value

Element Set Value

POST
/tools-api/automation/set-value

Sets the value of a UI element in a Windows application. This endpoint allows you to set text values for input fields, text boxes, combo boxes, and other editable UI elements using the Windows Automation API.

Use this endpoint when you need to input text into form fields, edit text in documents, or update any UI component that accepts text input. The element ID must be obtained first, typically from the GET /tools-api/system/overview endpoint or the POST /tools-api/automation/get-details endpoint.

Request

The request body is a JSON object with the following properties:

Parameter Type Required Description
elementId string Required The unique identifier of the UI element to set the value for. This ID can be obtained from the GET /tools-api/system/overview endpoint.
value string Required The value to set in the UI element. This should be the text you want to input into the element.

Example Request

{
  "elementId": "notepad.exe_10234_Document_5",
  "value": "Hello, this is a test message!"
}

Response

The response is a simple object containing success status and a message.

Parameter Type Description
success boolean Indicates if the operation was successful.
message string A descriptive message about the result of the operation.

Example Response

{
  "success": true,
  "message": "Value set successfully for element 'notepad.exe_10234_Document_5'"
}

Code Examples

import requests
import json

def set_element_value(api_key, element_id, value):
    url = "http://localhost:5001/tools-api/automation/set-value"
    
    headers = {
        "Content-Type": "application/json",
        "Authorization": f"Bearer {api_key}"
    }
    
    payload = {
        "elementId": element_id,
        "value": value
    }
    
    response = requests.post(url, headers=headers, json=payload)
    return response.json()

# Example usage
api_key = "your_api_key_here"
element_id = "notepad.exe_10234_Document_5"
value = "Hello, this is a test message!"

result = set_element_value(api_key, element_id, value)
print(json.dumps(result, indent=2))
interface AutomationSetValueRequest {
  elementId: string;
  value: string;
}

interface SimpleResponse {
  success: boolean;
  message: string;
}

async function setElementValue(apiKey: string, elementId: string, value: string): Promise {
  const url = 'http://localhost:5001/tools-api/automation/set-value';
  
  const headers = {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${apiKey}`
  };
  
  const payload: AutomationSetValueRequest = {
    elementId,
    value
  };
  
  const response = await fetch(url, {
    method: 'POST',
    headers,
    body: JSON.stringify(payload)
  });
  
  return response.json();
}

// Example usage
(async () => {
  const apiKey = 'your_api_key_here';
  const elementId = 'notepad.exe_10234_Document_5';
  const value = 'Hello, this is a test message!';
  
  try {
    const result = await setElementValue(apiKey, elementId, value);
    console.log(result);
  } catch (error) {
    console.error('Error setting element value:', error);
  }
})();
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

public class ToolsServerClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;
    
    public ToolsServerClient(string apiKey)
    {
        _httpClient = new HttpClient();
        _httpClient.BaseAddress = new Uri("http://localhost:5001");
        _httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
        _apiKey = apiKey;
    }
    
    public async Task SetElementValueAsync(string elementId, string value)
    {
        var request = new AutomationSetValueRequest
        {
            ElementId = elementId,
            Value = value
        };
        
        var content = new StringContent(
            JsonSerializer.Serialize(request), 
            Encoding.UTF8, 
            "application/json");
            
        var response = await _httpClient.PostAsync("/tools-api/automation/set-value", content);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        return JsonSerializer.Deserialize(responseBody, 
            new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
    }
}

public class AutomationSetValueRequest
{
    public string ElementId { get; set; }
    public string Value { get; set; }
}

public class SimpleResponse
{
    public bool Success { get; set; }
    public string Message { get; set; }
}

// Example usage
class Program
{
    static async Task Main(string[] args)
    {
        var client = new ToolsServerClient("your_api_key_here");
        var elementId = "notepad.exe_10234_Document_5";
        var value = "Hello, this is a test message!";
        
        try
        {
            var result = await client.SetElementValueAsync(elementId, value);
            Console.WriteLine($"Success: {result.Success}, Message: {result.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error setting element value: {ex.Message}");
        }
    }
}

Examples

Setting text in a Notepad document

{
  "elementId": "notepad.exe_10234_Document_5",
  "value": "This is some example text for the Notepad document."
}

Setting text in a text input field

{
  "elementId": "chrome.exe_32154_edit_8",
  "value": "user@example.com"
}

Setting value in a search box

{
  "elementId": "explorer.exe_9876_SearchEditBox_2",
  "value": "report.docx"
}