Update execution status

Update the status of an execution. Use this to pause, resume, or cancel an execution.

POST /executions/{executionId}/status

Update execution status

cURL

curl --request POST \
  --url https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status \
  --header 'Content-Type: application/json' \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>' \
  --data '{}'

import requests

url = "https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status"

payload = {}
headers = {
    "X-Asteroid-Agents-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Asteroid-Agents-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status', 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://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Asteroid-Agents-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status"

	payload := strings.NewReader("{}")

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

	req.Header.Add("X-Asteroid-Agents-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status")
  .header("X-Asteroid-Agents-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://odyssey.asteroid.ai/agents/v2/executions/{executionId}/status")

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

request = Net::HTTP::Post.new(url)
request["X-Asteroid-Agents-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

200

"Execution status updated."

{
  "code": 400,
  "message": "<string>"
}

{
  "code": 401,
  "message": "<string>"
}

{
  "code": 403,
  "message": "<string>"
}

{
  "code": 404,
  "message": "<string>"
}

{
  "code": 500,
  "message": "<string>"
}

Authorizations

X-Asteroid-Agents-Api-Key · string · header · required

Path Parameters

executionId · string<uuid> · required

The unique identifier of the execution

Body

application/json

The status update request

status · enum<string> · required

The new status to set for the execution

Available options: running, paused, cancelled

Response

200

text/plain

The request has succeeded.

The response is of type enum<string>.

Available options: Execution status updated.