Skip to main content
GET
/
api
/
v2
/
environments
/
{id}
Retrieve an environment
curl --request GET \
  --url https://agp.eu.hcompany.ai/api/v2/environments/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://agp.eu.hcompany.ai/api/v2/environments/{id}"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://agp.eu.hcompany.ai/api/v2/environments/{id}', 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://agp.eu.hcompany.ai/api/v2/environments/{id}",
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>"
],
]);

$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://agp.eu.hcompany.ai/api/v2/environments/{id}"

req, _ := http.NewRequest("GET", 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.get("https://agp.eu.hcompany.ai/api/v2/environments/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://agp.eu.hcompany.ai/api/v2/environments/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
Retrieves the complete Environment object. Returns the Environment object if the identifier is valid and you have access.

Path parameters

id
string
required
The environment’s id (e.g., h/browser or my-browser). Slash-containing identifiers are supported.

Examples

curl "https://agp.eu.hcompany.ai/api/v2/environments/h/browser" \
  -H "Authorization: Bearer $HAI_API_KEY"
from hai_agents import Client

client = Client()

environment = client.environments.get_environment("h/browser")
print(environment)
import { HaiAgentsClient } from "hai-agents";

const client = new HaiAgentsClient();

const environment = await client.environments.getEnvironment({ id: "h/browser" });
console.log(environment);
Response
{
  "id": "h/browser",
  "kind": "web",
  "start_url": "https://www.bing.com",
  "mode": {"type": "visual", "width": 1200, "height": 1200, "markdown": false},
  "vault_id": null
}

Errors

StatusCause
404Environment not found or you don’t have access.