Cancel an evaluation

Cancel a queued or running evaluation (run_…); a cancelled evaluation is free and its hold is released.

POST /api/v1/evaluations/{id}/cancel

Cancel an evaluation

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/evaluations/{id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "status": "queued",
  "cancelRequestedAt": "<string>"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Response

200

application/json

The cancelled evaluation.

id · string · required

status · enum<string> · required

Available options: queued, dispatching, dispatch_unknown, running, cancelling, succeeded, partial, failed, cancelled

cancelRequestedAt · string | null · required