> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# Execute a simulation suite

POST https://api.synthflow.ai/v2/simulation_suites/{suite_id}/execute

Execute all test cases in a suite. The suite runs on the agent it was created for (determined by the suite's model_id).

Reference: https://docs.synthflow.ai/api-reference/platform-api/simulations/execute-simulation-suite

## Authentication

- `Authorization` header (bearer token, required)

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Path parameters

- `suite_id` (string, required) — Simulation suite ID.

### Query parameters

- `target_agent_id` (string, required) — Target agent ID. Must match the suite's model_id.
- `max_turns` (integer, optional, default: 20) — Maximum number of turns per simulation.

## Response

### 200

200

- `session_id` (string, optional)
- `suite_id` (string, optional)
- `suite_name` (string, optional)
- `total_cases` (integer, optional)
- `status` (string, optional)

## Examples

**Response**

```json
{
  "session_id": "string",
  "suite_id": "string",
  "suite_name": "string",
  "total_cases": 1,
  "status": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.synthflow.ai/v2/simulation_suites/suite_id/execute"

querystring = {"target_agent_id":"target_agent_id"}

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers, params=querystring)

print(response.json())
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthflow.ai/v2/simulation_suites/suite_id/execute?target_agent_id=target_agent_id"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.synthflow.ai/v2/simulation_suites/suite_id/execute?target_agent_id=target_agent_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.synthflow.ai/v2/simulation_suites/suite_id/execute?target_agent_id=target_agent_id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/simulation_suites/suite_id/execute?target_agent_id=target_agent_id");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/simulation_suites/suite_id/execute?target_agent_id=target_agent_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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()
```