Cancel Job
curl --request POST \
--url https://api.voyager.so/v1/machines/jobs/{job}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voyager.so/v1/machines/jobs/{job}/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.voyager.so/v1/machines/jobs/{job}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"machine_id": "<string>",
"status": "running",
"exit_code": 123,
"output_tail": "<string>",
"started_at": "<string>",
"ended_at": "<string>",
"next": "<string>",
"resumed": false
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Cancel Job
Stop a running job (SIGTERM, then SIGKILL after 10 s).
POST
/
machines
/
jobs
/
{job}
/
cancel
Cancel Job
curl --request POST \
--url https://api.voyager.so/v1/machines/jobs/{job}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voyager.so/v1/machines/jobs/{job}/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.voyager.so/v1/machines/jobs/{job}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"machine_id": "<string>",
"status": "running",
"exit_code": 123,
"output_tail": "<string>",
"started_at": "<string>",
"ended_at": "<string>",
"next": "<string>",
"resumed": false
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Authorizations
API key from Settings > Developer > REST API
Path Parameters
Response
Successful Response
The job id (mjb_…).
The machine id (mch_…).
The state (see the enum).
Available options:
running, succeeded, failed, canceled The command's exit code, once it has ended.
The last few KB of output (stdout and stderr together).
When the job started running (ISO 8601); null while queued.
When it ended.
What to do next, for agents.
True when the machine was paused and resumed for this run.