Cancel a setup run

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel"

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

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/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.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel"

	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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel")

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "environmentId": "<string>",
  "kind": "<string>",
  "organizationId": "<string>",
  "setupRunId": "<string>",
  "status": "<string>",
  "computeId": "<string>",
  "computeProfile": {},
  "durationMs": 0,
  "exitCode": 0,
  "failedCommand": "<string>",
  "failedLine": 0,
  "failureCode": "<string>",
  "fingerprint": "<string>",
  "finishedAt": "2023-11-07T05:31:56Z",
  "gpuReadiness": {},
  "hint": "<string>",
  "hintCode": "<string>",
  "image": "<string>",
  "imageCapture": {
    "at": "2023-11-07T05:31:56Z",
    "setupRunId": "<string>",
    "status": "failed",
    "message": "<string>",
    "reason": "<string>"
  },
  "imageId": "<string>",
  "logBytes": 0,
  "logLines": 0,
  "logTruncated": true,
  "message": "<string>",
  "nextAction": {
    "method": "<string>",
    "operationId": "managedAgentsGetEnvironmentSetupRunLogV2",
    "path": "<string>"
  },
  "phase": "<string>",
  "providerRunId": "<string>",
  "requestedByUserId": "<string>",
  "sessionId": "<string>",
  "setupImage": {
    "baseImageDigest": "<string>",
    "capturedAt": "2023-11-07T05:31:56Z",
    "computeId": "<string>",
    "fingerprint": "<string>",
    "generation": 0,
    "image": "<string>",
    "imageId": "<string>",
    "runnerImage": "<string>",
    "setupRunId": "<string>",
    "sizeBytes": 0,
    "usable": true,
    "warmup": "<string>",
    "warmupMessage": "<string>"
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "stderrTail": "<string>"
}

