Cancel a setup run

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

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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

{
  "created_at": "2023-11-07T05:31:56Z",
  "environment_id": "<string>",
  "kind": "<string>",
  "organization_id": "<string>",
  "setup_run_id": "<string>",
  "status": "<string>",
  "compute_id": "<string>",
  "compute_profile": {},
  "duration_ms": 0,
  "exit_code": 0,
  "failed_command": "<string>",
  "failed_line": 0,
  "failure_code": "<string>",
  "fingerprint": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "gpu_readiness": {},
  "hint": "<string>",
  "hint_code": "<string>",
  "image": "<string>",
  "imageCapture": {
    "at": "2023-11-07T05:31:56Z",
    "setupRunId": "<string>",
    "status": "failed",
    "message": "<string>",
    "reason": "<string>"
  },
  "imageId": "<string>",
  "log_bytes": 0,
  "log_lines": 0,
  "log_truncated": true,
  "message": "<string>",
  "next_action": {
    "method": "<string>",
    "operation_id": "managedAgentsGetEnvironmentSetupRunLog",
    "path": "<string>"
  },
  "phase": "<string>",
  "providerRunId": "<string>",
  "requested_by_user_id": "<string>",
  "session_id": "<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>"
  },
  "started_at": "2023-11-07T05:31:56Z",
  "stderr_tail": "<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/v1/environments/{environmentId}/setup-runs/{setupRunId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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

{
  "created_at": "2023-11-07T05:31:56Z",
  "environment_id": "<string>",
  "kind": "<string>",
  "organization_id": "<string>",
  "setup_run_id": "<string>",
  "status": "<string>",
  "compute_id": "<string>",
  "compute_profile": {},
  "duration_ms": 0,
  "exit_code": 0,
  "failed_command": "<string>",
  "failed_line": 0,
  "failure_code": "<string>",
  "fingerprint": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "gpu_readiness": {},
  "hint": "<string>",
  "hint_code": "<string>",
  "image": "<string>",
  "imageCapture": {
    "at": "2023-11-07T05:31:56Z",
    "setupRunId": "<string>",
    "status": "failed",
    "message": "<string>",
    "reason": "<string>"
  },
  "imageId": "<string>",
  "log_bytes": 0,
  "log_lines": 0,
  "log_truncated": true,
  "message": "<string>",
  "next_action": {
    "method": "<string>",
    "operation_id": "managedAgentsGetEnvironmentSetupRunLog",
    "path": "<string>"
  },
  "phase": "<string>",
  "providerRunId": "<string>",
  "requested_by_user_id": "<string>",
  "session_id": "<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>"
  },
  "started_at": "2023-11-07T05:31:56Z",
  "stderr_tail": "<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

One execution of an environment's setup script on fresh compute: provision, GPU check, script, profile, image capture, cleanup. Read status until terminal, then hint, failed_line, and stderr_tail; the full log is a separate call.

created_at

string<date-time>

required

When the run was requested.

environment_id

string

required

Environment whose setup ran.

kind

string

required

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

organization_id

string

required

Organization that owns the environment.

setup_run_id

string

required

Server-assigned id of the run.

status

string

required

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

compute_id

string

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

compute_profile

object

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

Show child attributes

duration_ms

integer<int64>

Wall-clock duration in milliseconds, provisioning included.

Required range: -9007199254740991 <= x <= 9007199254740991

exit_code

integer

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

Required range: -9007199254740991 <= x <= 9007199254740991

failed_command

string

The failing line's command as written, unexpanded.

failed_line

integer<int64>

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

Required range: -9007199254740991 <= x <= 9007199254740991

failure_code

string

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

Hash of the environment configuration the run executed.

finished_at

string<date-time>

When the run reached a terminal status.

gpu_readiness

object

GPU readiness report for accelerator environments.

Show child attributes

hint

string

Likely fix when the failure cause is recognised.

hint_code

string

Stable identifier of the recognised failure cause.

image

string

Runner image the compute booted.

imageCapture

object

Capture failure recorded without changing the setup script verdict.

Show child attributes

imageId

string

Agent Service image id being captured.

log_bytes

integer<int64>

Bytes of log persisted for the run.

Required range: -9007199254740991 <= x <= 9007199254740991

log_lines

integer<int64>

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

log_truncated

boolean

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

message

string

One-sentence description of the outcome.

next_action

object

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

Show child attributes

phase

string

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

providerRunId

string

Durable Agent Service run id executing the setup script.

requested_by_user_id

string

User who requested a manual run.

session_id

string

Session the run provisioned, for kind session.

setupImage

object

Immutable image published by this run when capture succeeded.

Show child attributes

started_at

string<date-time>

When provisioning began.

stderr_tail

string

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

API reference

Endpoints

Cancel a setup run

Authorizations

Headers

Path Parameters

Response