curl --request POST \
--url https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "release",
"reason_code": "R10"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'release', reason_code: 'R10'})
};
fetch('https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance"
payload = {
"action": "release",
"reason_code": "R10"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance"
payload := strings.NewReader("{\n \"action\": \"release\",\n \"reason_code\": \"R10\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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))
}{
"simulation_id": "sim_hold_001",
"previous_state": "compliance_hold",
"new_state": "release",
"callbacks_scheduled": 1
}{
"type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
"title": "Invalid action for this scenario",
"status": 400,
"detail": "Invalid action for this scenario",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
"title": "Not available in production",
"status": 403,
"detail": "Not available in production",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Simulation not found",
"status": 404,
"detail": "Simulation not found",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#conflict",
"title": "Simulation is not awaiting advance",
"status": 409,
"detail": "Simulation is not awaiting advance (already advanced or not paused)",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#provider-error",
"title": "Provider gRPC error",
"status": 502,
"detail": "Provider gRPC error",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}Advance a paused simulation
Unpauses a stateful sandbox simulation that is currently waiting at an intermediate state (awaiting_advance = true). Use this to drive compliance_hold, manual_review, and unconfirmed scenarios past their pause point.
Valid actions per scenario:
- compliance_hold:
release,reject - manual_review:
approve,reject - unconfirmed (crypto):
confirm,expire
The endpoint is concurrency-safe: concurrent advance calls for the same simulation_id are handled atomically — exactly one wins, the rest receive 409 Conflict.
Available in sandbox mode only.
curl --request POST \
--url https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "release",
"reason_code": "R10"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'release', reason_code: 'R10'})
};
fetch('https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance"
payload = {
"action": "release",
"reason_code": "R10"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/sandbox/simulations/{simulation_id}/advance"
payload := strings.NewReader("{\n \"action\": \"release\",\n \"reason_code\": \"R10\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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))
}{
"simulation_id": "sim_hold_001",
"previous_state": "compliance_hold",
"new_state": "release",
"callbacks_scheduled": 1
}{
"type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
"title": "Invalid action for this scenario",
"status": 400,
"detail": "Invalid action for this scenario",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
"title": "Not available in production",
"status": 403,
"detail": "Not available in production",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Simulation not found",
"status": 404,
"detail": "Simulation not found",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#conflict",
"title": "Simulation is not awaiting advance",
"status": 409,
"detail": "Simulation is not awaiting advance (already advanced or not paused)",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#provider-error",
"title": "Provider gRPC error",
"status": 502,
"detail": "Provider gRPC error",
"instance": "https://api.platform.dakota.xyz/sandbox/simulations/example-id/advance",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}Authorizations
Path Parameters
The simulation_id returned by POST /sandbox/simulate/inbound
Body
Response
Simulation advanced successfully
The simulation that was advanced.
"sim_01HXYZ"
The state position before advancing (e.g., "compliance_hold").
"compliance_hold"
The state position after advancing (e.g., "release").
"release"
Number of new callbacks scheduled by this advance action.
1
Was this page helpful?

