Cancel a simulation run

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/simulation/runs/{sim_run_id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "text",
  "tool_overrides": {},
  "status": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "error_text": "<string>",
  "inputs_snapshot": {},
  "created_at": "2023-11-07T05:31:56Z",
  "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_attempt": 1,
  "sut_snapshot_sha256": "<string>",
  "idempotency_key": "<string>",
  "budget_usd": "<string>",
  "spent_usd": "<string>",
  "stop_reason": "<string>",
  "persona_turn_count": 0,
  "agent_turn_count": 0,
  "transcript_chars": 0,
  "heartbeat_at": "2023-11-07T05:31:56Z",
  "recording_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recording_status": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}