Skip to main content
GET
/
v1
/
workers
/
environments
/
{envId}
Get a worker session
curl --request GET \
  --url https://api.agentmark.co/v1/workers/environments/{envId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Agentmark-App-Id: <api-key>'
import requests

url = "https://api.agentmark.co/v1/workers/environments/{envId}"

headers = {
"X-Agentmark-App-Id": "<api-key>",
"Authorization": "Bearer <token>"
}

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

print(response.text)
const options = {
method: 'GET',
headers: {'X-Agentmark-App-Id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.agentmark.co/v1/workers/environments/{envId}', 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.agentmark.co/v1/workers/environments/{envId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Agentmark-App-Id: <api-key>"
],
]);

$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.agentmark.co/v1/workers/environments/{envId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-Agentmark-App-Id", "<api-key>")
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.get("https://api.agentmark.co/v1/workers/environments/{envId}")
.header("X-Agentmark-App-Id", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.agentmark.co/v1/workers/environments/{envId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Agentmark-App-Id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "environment": {
      "agent": "<string>",
      "base_branch": "<string>",
      "created_at": "<string>",
      "current_run_id": "<string>",
      "id": "<string>",
      "last_active_at": "<string>",
      "status": "<string>",
      "substrate": "<string>",
      "work_branch": "<string>"
    },
    "turns": [
      {
        "created_at": "<string>",
        "id": "<string>",
        "outcome": "<string>",
        "pr_url": "<string>",
        "status": "<string>",
        "task_prompt": "<string>",
        "turn_index": 123
      }
    ],
    "url": "<string>"
  }
}
{
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>"
}
}

Authorizations

X-Agentmark-App-Id
string
header
required

Application ID for tenant scoping. X-Outerlayer-App-Id is accepted as an equivalent header.

Authorization
string
header
required

API key (sk_agentmark_*)

Path Parameters

envId
string<uuid>
required

Response

The session.

data
object
required