{
  "code": "invalid_request",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "setup_run_finished",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "managed_agents_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Environments

Cancel a setup run

Stops a queued or in-flight manual or automatic runner_refresh setup run and releases its compute. Sessions waiting on a cancelled runner_refresh fail with that run as their cause. The cancelled run is returned with status cancelled and active_setup_run_id is cleared. A cancelled run proves nothing: a standing verified or failed verdict is kept as it was, and an environment whose only verdict was running reverts to never. 409 when the run had already finished.

POST

managed-agents

environments

{environmentId}

setup-runs

{setupRunId}

cancel

Cancel a setup run

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel"

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

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/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.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel"

	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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v2/environments/{environmentId}/setup-runs/{setupRunId}/cancel")

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "environmentId": "<string>",
  "kind": "<string>",
  "organizationId": "<string>",
  "setupRunId": "<string>",
  "status": "<string>",
  "computeId": "<string>",
  "computeProfile": {},
  "durationMs": 0,
  "exitCode": 0,
  "failedCommand": "<string>",
  "failedLine": 0,
  "failureCode": "<string>",
  "fingerprint": "<string>",
  "finishedAt": "2023-11-07T05:31:56Z",
  "gpuReadiness": {},
  "hint": "<string>",
  "hintCode": "<string>",
  "image": "<string>",
  "imageCapture": {
    "at": "2023-11-07T05:31:56Z",
    "setupRunId": "<string>",
    "status": "failed",
    "message": "<string>",
    "reason": "<string>"
  },
  "imageId": "<string>",
  "logBytes": 0,
  "logLines": 0,
  "logTruncated": true,
  "message": "<string>",
  "nextAction": {
    "method": "<string>",
    "operationId": "managedAgentsGetEnvironmentSetupRunLogV2",
    "path": "<string>"
  },
  "phase": "<string>",
  "providerRunId": "<string>",
  "requestedByUserId": "<string>",
  "sessionId": "<string>",
  "setupImage": {
    "baseImageDigest": "<string>",
    "capturedAt": "2023-11-07T05:31:56Z",
    "computeId": "<string>",
    "fingerprint": "<string>",
    "generation": 0,
    "image": "<string>",
    "imageId": "<string>",
    "runnerImage": "<string>",
    "setupRunId": "<string>",
    "sizeBytes": 0,
    "usable": true,
    "warmup": "<string>",
    "warmupMessage": "<string>"
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "stderrTail": "<string>"
}

{
  "code": "invalid_request",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "setup_run_finished",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "managed_agents_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id

string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1

x-organization-id

string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

environmentId

string<uuid>

required

Environment id (UUID).

setupRunId

string<uuid>

required

Setup run id as returned by managedAgentsCreateEnvironmentSetupRun or the environment's setup_verification.active_setup_run_id.

Response

createdAt

string<date-time>

required

read-only

When the run was requested.

environmentId

string

required

read-only

Environment whose setup ran.

kind

string

required

read-only

manual (requested through the API), runner_refresh (automatically captures an image for the current runner), or session (legacy in-session setup).

organizationId

string

required

read-only

Organization that owns the environment.

setupRunId

string

required

read-only

Server-assigned id of the run.

status

string

required

read-only

queued, provisioning, running, succeeded, failed, or cancelled. Poll until one of the last three; managedAgentsGetEnvironmentSetupRunV2 accepts waitSeconds to do that server-side.

computeId

string

read-only

Provider id of the compute the run used. Released when the run ends.

computeProfile

object

read-only

What the compute turned out to be: vCPUs, memory, GPUs, Docker state, image tools. Recorded after setup passed.

Show child attributes

durationMs

integer<int64>

read-only

Wall-clock duration in milliseconds, provisioning included.

Required range: -9007199254740991 <= x <= 9007199254740991

exitCode

integer

read-only

Exit code of the setup script when it ran. 124 means the timeout elapsed.

Required range: -9007199254740991 <= x <= 9007199254740991

failedCommand

string

read-only

The failing line's command as written, unexpanded.

failedLine

integer<int64>

read-only

1-based line in the setup script whose command exited non-zero. 0 when unknown.

Required range: -9007199254740991 <= x <= 9007199254740991

failureCode

string

read-only

Machine-readable failure class when the run did not succeed: environment_setup_failed, sandbox_capacity_unavailable, sandbox_gpu_not_ready, sandbox_provision_timeout, and so on. Same vocabulary as session failures.

fingerprint

string

read-only

Hash of the environment configuration the run executed.

finishedAt

string<date-time>

read-only

When the run reached a terminal status.

gpuReadiness

object

read-only

GPU readiness report for accelerator environments.

Show child attributes

hint

string

read-only

Likely fix when the failure cause is recognised.

hintCode

string

read-only

Stable identifier of the recognised failure cause.

image

string

read-only

Runner image the compute booted.

imageCapture

object

read-only

Capture failure recorded without changing the setup script verdict.

Show child attributes

imageId

string

read-only

Agent Service image id being captured.

logBytes

integer<int64>

read-only

Bytes of log persisted for the run.

Required range: -9007199254740991 <= x <= 9007199254740991

logLines

integer<int64>

read-only

Lines of log persisted for the run. The last line's seq equals this; pass it as after to tail.

Required range: -9007199254740991 <= x <= 9007199254740991

logTruncated

boolean

read-only

True when the script produced more output than the run keeps (4 MiB); the head and the stderr tail are retained.

message

string

read-only

One-sentence description of the outcome.

nextAction

object

read-only

The call that acts on this result: re-run setup after fixing the script, or fetch the log.

Show child attributes

phase

string

read-only

Current or final phase: provision, gpu_check, setup, profile, commit, cleanup.

providerRunId

string

read-only

Durable Agent Service run id executing the setup script.

requestedByUserId

string

read-only

User who requested a manual run.

sessionId

string

read-only

Session the run provisioned, for kind session.

setupImage

object

read-only

Immutable image published by this run when capture succeeded.

Show child attributes

startedAt

string<date-time>

read-only

When provisioning began.

stderrTail

string

read-only

Last lines of stderr, redacted and bounded to 2 KiB.

API reference

Endpoints

Cancel a setup run

Authorizations

Headers

Path Parameters

Response