> ## Documentation Index > Fetch the complete documentation index at: https://docs.tess.im/llms.txt > Use this file to discover all available pages before exploring further. # Execute Agent Stream > Execute a specific **chat** agent by ID. ### **Code Examples** ```http cURL theme={null} curl --request POST \ --url 'https://api.tess.im/agents/{id}/execute' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "stream": true, "temperature": "1", "model": "tess-5", "messages": [ { "role": "user", "content": "hello there!" } ], "tools": "no-tools", "file_ids": [123, 321] }' ``` ```json Node.js theme={null} const axios = require('axios'); const { parse } = require('eventsource-parser'); const data = { "stream": true, "temperature": "1", "model": "tess-5", "messages": [ { "role": "user", "content": "hello there!" } ], "tools": "no-tools", "file_ids": [123, 321] }; const config = { method: 'post', url: 'https://api.tess.im/agents/{id}/openai/chat/completions', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' }, responseType: 'stream' // Required for handling streaming responses }; async function fetchSSE() { try { const response = await axios(config); response.data.on('data', (chunk) => { const dataString = chunk.toString(); parseSSE(dataString); }); response.data.on('end', () => { console.log("\nStream ended."); }); } catch (error) { console.error("Error fetching SSE data:", error); } } function parseSSE(data) { // Use the eventsource-parser library parse(data, (event) => { if (event.data !== "[DONE]") { try { const parsed = JSON.parse(event.data); console.log(parsed); // Process/Display received data } catch (error) { console.error("Error parsing SSE data:", error); } } }); } fetchSSE(); ``` ```python Python theme={null} import requests import sseclient url = "https://api.tess.im/agents/{id}/execute" headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" } data = { "stream": True, "temperature": "1", "model": "tess-5", "messages": [ {"role": "user", "content": "hello there!"} ], "tools": "no-tools", "file_ids": [123, 321] } # Send the request with streaming enabled response = requests.post(url, headers=headers, json=data, stream=True) # Handle Server-Sent Events using sseclient client = sseclient.SSEClient(response) # Print each event as it arrives for event in client.events(): print(event.data) # Print the data chunk received in the event ``` ```php PHP theme={null} true, "temperature" => "1", "model" => "tess-5", "messages" => [ ["role" => "user", "content" => "hello there!"] ], "tools" => "no-tools", "file_ids" => [123, 321] ]; $client = new Client(); try { $response = $client->post('https://api.tess.im/agents/{id}/execute', [ 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => $data, 'stream' => true, // Enable streaming ]); // Check that the response is successful if ($response->getStatusCode() === 200) { // Get the body as a stream $body = $response->getBody(); // Iterate through each line of the stream $parser = new \React\Stream\LineStream($body); $parser->on('data', function ($line) { // Check if this line is an SSE event if (strpos(trim($line), 'data:') === 0) { // Extract event data $eventData = trim(substr($line, 5)); // Remove "data: " prefix // Process or print the event data echo "Received event: " . $eventData . PHP_EOL; } }); // Handle stream end or error $parser->on('error', function ($error) { echo "Error encountered: " . $error . PHP_EOL; }); $body->on('close', function () { echo "Stream closed." . PHP_EOL; }); } else { echo "Request failed with status: " . $response->getStatusCode(); } } catch (RequestException $e) { echo "Request failed: " . $e->getMessage(); } ``` ```java Java theme={null} import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.JsonNode; import java.io.BufferedReader; import java.io.InputStreamReader; import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.util.List; import java.util.Map; public class Main { public static void main(String[] args) throws Exception { ObjectMapper mapper = new ObjectMapper(); Map data = Map.of( "stream", true, "temperature", "1", "model", "tess-5", "messages", List.of(Map.of("role", "user", "content", "hello there!")), "tools", "no-tools", "file_ids", List.of(123, 321) ); String jsonPayload = mapper.writeValueAsString(data); HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.tess.im/agents/{id}/execute")) .header("Authorization", "Bearer YOUR_API_KEY") .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString(jsonPayload)) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofInputStream()); try (BufferedReader reader = new BufferedReader(new InputStreamReader(response.body()))) { String line; while ((line = reader.readLine()) != null) { if (!line.trim().isEmpty() && line.startsWith("data: ")) { String jsonData = line.substring("data: ".length()).trim(); JsonNode event = mapper.readTree(jsonData); // Handle the event (for example, print it) System.out.println("Received event: " + event); } } } } } ``` ```go Go theme={null} package main import ( "bufio" "encoding/json" "fmt" "net/http" "strings" ) // Event struct to parse the SSE data type Event struct { ID string `json:"id,omitempty"` Event string `json:"event,omitempty"` Data string `json:"data,omitempty"` } func main() { payload := `{ "stream": true, "temperature": "1", "model": "tess-5", "messages": [ { "role": "user", "content": "hello there!" } ], "tools": "no-tools", "file_ids": [123, 321] }` client := &http.Client{} req, err := http.NewRequest("POST", "https://api.tess.im/agents/{id}/execute", strings.NewReader(payload)) if err != nil { fmt.Println("Error creating request:", err) return } req.Header.Add("Authorization", "Bearer YOUR_API_KEY") req.Header.Add("Content-Type", "application/json") resp, err := client.Do(req) if err != nil { fmt.Println("Error making request:", err) return } defer resp.Body.Close() // Create a scanner to read the response body as a stream scanner := bufio.NewScanner(resp.Body) for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, "data: ") { data := strings.TrimPrefix(line, "data: ") var event Event if err := json.Unmarshal([]byte(data), &event); err != nil { fmt.Println("Error parsing event:", err) continue } // Handle the parsed event fmt.Printf("Received event: %+v\n", event) } } if err := scanner.Err(); err != nil { fmt.Println("Error reading response:", err) } } ``` ```jsonnet .NET theme={null} using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Threading.Tasks; using Newtonsoft.Json; using System.IO; class Program { static async Task Main(string[] args) { using (var client = new HttpClient()) { client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY"); var data = new { stream = true, temperature = "1", model = "tess-5", messages = new List { new { role = "user", content = "hello there!" } }, tools = "no-tools", file_ids = new List { 123, 321 } }; var jsonPayload = JsonConvert.SerializeObject(data); var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json"); try { // Send the POST request and receive the response as a stream var response = await client.PostAsync("https://api.tess.im/agents/{id}/execute", content); response.EnsureSuccessStatusCode(); // Get the stream from the response using (var stream = await response.Content.ReadAsStreamAsync()) using (var reader = new StreamReader(stream)) { // Read lines from the stream continuously while (!reader.EndOfStream) { var line = await reader.ReadLineAsync(); // Check if the line starts with "data:" which is the format for SSE if (line.StartsWith("data:")) { // Extract the data part var dataLine = line.Substring("data: ".Length).Trim(); // Optionally: Deserialize the data if it's in JSON format // var eventData = JsonConvert.DeserializeObject(dataLine); Console.WriteLine(dataLine); // Print the raw data or processed data } } } } catch (HttpRequestException e) { Console.WriteLine("\nException Caught!"); Console.WriteLine("Message :{0} ", e.Message); } } } } ``` ```ruby Ruby theme={null} require 'uri' require 'net/http' require 'json' require 'sse/client' uri = URI('https://api.tess.im/agents/{id}/execute') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Post.new(uri) request['Authorization'] = 'Bearer YOUR_API_KEY' request['Content-Type'] = 'application/json' request.body = { "stream": true, "temperature": "1", "model": "tess-5", "messages": [ { "role": "user", "content": "hello there!" } ], "tools": "no-tools", "file_ids": [123, 321] }.to_json # Here we directly use the request and set up an SSE Client response = http.request(request) # Create an SSE Client with the response body client = SSE::Client.new(response.body) # Subscribe to the stream and handle events client.on(:message) do |event| puts "Received message: #{event.data}" end client.start # Keep the main thread alive to receive the events sleep ``` ### **Headers** | **Parameter** | **Type** | **Required** | **Description** | | :--------------- | :------- | :----------- | :---------------------------------------------------------------------------------------------------------------------- | | `x-workspace-id` | integer | No | ID of the workspace. If not provided, the user's selected workspace will be used. Will be required in a future release. | ### **Path Parameters** | **Parameter** | **Type** | **Required** | **Description** | | :------------ | :------- | :----------- | :-------------- | | `id` | integer | Yes | The agent ID. | ### **Request Body** | **Parameter** | **Type** | **Required** | **Description** | | :---------------------- | :------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `stream` | boolean | Yes | Must be `true` for this streaming endpoint. | | `temperature` | string | No | Chat Agent field. Sampling temperature between 0 and 2. Higher values produce more creative outputs (default: `"1"`). | | `model` | string | No | Chat Agent field. Model identifier to use for execution (e.g., `"tess-6"`). | | `tools` | string | No | Chat Agent field. Tool configuration for the agent (e.g., `"agent"`, `"no-tools"`). | | `root_id` | integer | No | Chat Agent field. ID of an existing execution to continue a conversation thread. | | `messages` | array | No | Chat Agent field. The agent messages. Required for Chat Agent templates. Supports `user`, `assistant`, `developer` roles. | | `file_ids` | array | No | Array of file IDs to attach to the execution. | | Other root-level fields | any | Depends on agent | This is not a fixed field name. You can send additional fields required by your specific agent directly at the request root. Check which fields are required in [Get Agent by ID](https://docs.tess.im/en/get-agent). | ### **Response** ```json wrap theme={null} data: {"id": 123, "status": "running", "output": "Hi!", "error": null, "credits": null, "root_id": 123, "created_at": "2025-01-01T10:00:00.000000Z", "updated_at": "2025-01-01T10:00:00.000000Z", "template_id": 10} data: {"id": 123, "status": "completed", "output": "", "error": null, "credits": 10, "root_id": 123, "created_at": "2025-01-01T10:00:00.000000Z", "updated_at": "2025-01-01T10:00:00.000000Z", "template_id": 10} ``` ## OpenAPI ````yaml api-reference/agents-stream.openapi.json POST /agents/{id}/execute openapi: 3.1.0 info: title: Tess API - Agent Stream Execution version: 1.0.0 servers: - url: https://api.tess.im security: [] paths: /agents/{id}/execute: post: summary: Execute Agent Stream description: Execute a specific chat agent by ID with streaming response. operationId: executeAgentStream parameters: - $ref: '#/components/parameters/agentId' - $ref: '#/components/parameters/workspaceId' requestBody: description: >- Send a JSON object. Keep `stream: true` in this endpoint and add any custom fields directly at the root. required: true content: application/json: schema: type: object additionalProperties: true description: >- Free-form JSON object. Use `stream: true` and add known or custom fields at the root level. example: stream: true temperature: '1' model: tess-6 messages: - role: user content: Summarize the latest ticket updates. tools: no-tools file_ids: - 123 - 321 examples: streamExecution: summary: Streaming payload value: stream: true temperature: '1' model: tess-6 messages: - role: user content: Generate a concise status update. tools: no-tools file_ids: - 123 - 321 streamWithCustomFields: summary: Streaming payload with custom root fields value: stream: true messages: - role: user content: List critical blockers. department: operations priority_filter: high responses: '200': description: Server-Sent Events stream. security: - bearerAuth: [] components: parameters: agentId: name: id in: path required: true schema: type: integer description: The agent ID. workspaceId: name: x-workspace-id in: header required: false schema: type: integer description: >- ID of the workspace. If not provided, the user's selected workspace will be used. **This field will be required in a future release.** securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````